IndexOf Method

TabControl.TabPageCollection.IndexOf Method

Returns the index of the specified tab page in the collection.

[Visual Basic]
Public Function IndexOf( _
   ByVal page As TabPage _
) As Integer
[C#]
public int IndexOf(
 TabPage page
);
[C++]
public: int IndexOf(
 TabPage* page
);
[JScript]
public function IndexOf(
   page : TabPage
) : int;

Parameters

page
The TabPage to locate in the collection.

Return Value

The 0-based index of the tab page; -1 if it cannot be found.

Exceptions

Exception Type Condition
ArgumentNullException The value of page is a null reference (Nothing in Visual Basic).

Example

[Visual Basic, C#, C++] The following example creates a TabControl with one TabPage. This example uses the IndexOf method to retrieve the tabPage1 index value. A ToolTip is used to display this value.

[Visual Basic, C#, C++] Use the System.Drawing and System.Windows.Forms namespaces for this example.

[Visual Basic] 
Imports System.Drawing
Imports System.Windows.Forms

Public Class Form1
    Inherits Form
    Private tabControl1 As TabControl
    Private tabPage1 As TabPage

    Public Sub New()
        Me.tabControl1 = New TabControl()
        Me.tabPage1 = New TabPage("myTabPage")

        Me.tabControl1.Controls.Add(tabPage1)
        Me.tabControl1.ShowToolTips = True
        Me.tabControl1.Location = New Point(25, 25)
        Me.tabControl1.Size = New Size(250, 250)

        ' Gets the tabPage1 TabIndex value from the tabControl1 controls collection.
        ' Converts the tabPage1 TabIndex value to a string.

        Me.tabPage1.ToolTipText = "TabIndex = " + tabControl1.TabPages.IndexOf(tabPage1).ToString()

        Me.ClientSize = New Size(300, 300)
        Me.Controls.Add(tabControl1)
    End Sub

    Shared Sub Main()
        Application.Run(New Form1())
    End Sub
End Class

[C#] 
using System.Drawing;
using System.Windows.Forms;

public class Form1 : Form
{
    private TabControl tabControl1;
    private TabPage tabPage1;

    public Form1()
    {
        this.tabControl1 = new TabControl();
        this.tabPage1 = new TabPage("myTabPage");

        this.tabControl1.TabPages.Add(tabPage1);
        this.tabControl1.ShowToolTips = true;
        this.tabControl1.Location = new Point(25, 25);
        this.tabControl1.Size = new Size(250, 250);

        this.tabPage1.ToolTipText = "TabIndex = " +
            
            // Gets the tabPage1 TabIndex value from the tabControl1 controls collection.
            // Converts the tabPage1 TabIndex value to a string.
            (tabControl1.TabPages.IndexOf(tabPage1)).ToString();

        this.ClientSize = new Size(300, 300);
        this.Controls.Add(tabControl1);
    }

    static void Main() 
    {
        Application.Run(new Form1());
    }
}

[C++] 
using namespace System::Drawing;
using namespace System::Windows::Forms;

public __gc class Form1 : public Form {
private:
    TabControl*  tabControl1;
    TabPage*  tabPage1;

public:
    Form1() {
        this->tabControl1 = new TabControl();
        this->tabPage1 = new TabPage(S"myTabPage");

        this->tabControl1->TabPages->Add(tabPage1);
        this->tabControl1->ShowToolTips = true;
        this->tabControl1->Location = Point(25, 25);
        this->tabControl1->Size = System::Drawing::Size(250, 250);

        this->tabPage1->ToolTipText = System::String::Concat(
            S"TabIndex = ", 

            // Gets the tabPage1 TabIndex value from the tabControl1 controls collection.
            // Converts the tabPage1 TabIndex value to a string.
            (tabControl1->TabPages->IndexOf(tabPage1)).ToString()
            
            );

        this->ClientSize = System::Drawing::Size(300, 300);
        this->Controls->Add(tabControl1);
    }
};

int main() {
    Application::Run(new Form1());
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

TabControl.TabPageCollection Class | TabControl.TabPageCollection Members | System.Windows.Forms Namespace | Contains | Item | RemoveAt

Show:
© 2016 Microsoft