GetTabText Method

Gets the text of the sheet name tab at the specified sheet in the Spread component.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetTabText( _
   ByVal index As Integer _
) As String

'Usage
 
Dim instance As FpSpread
Dim index As Integer
Dim value As String
 
value = instance.GetTabText(index)

public string GetTabText( 
   int index
)

Parameters

index: Index of the specified sheet

Return Value

String containing the text to be displayed in the sheet name tab

Remarks

The tab text is displayed in the sheet name tab associated with the specified sheet (SheetView object).

The sheet index is zero-based (the first sheet has an index of 0).

Example

This example creates three sheets for the spreadsheet, names them and returns the name of the second sheet to a text box.

FpSpread1.Sheets.Count=3;
FpSpread1.Sheets[0].SheetName="One";
FpSpread1.Sheets[1].SheetName="Two";
FpSpread1.Sheets[2].SheetName="Three";
TextBox1.Text=FpSpread1.GetTabText(1);

Visual Basic

FpSpread1.Sheets.Count=3
FpSpread1.Sheets(0).SheetName="One"
FpSpread1.Sheets(1).SheetName="Two"
FpSpread1.Sheets(2).SheetName="Three"
TextBox1.Text=FpSpread1.GetTabText(1)

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

FpSpread Class
FpSpread Members