Export (0) Print
Expand All

Control.ControlCollection.Contains Method

Determines whether the specified control is a member of the collection.

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

'Declaration
Public Function Contains ( _
	control As Control _
) As Boolean

Parameters

control
Type: System.Windows.Forms.Control

The Control to locate in the collection.

Return Value

Type: System.Boolean
true if the Control is a member of the collection; otherwise, false.

This method enables you to determine whether a Control is a member of the collection before attempting to perform operations on the Control. You can use this method to confirm that a Control has been added to or is still a member of the collection.

The following code example removes a Control from the Control.ControlCollection of the derived class Panel if it is a member of the collection. The example requires that you have created a Panel, a Button, and at least one RadioButton control on a Form. The RadioButton controls are added to the Panel control, and the Panel control added to the Form. When the button is clicked, the radio button named removeButton is removed from the Control.ControlCollection.

    ' Remove the RadioButton control if it exists. 
    Private Sub RemoveButton_Click(ByVal sender As System.Object, _
		ByVal e As System.EventArgs) Handles RemoveButton.Click
        If Panel1.Controls.Contains(RemoveButton) Then
            Panel1.Controls.Remove(RemoveButton)
        End If 
    End Sub

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft