Export (0) Print
Expand All

TabControl.TabPageCollection.Contains Method

Determines whether a specified tab page is in the collection.

[Visual Basic]
Public Function Contains( _
   ByVal page As TabPage _
) As Boolean
[C#]
public bool Contains(
 TabPage page
);
[C++]
public: bool Contains(
 TabPage* page
);
[JScript]
public function Contains(
   page : TabPage
) : Boolean;

Parameters

page
The TabPage to locate in the collection.

Return Value

true if the specified TabPage is in the collection; otherwise, false.

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 initially creates a TabControl with three TabPage objects. The first two tab pages are added directly to tabControl1 by the AddRange method. The Contains method determines tabPage3 is part of the tabControl1 controls collection. Because tabPage3 was not found in this collection, it was added by the Add method.

[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
    Private tabPage2 As TabPage
    Private tabPage3 As TabPage

    Public Sub New()
        Me.tabControl1 = New TabControl()
        Dim tabText As String() = {"tabPage1", "tabPage2", "tabPage3"}
        Me.tabPage1 = New TabPage(tabText(0))
        Me.tabPage2 = New TabPage(tabText(1))
        Me.tabPage3 = New TabPage(tabText(2))

        ' Populates the tabControl1 with two tab pages.      
        Me.tabControl1.TabPages.AddRange(New TabPage() {tabPage1, tabPage2})

        ' Checks the tabControl1 controls collection for tabPage3.
        ' Adds tabPage3 to tabControl1 if it is not in the collection.
        If tabControl1.TabPages.Contains(tabPage3) = False Then
            Me.tabControl1.TabPages.Add(tabPage3)
        End If

        Me.tabControl1.Location = New Point(25, 25)
        Me.tabControl1.Size = New Size(250, 250)

        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;
    private TabPage tabPage2;
    private TabPage tabPage3;

    public Form1()
    {
        this.tabControl1 = new TabControl();
        string[] tabText = {"tabPage1", "tabPage2", "tabPage3"};
        this.tabPage1 = new TabPage(tabText[0]);
        this.tabPage2 = new TabPage(tabText[1]);
        this.tabPage3 = new TabPage(tabText[2]);

        // Populates the tabControl1 with two tab pages.
        this.tabControl1.TabPages.AddRange(new TabPage[] {
            tabPage1, tabPage2});

        // Checks the tabControl1 controls collection for tabPage3.
        // Adds tabPage3 to tabControl1 if it is not in the collection.
        if (tabControl1.TabPages.Contains(tabPage3) == false)
            this.tabControl1.TabPages.Add(tabPage3);

        this.tabControl1.Location = new Point(25, 25);
        this.tabControl1.Size = new Size(250, 250);

        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;
    TabPage*  tabPage2;
    TabPage*  tabPage3;

public:
    Form1() {
        this->tabControl1 = new TabControl();
        System::String* tabText[] = {S"tabPage1", S"tabPage2", S"tabPage3"};
        this->tabPage1 = new TabPage(tabText->Item[0]->ToString());
        this->tabPage2 = new TabPage(tabText->Item[1]->ToString());
        this->tabPage3 = new TabPage(tabText->Item[2]->ToString());

        // Populates the tabControl1 with two tab pages.
        TabPage* tabPages[] = {tabPage1, tabPage2};
        this->tabControl1->TabPages->AddRange(tabPages);

        // Checks the tabControl1 controls collection for tabPage3.
        // Adds tabPage3 to tabControl1 if it is not in the collection.
        if (tabControl1->TabPages->Contains(tabPage3) == false)
            this->tabControl1->TabPages->Add(tabPage3);
        
        this->tabControl1->Location = Point(25, 25);
        this->tabControl1->Size = System::Drawing::Size(250, 250);
        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 | Item | IndexOf | GetEnumerator | TabPage

Show:
© 2015 Microsoft