GetClipValue Method (SheetView)

Visual Basic
C#

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

'Usage
 
Dim instance As SheetView
Dim row As Integer
Dim column As Integer
Dim rowCount As Integer
Dim columnCount As Integer
Dim value As String
 
value = instance.GetClipValue(row, column, rowCount, columnCount)

public string GetClipValue( 
   int row,
   int column,
   int rowCount,
   int columnCount
)

Parameters

row: Starting row index, or -1 for all rows
column: Starting column index, or -1 for all columns
rowCount: Number of rows, or -1 for all rows
columnCount: Number of columns, or -1 for all columns

Return Value

Tab-delimited string containing the unformatted data in the range

Exception	Description
System.ArgumentOutOfRangeException	Specified row is out of range; index must be between -1 (for all) and the number of rows
System.ArgumentOutOfRangeException	Specified column is out of range; index must be between -1 (for all) and the number of columns

Compare the values returned from calling this method with the values returned from calling the GetClip method. For example, for date-time cells, the GetClip method returns the formatted date and time value. The GetClipValue method returns a DateTime object for the date and time.

The data in the range of cells is converted using the ToString method.

Besides using this method, you can get or set the data in a cell using various properties of the sheet (SheetView object) or properties of the cell (Cell object). For more information, see Handling Data Using Sheet Methods and Handling Data Using Cell Properties.

Remember that the data may be displayed differently in a cell depending on the cell type. For more information, see Understanding Cell Type Effects on Displaying Data.

This example gets a tab-delimited string containing the unformatted text in a range.

C#

FarPoint.Web.Spread.SheetView sv;
sv = FpSpread1.ActiveSheetView;
sv.SetClipValue(0, 0, 2, 4, "one\ttwo\tthree\tfour\r\nfive\tsix\tseven\teight"); 
string s;
s = sv.GetClipValue(0, 0, 2, 4);
Response.Write(s);

Visual Basic

Dim sv As FarPoint.Web.Spread.SheetView
sv = FpSpread1.ActiveSheetView
sv.SetClipValue(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 = sv.GetClipValue(0, 0, 2, 4)
Response.Write(s)

Reference

SheetView Class
SheetView Members
GetClip Method
SetClip Method
SetClipValue Method

User-Task Documentation

Handling Data Using Sheet Methods
Handling Data Using Cell Properties
Understanding Cell Type Effects on Displaying Data