GetClipValue Method (RowHeader)

Gets a tab-delimited string that contains the unformatted text in a range.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetClipValue( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer _
) As String

'Usage
 
Dim instance As RowHeader
Dim row As Integer
Dim column As Integer
Dim rowCount As Integer
Dim columnCount As Integer
Dim value As String
 
value = instance.GetClipValue(row, column, rowCount, columnCount)

public string GetClipValue( 
   int row,
   int column,
   int rowCount,
   int columnCount
)

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

Return Value

Tab-delimited string containing the unformatted data in the range

Exceptions

Exception	Description
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.

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 Basic

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

Reference

RowHeader Class
RowHeader Members
SetClipValue Method
GetClip Method