This documentation is archived and is not being maintained.

TabControl.TabPageCollection.Remove Method

Removes a TabPage from the collection.

[Visual Basic]
Public Sub Remove( _
   ByVal value As TabPage _
)
[C#]
public void Remove(
 TabPage value
);
[C++]
public: void Remove(
 TabPage* value
);
[JScript]
public function Remove(
   value : TabPage
);

Parameters

value
The TabPage to remove.

Exceptions

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

Example

[Visual Basic, C#, C++] The following 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.

[Visual Basic, C#, C++] Use the System.Drawing and System.Windows.Forms namespaces with 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 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

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

[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 three tab pages.
        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(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

See Also

TabControl.TabPageCollection Class | TabControl.TabPageCollection Members | System.Windows.Forms Namespace | Add | Clear | RemoveAt

Show: