Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / SpreadView Class / GetViewportPreferredWidth Method / GetViewportPreferredWidth(Int32,Int32) Method
Sheet index
Viewport column index
Example


In This Topic
    GetViewportPreferredWidth(Int32,Int32) Method
    In This Topic
    Gets the maximum width for the viewport column for the specified sheet.
    Syntax
    'Declaration
     
    Public Overloads Function GetViewportPreferredWidth( _
       ByVal sheetIndex As Integer, _
       ByVal columnViewportIndex As Integer _
    ) As Integer
    'Usage
     
    Dim instance As SpreadView
    Dim sheetIndex As Integer
    Dim columnViewportIndex As Integer
    Dim value As Integer
     
    value = instance.GetViewportPreferredWidth(sheetIndex, columnViewportIndex)
    public int GetViewportPreferredWidth( 
       int sheetIndex,
       int columnViewportIndex
    )

    Parameters

    sheetIndex
    Sheet index
    columnViewportIndex
    Viewport column index

    Return Value

    Integer number of pixels in the width of the viewport column
    Exceptions
    ExceptionDescription
    Specified sheet index is not valid; must be between 0 and total number of sheets.
    Remarks

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

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

    Example
    FarPoint.Win.Spread.SpreadView sv = fpSpread1.GetRootWorkbook();
    sv.AddViewport(0, 0);
    sv.SetViewportPreferredWidth(0, 80);
    MessageBox.Show("The preferred width of the viewport is " + sv.GetViewportPreferredWidth(0, 0).ToString());
    
    Dim sv As FarPoint.Win.Spread.SpreadView = FpSpread1.GetRootWorkbook
    sv.AddViewport(0, 0)
    sv.SetViewportPreferredWidth(0, 80)
    MessageBox.Show("The preferred width of the viewport is " & sv.GetViewportPreferredWidth(0, 0).ToString())
    
    See Also