WorksheetBase.Index Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the index number of the worksheet within the collection of worksheets.
public:
property int Index { int get(); };
public int Index { get; }
member this.Index : int
Public ReadOnly Property Index As Integer
Property Value
The index number of the worksheet within the collection of worksheets.
Examples
The following code example uses the Index property to display the index number of the current worksheet before and after moving the worksheet to the last position in the workbook by using the Move method.
This example is for a document-level customization.
private void DisplayIndex()
{
MessageBox.Show("Before moving, this worksheet is at tab number " +
this.Index.ToString());
// Move the worksheet to the last position in the workbook.
this.Move(missing,
Globals.ThisWorkbook.Worksheets[Globals.ThisWorkbook.Worksheets.Count]);
MessageBox.Show("After moving, this worksheet is at tab number " +
this.Index.ToString());
}
Private Sub DisplayIndex()
MsgBox("Before moving, this worksheet is at tab number " & _
Me.Index.ToString())
' Move the worksheet to the last position in the workbook.
Me.Move(After:=Globals.ThisWorkbook.Worksheets( _
Globals.ThisWorkbook.Worksheets.Count))
MsgBox("After moving, this worksheet is at tab number " & _
Me.Index.ToString())
End Sub