Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / FpSpread Class / GetViewportPreferredHeight Method / GetViewportPreferredHeight(Int32,Int32) Method
Sheet index
Viewport row index
Example


In This Topic
    GetViewportPreferredHeight(Int32,Int32) Method
    In This Topic
    Gets the maximum height of the viewport row for the specified sheet.
    Syntax
    'Declaration
     
    Public Overloads Function GetViewportPreferredHeight( _
       ByVal sheetIndex As Integer, _
       ByVal rowViewportIndex As Integer _
    ) As Integer
    'Usage
     
    Dim instance As FpSpread
    Dim sheetIndex As Integer
    Dim rowViewportIndex As Integer
    Dim value As Integer
     
    value = instance.GetViewportPreferredHeight(sheetIndex, rowViewportIndex)
    public int GetViewportPreferredHeight( 
       int sheetIndex,
       int rowViewportIndex
    )

    Parameters

    sheetIndex
    Sheet index
    rowViewportIndex
    Viewport row index

    Return Value

    Integer number of pixels in the height of the specified viewport
    Exceptions
    ExceptionDescription
    Specified sheet index is out of range; must be between 0 and the total number of sheets
    Remarks

    The sheet index is zero-based, so the first sheet has an index of 0.

    The viewport row index is zero-based, so the first (top) viewport row has an index of 0.

    Example
    fpSpread1.Sheets.Count = 3;
    fpSpread1.AddViewport(1, 0, 0);
    
    int i;
    fpSpread1.SetViewportPreferredHeight(1, 1, 20);
    i = fpSpread1.GetViewportPreferredHeight(1, 1);
    textBox1.Text = i.ToString();
    
    FpSpread1.Sheets.Count = 3
    FpSpread1.AddViewport(1, 0, 0)
    
    Dim i As Integer
    FpSpread1.SetViewportPreferredHeight(1, 1, 20)
    i = FpSpread1.GetViewportPreferredHeight(1, 1)
    TextBox1.Text = i.ToString()
    
    See Also