Spread for ASP.NET 7.0 Product Documentation
SetClip Method
See Also  Example Support Options
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > ColumnHeader Class : SetClip 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 (may create new column header rows as needed)
columnCount
Number of columns, or -1 for all columns
value
Tab-delimited string to set into the range

Glossary Item Box

Sets a tab-delimited string that contains the formatted text in a range.

Syntax

Visual Basic (Declaration) 
Public Sub SetClip( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer, _
   ByVal value 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
 
instance.SetClip(row, column, rowCount, columnCount, value)
C# 
public void SetClip( 
   int row,
   int column,
   int rowCount,
   int columnCount,
   string value
)

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 (may create new column header rows as needed)
columnCount
Number of columns, or -1 for all columns
value
Tab-delimited string to set into 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 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

See Also

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