AddViewport(Int32,Int32,Int32) Method

Visual Basic
C#

'Declaration
 
Public Overloads Sub AddViewport( _
   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.AddViewport(sheetIndex, rowViewportIndex, columnViewportIndex)

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

Parameters

sheetIndex: Index of sheet to which to add viewports
rowViewportIndex: Viewport row index
columnViewportIndex: Viewport column index

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

The viewport column and viewport row indexes are zero-based, so the first (leftmost) viewport column and first (top) viewport row both have indexes of 0.

You must add an entire viewport row or viewport column; you cannot add an individual viewport.

Use both indexes to add both a viewport row and viewport column at the same time.

Use -1 for the index if you do not want a set of viewports in that orientation. For example, AddViewport(0, -1, 3) only adds a viewport column (by the fourth viewport column), but no viewport row is added.

This example uses the AddViewport method.

C#

FarPoint.Win.Spread.SpreadView sv = new FarPoint.Win.Spread.SpreadView(fpSpread1);
sv = fpSpread1.GetRootWorkbook();
sv.AddViewport(0, 0, 1);
int i;
i = sv.GetActiveRowViewportIndex();
sv.Sheets[0].Rows[i].BackColor = Color.Yellow;

Visual Basic

Dim sv As New FarPoint.Win.Spread.SpreadView(FpSpread1)
sv = FpSpread1.GetRootWorkbook()
sv.AddViewport(0, 0, 1)
Dim i As Integer
i = sv.GetActiveRowViewportIndex()
sv.Sheets(0).Rows(i).BackColor = Color.Yellow

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