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


In This Topic
    GetActiveColumnViewportIndex(Int32) Method
    In This Topic
    Gets the index of the active viewport column for the specified sheet.
    Syntax
    'Declaration
     
    Public Overloads Function GetActiveColumnViewportIndex( _
       ByVal sheetIndex As Integer _
    ) As Integer
    'Usage
     
    Dim instance As SpreadView
    Dim sheetIndex As Integer
    Dim value As Integer
     
    value = instance.GetActiveColumnViewportIndex(sheetIndex)
    public int GetActiveColumnViewportIndex( 
       int sheetIndex
    )

    Parameters

    sheetIndex
    Sheet index

    Return Value

    Integer index of the active 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
    This example uses the GetActiveColumnViewportIndex method.
    FarPoint.Win.Spread.SpreadView sv;
    int i;
    sv = fpSpread1.GetRootWorkbook();
    i = sv.GetActiveColumnViewportIndex(0);
    MessageBox.Show(i.ToString());
    
    Dim sv As FarPoint.Win.Spread.SpreadView
    Dim i As Integer
    sv = FpSpread1.GetRootWorkbook()
    i = sv.GetActiveColumnViewportIndex(0)
    MessageBox.Show(i.ToString())
    
    Requirements

    Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

    See Also