Gets the maximum width for the viewport column for the specified sheet.

Syntax

Visual Basic (Declaration)
Public Overloads Function GetViewportPreferredWidth( _ ByVal sheetIndex As Integer, _ ByVal columnViewportIndex As Integer _ ) As Integer

Visual Basic (Usage)	Copy Code
Dim instance As SpreadView Dim sheetIndex As Integer Dim columnViewportIndex As Integer Dim value As Integer value = instance.GetViewportPreferredWidth(sheetIndex, columnViewportIndex)

C#
public int GetViewportPreferredWidth( int sheetIndex, int columnViewportIndex )

Parameters

sheetIndex: Sheet index
columnViewportIndex: Viewport column index

Return Value

Integer number of pixels in the width of the viewport column

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

Example

C#	Copy Code
FarPoint.Win.Spread.SpreadView sv = fpSpread1.GetRootWorkbook(); sv.AddViewport(0, 0); sv.SetViewportPreferredWidth(0, 80); MessageBox.Show("The preferred width of the viewport is " + sv.GetViewportPreferredWidth(0, 0).ToString());

Copy Code

FarPoint.Win.Spread.SpreadView sv = fpSpread1.GetRootWorkbook();
sv.AddViewport(0, 0);
sv.SetViewportPreferredWidth(0, 80);
MessageBox.Show("The preferred width of the viewport is " + sv.GetViewportPreferredWidth(0, 0).ToString());

Visual Basic	Copy Code
Dim sv As FarPoint.Win.Spread.SpreadView = FpSpread1.GetRootWorkbook sv.AddViewport(0, 0) sv.SetViewportPreferredWidth(0, 80) MessageBox.Show("The preferred width of the viewport is " & sv.GetViewportPreferredWidth(0, 0).ToString())

Visual Basic

Copy Code

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