TabControl::TabPageCollection::Contains Method (TabPage^)

 

Determines whether a specified tab page is in the collection.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public:
bool Contains(
	TabPage^ page
)

Parameters

page
Type: System.Windows.Forms::TabPage^

The TabPage to locate in the collection.

Return Value

Type: System::Boolean

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

Exception Condition
ArgumentNullException

The value of page is null.

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

Use the System.Drawing and System.Windows.Forms namespaces for this example.

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

public:
   Form1()
   {
      this->tabControl1 = gcnew TabControl;
      array<System::String^>^tabText = {"tabPage1","tabPage2","tabPage3"};
      this->tabPage1 = gcnew TabPage( tabText[ 0 ]->ToString() );
      this->tabPage2 = gcnew TabPage( tabText[ 1 ]->ToString() );
      this->tabPage3 = gcnew TabPage( tabText[ 2 ]->ToString() );

      // Populates the tabControl1 with two tab pages.
      array<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( gcnew Form1 );
}

.NET Framework
Available since 1.1
Return to top
Show: