TabControl.TabPageCollection.Remove(TabPage) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

TabControl.TabPageCollection.cs

Removes a TabPage from the collection.

public:
 void Remove(System::Windows::Forms::TabPage ^ value);

public void Remove (System.Windows.Forms.TabPage value);

member this.Remove : System.Windows.Forms.TabPage -> unit

Public Sub Remove (value As TabPage)

Parameters

value

TabPage

The TabPage to remove.

Exceptions

ArgumentNullException

The value parameter is null.

Examples

The following code example initially creates a TabControl with three TabPage. This example uses the Remove method to remove a single tab page, specifically tabPage2 from the tabControl1 controls collection. Notice that the TabPages property gets the tabControl1 controls collection to add and remove tab pages from this collection.

Use the System.Drawing and System.Windows.Forms namespaces with 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 three tab pages.
      array<TabPage^>^tabPages = {tabPage1,tabPage2,tabPage3};
      this->tabControl1->TabPages->AddRange( tabPages );
      
      // Gets the tabControl1 controls collection.
      // Removes the tabPage2 from the collection.
      this->tabControl1->TabPages->Remove( tabPage2 );
      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 );
}

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 three tab pages.
        this.tabControl1.TabPages.AddRange(new TabPage[] {
            tabPage1, tabPage2, tabPage3});

        // Gets the tabControl1 controls collection.
        // Removes the tabPage2 from the collection.
        this.tabControl1.TabPages.Remove(tabPage2);

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

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 three tab pages.
        Me.tabControl1.TabPages.AddRange(New TabPage() {tabPage1, tabPage2, tabPage3})

        ' Gets the tabControl1 tab pages collection.
        ' Removes the tabPage2 from the collection.
        Me.tabControl1.TabPages.Remove(tabPage2)

        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

See also

• Add(TabPage)
• Clear()
• RemoveAt(Int32)