GetViewportPreferredHeight(Int32,Int32) Method

Gets the maximum height for the viewport row for the specified sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function GetViewportPreferredHeight( _
   ByVal sheetIndex As Integer, _
   ByVal rowViewportIndex As Integer _
) As Integer

'Usage
 
Dim instance As SpreadView
Dim sheetIndex As Integer
Dim rowViewportIndex As Integer
Dim value As Integer
 
value = instance.GetViewportPreferredHeight(sheetIndex, rowViewportIndex)

public int GetViewportPreferredHeight( 
   int sheetIndex,
   int rowViewportIndex
)

Parameters

sheetIndex: Sheet index
rowViewportIndex: Viewport row index

Return Value

Integer number of in pixels of the height of the viewport row

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 row index is zero-based, so the first (top) viewport row has an index of 0.

Example

This example uses the GetViewportPreferredHeight method.

FarPoint.Win.Spread.SpreadView sv = fpSpread1.GetRootWorkbook();
sv.AddViewport(0, 0);
sv.SetViewportPreferredHeight(0, 105);
MessageBox.Show("The preferred height of the viewport is " + sv.GetViewportPreferredHeight(0, 0).ToString());

VB.NET

Dim sv As FarPoint.Win.Spread.SpreadView = FpSpread1.GetRootWorkbook
sv.AddViewport(0, 0)
sv.SetViewportPreferredHeight(0, 105)
MessageBox.Show("The preferred height of the viewport is " & sv.GetViewportPreferredHeight(0, 0).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