Spread Windows Forms 7.0 Product Documentation
GetClip Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.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 that contains 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

Remarks

The data in the range is formatted using the composite style for the cell in the column header style model.

Example

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

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

string s;

s = fpSpread1.ActiveSheet.ColumnHeader.GetClip(0, 0, 2, 4);

listBox1.Items.Add(s);
Visual BasicCopy Code
FpSpread1.ActiveSheet.ColumnHeader.RowCount = 4

FpSpread1.ActiveSheet.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.ActiveSheet.ColumnHeader.GetClip(0, 0, 2, 4)

ListBox1.Items.Add(s)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

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