Spread Windows Forms 6.0 Product Documentation
AddViewport(Int32,Int32,Int32) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class > AddViewport Method : AddViewport(Int32,Int32,Int32) Method


sheetIndex
Index of sheet to which to add viewport
rowViewportIndex
Index of viewport row to add
columnViewportIndex
Index of viewport column to add

Glossary Item Box

Adds a row or column of viewports to the specified sheet.

Syntax

Visual Basic (Declaration) 
Public Overloads Sub AddViewport( _
   ByVal sheetIndex As Integer, _
   ByVal rowViewportIndex As Integer, _
   ByVal columnViewportIndex As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim sheetIndex As Integer
Dim rowViewportIndex As Integer
Dim columnViewportIndex As Integer
 
instance.AddViewport(sheetIndex, rowViewportIndex, columnViewportIndex)
C# 
public void AddViewport( 
   int sheetIndex,
   int rowViewportIndex,
   int columnViewportIndex
)

Parameters

sheetIndex
Index of sheet to which to add viewport
rowViewportIndex
Index of viewport row to add
columnViewportIndex
Index of viewport column to add

Exceptions

ExceptionDescription
System.ArgumentOutOfRangeException Specified sheet index is out of range; must be between 0 and total number of sheets

Remarks

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.

Example

C#Copy Code
fpSpread1.Sheets.Count = 3;
fpSpread1.AddViewport(1, 0, 0);
Visual BasicCopy Code
FpSpread1.Sheets.Count = 3
FpSpread1.AddViewport(1, 0, 0)

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.