SetActiveViewport(Int32,Int32,Int32) Method

Sets the active viewport for the specified sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub SetActiveViewport( _
   ByVal sheetIndex As Integer, _
   ByVal rowViewportIndex As Integer, _
   ByVal columnViewportIndex As Integer _
)

'Usage
 
Dim instance As SpreadView
Dim sheetIndex As Integer
Dim rowViewportIndex As Integer
Dim columnViewportIndex As Integer
 
instance.SetActiveViewport(sheetIndex, rowViewportIndex, columnViewportIndex)

public void SetActiveViewport( 
   int sheetIndex,
   int rowViewportIndex,
   int columnViewportIndex
)

Parameters

sheetIndex: Sheet index
rowViewportIndex: Viewport row index
columnViewportIndex: Viewport column index

Return Value

Indexes are zero-based, so the first item has an index of 0, etc.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	Specified sheet index is not valid; must be between 0 and total number of sheets.

Example

This example uses the SetActiveViewport method.

FarPoint.Win.Spread.SpreadView sv = fpSpread1.GetRootWorkbook();
sv.AddViewport(0, 0);
sv.AddViewport(2,2);
sv.SetActiveViewport(0, 1,2);

VB.NET

Dim sv As FarPoint.Win.Spread.SpreadView = FpSpread1.GetRootWorkbook
sv.AddViewport(0, 0)
sv.AddViewport(2,2)
sv.SetActiveViewport(0, 1,2)

Requirements

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

Reference

SpreadView Class
SpreadView Members
Overload List