Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / FpSpread Class / GetViewportRectangle Method
Viewport row index
Viewport column index
Example


In This Topic
    GetViewportRectangle Method (FpSpread)
    In This Topic
    Gets the rectangle of the viewport.
    Syntax
    'Declaration
     
    Public Function GetViewportRectangle( _
       ByVal rowViewportIndex As Integer, _
       ByVal columnViewportIndex As Integer _
    ) As Rectangle
    'Usage
     
    Dim instance As FpSpread
    Dim rowViewportIndex As Integer
    Dim columnViewportIndex As Integer
    Dim value As Rectangle
     
    value = instance.GetViewportRectangle(rowViewportIndex, columnViewportIndex)
    public Rectangle GetViewportRectangle( 
       int rowViewportIndex,
       int columnViewportIndex
    )

    Parameters

    rowViewportIndex
    Viewport row index
    columnViewportIndex
    Viewport column index

    Return Value

    Rectangleobject containing the x-, and y-coordinates, and the height, and width of the viewport rectangle
    Remarks

    This method allows you to retrieve bounding coordinates for a specific viewport on the active sheet. This exposes at the component level the four methods in the SpreadView class:

    The viewport column and viewport row indexes are zero-based, so the first (leftmost) viewport column and first (top) viewport row both have indexes of 0.

    Example
    This example returns the top of the viewport rectangle.
    Rectangle r;
    r = fpSpread1.GetViewportRectangle(0, 0);
    Debug.WriteLine(r.Top.ToString());
    
    Dim r As Rectangle
    r = FpSpread1.GetViewportRectangle(0, 0)
    Debug.WriteLine(r.Top.ToString)
    See Also