Spread ASP.NET 6.0 Product Documentation
GetClip Method
See Also  Example Send Feedback
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > ColumnHeader Class : GetClip 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

Glossary Item Box

Gets a tab-delimited string containing the formatted text in a range.

Syntax

Visual Basic (Declaration) 
Public Function GetClip( _
   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.GetClip(row, column, rowCount, columnCount)
C# 
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

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 sets and returns a tab-delimited string containing the formatted text from the column headers.
C#Copy Code
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 BasicCopy Code
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)

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2002-2012 GrapeCity, Inc. All Rights Reserved.