TabControl.TabPageCollection.IndexOf(TabPage) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: TabControl.TabPageCollection.cs

Source:: TabControl.TabPageCollection.cs

Source:: TabControl.TabPageCollection.cs

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.

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

public:
 int IndexOf(System::Windows::Forms::TabPage ^ page);

public int IndexOf(System.Windows.Forms.TabPage page);

member this.IndexOf : System.Windows.Forms.TabPage -> int

Public Function IndexOf (page As TabPage) As Integer

Parameters

page: TabPage

The TabPage to locate in the collection.

Returns

Int32

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

Exceptions

ArgumentNullException

The value of page is null.

Examples

The following code 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.

using namespace System::Drawing;
using namespace System::Windows::Forms;
public ref class Form1: public Form
{
private:
   TabControl^ tabControl1;
   TabPage^ tabPage1;

public:
   Form1()
   {
      this->tabControl1 = gcnew TabControl;
      this->tabPage1 = gcnew TabPage( "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( "TabIndex = ", (tabControl1->TabPages->IndexOf( tabPage1 )).ToString() );
      
      // Gets the tabPage1 TabIndex value from the tabControl1 controls collection.
      // Converts the tabPage1 TabIndex value to a string.
      this->ClientSize = System::Drawing::Size( 300, 300 );
      this->Controls->Add( tabControl1 );
   }

};

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

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());
    }
}

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

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via