This documentation is archived and is not being maintained.

Control.ControlCollection.RemoveAt Method

Removes a control from the control collection at the specified indexed location.

[Visual Basic]
Public Overridable Sub RemoveAt( _
   ByVal index As Integer _
) Implements IList.RemoveAt
[C#]
public virtual void RemoveAt(
 int index
);
[C++]
public: virtual void RemoveAt(
 int index
);
[JScript]
public function RemoveAt(
   index : int
);

Parameters

index
The index value of the Control to remove.

Implements

IList.RemoveAt

Remarks

When a Control is removed from the control collection, all subsequent controls are moved up one position in the collection.

You can also remove a Control that you previously added by using the Remove or Clear methods.

To add new Control objects to the collection, use the Add or AddRange methods.

Example

[Visual Basic, C#, C++] The following example removes the first Control in the Control.ControlCollection of the derived class Panel if the count of the collection is greater than zero. The example assumes you have created a Panel, a Button, and at least one other control on a Form. The other control(s) are added to the Panel control, and the Panel control added to the Form. When the button is clicked, the first control contained in the panel is removed from the Control.ControlCollection.

[Visual Basic] 
' Remove the first control in the collection.
Private Sub RemoveAtButton_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles RemoveAtButton.Click
    If (Panel1.Controls.Count > 0) Then
        Panel1.Controls.RemoveAt(0)
    End If
End Sub

[C#] 
// Remove the first control in the collection.
private void removeAtButton_Click(object sender, System.EventArgs e)
{
   if (panel1.Controls.Count > 0)
   {
      panel1.Controls.RemoveAt(0);
   }
}

[C++] 
// Remove the first control in the collection.
private:
void removeAtButton_Click(Object* /*sender*/, System::EventArgs* /*e*/) {
    if (panel1->Controls->Count > 0) {
        panel1->Controls->RemoveAt(0);
    }
}

[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

Control.ControlCollection Class | Control.ControlCollection Members | System.Windows.Forms Namespace | Remove | Clear | Add

Show: