GetViewportLeftColumn(Int32,Int32) Method

Gets the index of the leftmost column of the specified viewport on the specified sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function GetViewportLeftColumn( _
   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.GetViewportLeftColumn(sheetIndex, columnViewportIndex)

public int GetViewportLeftColumn( 
   int sheetIndex,
   int columnViewportIndex
)

Parameters

sheetIndex: Sheet index
columnViewportIndex: Viewport column index

Return Value

Integer index of the leftmost column of cells in the specified viewport

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	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;
int i;
sv = fpSpread1.GetRootWorkbook();
sv.AddViewport(0, 0);
sv.SetViewportLeftColumn(0, 5);
i = sv.GetViewportLeftColumn(0, 0);
MessageBox.Show("The left-most column of the viewport is " + i.ToString());

VB.NET

Dim sv As FarPoint.Win.Spread.SpreadView
Dim i As Integer
sv = FpSpread1.GetRootWorkbook()
sv.AddViewport(0, 0)
sv.SetViewportLeftColumn(0, 5)
i = sv.GetViewportLeftColumn(0, 0)
MessageBox.Show("The left-most column of the viewport is " & 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

Reference

SpreadView Class
SpreadView Members
Overload List