This documentation is archived and is not being maintained.

TabControl.TabPageCollection.Clear Method

Removes all the tab pages from the collection.

[Visual Basic]
Public Overridable Sub Clear() Implements IList.Clear
[C#]
public virtual void Clear();
[C++]
public: virtual void Clear();
[JScript]
public function Clear();

Implements

IList.Clear

Example

[Visual Basic, C#, C++] The following example initially creates a TabControl with three TabPage. This example uses the Clear method to clear all controls in the tabControl1 controls collection at one instance. Then, the example adds tabPage2 back to the collection. Notice that the TabPages property is used to get the tabControl1 controls collection to remove (and add) tab pages from this collection.

[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()
        Me.tabPage1 = New TabPage("tabPage1")
        Me.tabPage2 = New TabPage("tabPage2")
        Me.tabPage3 = New TabPage("tabPage3")

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

        ' Removes all the tab pages from tabControl1.
        Me.tabControl1.TabPages.Clear()

        ' Adds the tabPage1 back to tabControl1.
        Me.tabControl1.TabPages.Add(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();
        this.tabPage1 = new TabPage("tabPage1");
        this.tabPage2 = new TabPage("tabPage2");
        this.tabPage3 = new TabPage("tabPage3");

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

        // Removes all the tab pages from tabControl1.
        this.tabControl1.TabPages.Clear();

        // Adds the tabPage1 back to tabControl1.
        this.tabControl1.TabPages.Add(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();
        this->tabPage1 = new TabPage(S"tabPage1");
        this->tabPage2 = new TabPage(S"tabPage2");
        this->tabPage3 = new TabPage(S"tabPage3");

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

        // Removes all the tab pages from tabControl1.
        this->tabControl1->TabPages->Clear();

        // Adds the tabPage1 back to tabControl1.
        this->tabControl1->TabPages->Add(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, .NET Compact Framework

See Also

TabControl.TabPageCollection Class | TabControl.TabPageCollection Members | System.Windows.Forms Namespace | Remove

Show: