Spread ASP.NET 14
FarPoint.Web.Spread Assembly / FarPoint.Web.Spread Namespace / SheetView Class / GetClipValue Method
Starting row index, or -1 for all rows
Starting column index, or -1 for all columns
Number of rows, or -1 for all rows
Number of columns, or -1 for all columns
Example


In This Topic
    GetClipValue Method (SheetView)
    In This Topic
    Gets a tab-delimited string that contains the unformatted text in a specified range.
    Syntax
    '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
    Exceptions
    ExceptionDescription
    Specified row is out of range; index must be between -1 (for all) and the number of rows
    Specified column is out of range; index must be between -1 (for all) and the number of columns
    Remarks

    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.

    Example
    This example gets a tab-delimited string containing the unformatted text in a range.
    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);
    
    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)
    
    See Also