Spread Windows Forms 7.0 Product Documentation
SetClipValue Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > SheetView Class : SetClipValue Method


row
Starting row index or -1 for all rows
column
Starting column index or -1 for all columns
rowCount
Number of rows or -1 for all rows
columnCount
Number of columns or -1 for all columns
value
Tab-delimited string (data only) to set into the specified range of cells

Glossary Item Box

Sets a tab-delimited string of unformatted data in a specified range of cells on this sheet.

Syntax

Visual Basic (Declaration) 
Public Sub SetClipValue( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer, _
   ByVal value As String _
)
Visual Basic (Usage)Copy Code
Dim instance As SheetView
Dim row As Integer
Dim column As Integer
Dim rowCount As Integer
Dim columnCount As Integer
Dim value As String
 
instance.SetClipValue(row, column, rowCount, columnCount, value)
C# 
public void SetClipValue( 
   int row,
   int column,
   int rowCount,
   int columnCount,
   string value
)

Parameters

row
Starting row index or -1 for all rows
column
Starting column index or -1 for all columns
rowCount
Number of rows or -1 for all rows
columnCount
Number of columns or -1 for all columns
value
Tab-delimited string (data only) to set into the specified range of cells

Exceptions

ExceptionDescription
System.ArgumentOutOfRangeException Specified row index is out of range; must be between 0 and the total number of rows
System.ArgumentOutOfRangeException Specified column index is out of range; must be between 0 and the total number of columns

Remarks

The data is put directly into the data model without being parsed.

Besides using this method, you can get or set the value in a cell using various properties of the sheet (SheetView object) or properties of the cell (Cell object). For more information, see Handling Data Using Sheet Methods and Handling Data Using Cell Properties.

Remember that the data may be displayed differently in a cell depending on the cell type. For more information, see Understanding Cell Type Effects on Displaying Data.

Example

This example illustrates the use of this member by returning a tab-delimited string containing the unformatted text in a range.
C#Copy Code
fpSpread1.ActiveSheet.SetClipValue(0, 0, 2, 4, "one\ttwo\tthree\tfour\r\nfive\tsix\tseven\teight"); 
string s;
s = fpSpread1.ActiveSheet.GetClipValue(0, 0, 2, 4);
listBox1.Items.Add(s);
Visual BasicCopy Code
FpSpread1.ActiveSheet.SetClipValue(0, 0, 2, 4, "one" + Chr(9) + "two" + Chr(9) + "three" + Chr(9) + "four" + vbCrLf + "five"
+ Chr(9) + "six" + Chr(9) + "seven" + Chr(9) + "eight")
Dim s As String
s = FpSpread1.ActiveSheet.GetClipValue(0, 0, 2, 4)
ListBox1.Items.Add(s)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.