FarPoint.Win.Spread
GetClipValue Method
See Also  Example
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > ColumnHeader Class : GetClipValue Method


row
Starting column header row index, or -1 for all column header rows
column
Starting column index, or -1 for all columns
rowCount
Number of column header rows, or -1 for all column header rows
columnCount
Number of columns, or -1 for all columns
Gets a tab-delimited string containing the unformatted text in a range.

Syntax

Visual Basic (Declaration) 
Public Function GetClipValue( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer _
) As String
Visual Basic (Usage)Copy Code
Dim instance As ColumnHeader
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)
C# 
public string GetClipValue( 
   int row,
   int column,
   int rowCount,
   int columnCount
)

Parameters

row
Starting column header row index, or -1 for all column header rows
column
Starting column index, or -1 for all columns
rowCount
Number of column header rows, or -1 for all column header rows
columnCount
Number of columns, or -1 for all columns

Return Value

Tab-delimited String containing the unformatted data in the range

Exceptions

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

Example

This example sets and returns a tab-delimited string containing the unformatted text from the column headers.
C#Copy Code
fpSpread1.ActiveSheet.ColumnHeader.RowCount = 4;

fpSpread1.ActiveSheet.ColumnHeader.SetClipValue(0, 0, 2, 4, "one\ttwo\tthree\tfour\r\nfive\tsix\tseven\teight");

 string s;

s = fpSpread1.ActiveSheet.ColumnHeader.GetClipValue(0, 0, 2, 4);
listBox1.Items.Add(s);
Visual BasicCopy Code
FpSpread1.ActiveSheet.ColumnHeader.RowCount = 4
FpSpread1.ActiveSheet.ColumnHeader.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.ColumnHeader.GetClipValue(0, 0, 2, 4)
ListBox1.Items.Add(s)

See Also