GetSheetTabRectangle Method (FpSpread)

Gets the rectangle of the tab associated with a sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetSheetTabRectangle( _
   ByVal sheetIndex As Integer _
) As Rectangle

'Usage
 
Dim instance As FpSpread
Dim sheetIndex As Integer
Dim value As Rectangle
 
value = instance.GetSheetTabRectangle(sheetIndex)

public Rectangle GetSheetTabRectangle( 
   int sheetIndex
)

Parameters

sheetIndex: Index of the sheet from which to retrieve a tab rectangle

Return Value

Rectangle object containing the size and location of the rectangle of the sheet tab

Example

This example illustrates the use of this member by returning the rectangle of the sheet tab for the specified sheet.

FarPoint.Win.Spread.FpSpread fpSpread1 = new FarPoint.Win.Spread.FpSpread();
FarPoint.Win.Spread.SheetView shv = new FarPoint.Win.Spread.SheetView();
fpSpread1.Location = new Point(10, 10);
fpSpread1.Height = 200;
fpSpread1.Width = 400;
Controls.Add(fpSpread1);
fpSpread1.Sheets.Add(shv);
listBox1.Items.Add(fpSpread1.GetSheetTabRectangle(0).ToString());

Visual Basic

Dim fpSpread1 As New FarPoint.Win.Spread.FpSpread()
Dim shv As New FarPoint.Win.Spread.SheetView()
fpSpread1.Location = New Point(10, 10)
fpSpread1.Height = 200
fpSpread1.Width = 400
Controls.Add(fpSpread1)
fpSpread1.Sheets.Add(shv)
ListBox1.Items.Add(fpSpread1.GetSheetTabRectangle(0).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

User-Task Documentation

Customizing the Sheet Name Tabs of the Component