Spread ASP.NET 14
FarPoint.Web.Spread Assembly / FarPoint.Web.Spread Namespace / SheetView Class / GetClip Method / GetClip(Int32,Int32,Int32,Int32,Boolean) 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
Specifies data in the clip is unformatted
Example


In This Topic
    GetClip(Int32,Int32,Int32,Int32,Boolean) Method
    In This Topic
    Gets a tab-delimited string that contains the formatted text in a specified range.
    Syntax
    'Declaration
     
    Public Overloads Function GetClip( _
       ByVal row As Integer, _
       ByVal column As Integer, _
       ByVal rowCount As Integer, _
       ByVal columnCount As Integer, _
       ByVal unformatted As Boolean _
    ) As String
    'Usage
     
    Dim instance As SheetView
    Dim row As Integer
    Dim column As Integer
    Dim rowCount As Integer
    Dim columnCount As Integer
    Dim unformatted As Boolean
    Dim value As String
     
    value = instance.GetClip(row, column, rowCount, columnCount, unformatted)
    public string GetClip( 
       int row,
       int column,
       int rowCount,
       int columnCount,
       bool unformatted
    )

    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
    unformatted
    Specifies data in the clip is unformatted

    Return Value

    Tab-delimited string containing the formatted 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
    Example
    This example uses the GetClip method.
    FarPoint.Web.Spread.SheetView sv;
    sv = FpSpread1.ActiveSheetView;
    sv.SetClip(0, 0, 2, 4, "one\ttwo\tthree\tfour\r\nfive\tsix\tseven\teight");
    string s;
    s = sv.GetClip(0, 0, 2, 4, false);
    Dim sv As FarPoint.Web.Spread.SheetView
    sv = FpSpread1.ActiveSheetView
    sv.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 = sv.GetClip(0, 0, 2, 4, False)
    See Also