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


sheetIndex
Sheet index
rowViewportIndex
Viewport row index

Glossary Item Box

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

Syntax

Visual Basic (Declaration) 
Public Overloads Function GetViewportPreferredHeight( _
   ByVal sheetIndex As Integer, _
   ByVal rowViewportIndex As Integer _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim sheetIndex As Integer
Dim rowViewportIndex As Integer
Dim value As Integer
 
value = instance.GetViewportPreferredHeight(sheetIndex, rowViewportIndex)
C# 
public int GetViewportPreferredHeight( 
   int sheetIndex,
   int rowViewportIndex
)

Parameters

sheetIndex
Sheet index
rowViewportIndex
Viewport row index

Return Value

Integer number of pixels in the height of the specified viewport

Exceptions

ExceptionDescription
System.ArgumentOutOfRangeException Specified sheet index is out of range; 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

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

int i;
fpSpread1.SetViewportPreferredHeight(1, 1, 20);
i = fpSpread1.GetViewportPreferredHeight(1, 1);
textBox1.Text = i.ToString();
Visual BasicCopy Code
FpSpread1.Sheets.Count = 3
FpSpread1.AddViewport(1, 0, 0)

Dim i As Integer
FpSpread1.SetViewportPreferredHeight(1, 1, 20)
i = FpSpread1.GetViewportPreferredHeight(1, 1)
TextBox1.Text = i.ToString()

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.