Spread Windows Forms 6.0 Product Documentation
GetClip Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > RowHeader Class : GetClip Method


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

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 RowHeader
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 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 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 row header style model.

Example

This example gets a tab-delimited string containing the formatted text from the row headers.
Visual BasicCopy Code
Dim r As FarPoint.Win.Spread.RowHeader
Dim s As String
r = FpSpread1.ActiveSheet.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.GetClip(0, 0, 2, 4)
ListBox1.Items.Add(s)
C#Copy Code
FarPoint.Win.Spread.RowHeader r;
string s;
r = fpSpread1.ActiveSheet.RowHeader;
r.ColumnCount = 6; 
r.SetClip(0, 0, 2, 4, "1\t2\t3\t4\r\n5\t6\t7\t8"); 
s = r.GetClip(0, 0, 2, 4);
listBox1.Items.Add(s);

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

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