Spread for ASP.NET 7.0 Product Documentation
SetClipValue Method
See Also  Example Support Options
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > RowHeader Class : SetClipValue Method


row
Starting row index, or -1 for all rows
column
Starting row header column index, or -1 for all row header columns
rowCount
Number of rows, or -1 for all rows
columnCount
Number of row header columns, or -1 for all row header columns (may create new row header columns as needed)
value
Tab-delimited string to set into the range

Glossary Item Box

Sets a tab-delimited string that contains the unformatted text to a range.

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 RowHeader
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 row header column index, or -1 for all row header columns
rowCount
Number of rows, or -1 for all rows
columnCount
Number of row header columns, or -1 for all row header columns (may create new row header columns as needed)
value
Tab-delimited string to set into the range

Exceptions

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

Example

This example gets a tab-delimited string containing the unformatted text from the row headers.
C#Copy Code
FarPoint.Web.Spread.RowHeader r;
string s;
r = FpSpread1.ActiveSheetView.RowHeader;
r.ColumnCount = 6;
r.SetClip(0, 0, 2, 4, "1\t2\t3\t4\r\n5\t6\t7\t8"); 
s = r.GetClipValue(0, 0, 2, 4);
ListBox1.Items.Add(s);
Visual BasicCopy Code
Dim r As FarPoint.Web.Spread.RowHeader
Dim s As String
r = FpSpread1.ActiveSheetView.RowHeader
r.ColumnCount = 6
r.SetClip(0, 0, 2, 4, "1" + Chr(9) + "2" + Chr(9) + "3" + Chr(9) + "4" + vbCrLf + "5" + Chr(9) + "6" + Chr(9) + "7" + Chr(9)+
"8")
s = r.GetClipValue(0, 0, 2, 4)
ListBox1.Items.Add(s)

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

See Also

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