GetClip Method (ColumnHeader)

Visual Basic
C#

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

'Usage
 
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.GetClip(row, column, rowCount, columnCount)

public string GetClip( 
   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 formatted data in the range

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

This example sets and returns a tab-delimited string containing the formatted text from the column headers.

C#

FpSpread1.ActiveSheetView.ColumnHeader.RowCount = 4;
FpSpread1.ActiveSheetView.ColumnHeader.SetClip(0, 0, 2, 4, "one\ttwo\tthree\tfour\r\nfive\tsix\tseven\teight"); 
string s;
s = FpSpread1.ActiveSheetView.ColumnHeader.GetClip(0, 0, 2, 4);
ListBox1.Items.Add(s);

Visual Basic

FpSpread1.ActiveSheetView.ColumnHeader.RowCount = 4
FpSpread1.ActiveSheetView.ColumnHeader.SetClip(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.ActiveSheetView.ColumnHeader.GetClip(0, 0, 2, 4)
ListBox1.Items.Add(s)

Reference

ColumnHeader Class
ColumnHeader Members
GetClipValue Method
SetClip Method