WorksheetBase.Index Property
Gets the index number of the worksheet within the collection of worksheets.
Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
Syntax
'Declaration
Public ReadOnly Property Index As Integer
public int Index { get; }
Property Value
Type: System.Int32
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 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
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());
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.