Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / SheetView Class / GetClipValue Method
Starting row index of the range of cells (or -1 for all rows)
Starting column index of the range of cells (or -1 for all columns)
Number of rows in the range (or -1 for all rows)
Number of columns in the range (or -1 for all columns)
Example


In This Topic
    GetClipValue Method (SheetView)
    In This Topic
    Gets a tab-delimited string that contains the unformatted data in a range of cells on this sheet.
    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 of the range of cells (or -1 for all rows)
    column
    Starting column index of the range of cells (or -1 for all columns)
    rowCount
    Number of rows in the range (or -1 for all rows)
    columnCount
    Number of columns in the range (or -1 for all columns)

    Return Value

    Tab-delimited String containing the unformatted data in the range
    Exceptions
    ExceptionDescription
    Specified row index is out of range; must be between 0 and the total number of rows
    Specified column index is out of range; must be between 0 and the total number of columns
    Remarks

    The data in the range is formatted using the ToString method.

    Use -1 to for row or column to specify all the rows or columns.

    This method may create new rows as needed if the row count or column count exceed the existing count.

    Besides using this method, you can get or set the value 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 illustrates the use of this member by returning a tab-delimited string containing the unformatted text in a range.
    fpSpread1.ActiveSheet.SetClipValue(0, 0, 2, 4, "one\ttwo\tthree\tfour\r\nfive\tsix\tseven\teight"); 
    string s;
    s = fpSpread1.ActiveSheet.GetClipValue(0, 0, 2, 4);
    listBox1.Items.Add(s);
    FpSpread1.ActiveSheet.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 = FpSpread1.ActiveSheet.GetClipValue(0, 0, 2, 4)
    ListBox1.Items.Add(s)
    See Also