GetViewportPreferredWidth(Int32,Int32) Method

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

Syntax

Visual Basic
C#

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

'Usage
 
Dim instance As FpSpread
Dim sheetIndex As Integer
Dim columnViewportIndex As Integer
Dim value As Integer
 
value = instance.GetViewportPreferredWidth(sheetIndex, columnViewportIndex)

public int GetViewportPreferredWidth( 
   int sheetIndex,
   int columnViewportIndex
)

Parameters

sheetIndex: Sheet index
columnViewportIndex: Column index of viewport

Return Value

Integer number of pixels in the widthof the specified viewport

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	Specified sheet index is out of range; must be between 0 and the 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

fpSpread1.Sheets.Count = 3;
fpSpread1.AddViewport(1, 0, 0);

int i;
fpSpread1.SetViewportPreferredWidth(1, 1, 20);
i = fpSpread1.GetViewportPreferredWidth(1, 1);
textBox1.Text = i.ToString();

Visual Basic

FpSpread1.Sheets.Count = 3
FpSpread1.AddViewport(1, 0, 0)

Dim i As Integer
FpSpread1.SetViewportPreferredWidth(1, 1, 20)
i = FpSpread1.GetViewportPreferredWidth(1, 1)
TextBox1.Text = i.ToString()

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

FpSpread Class
FpSpread Members
Overload List