Control.Contains Method (System.Windows.Forms)

Contains Method

.NET Framework Class Library

Control..::.Contains Method

Retrieves a value indicating whether the specified control is a child of the control.

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

Syntax

Visual Basic (Declaration)

Public Function Contains ( _
    ctl As Control _
) As Boolean

Visual Basic (Usage)

Dim instance As Control
Dim ctl As Control
Dim returnValue As Boolean

returnValue = instance.Contains(ctl)

public bool Contains(
    Control ctl
)

Visual C++

public:
bool Contains(
    Control^ ctl
)

JScript

public function Contains(
    ctl : Control
) : boolean

Parameters

ctl: Type: System.Windows.Forms..::.Control
The Control to evaluate.

Return Value

Type: System..::.Boolean
true if the specified control is a child of the control; otherwise, false.

Examples

The following code example ensures that a Label is visible by calling its BringToFront method. This example requires that you have a Form with a Panel named panel1, and a Label named label1.

Visual Basic

Private Sub MakeLabelVisible()
   ' If the panel contains label1, bring it 
   ' to the front to make sure it is visible. 
   If panel1.Contains(label1) Then
      label1.BringToFront()
   End If
End Sub

private void MakeLabelVisible()
{
   /* If the panel contains label1, bring it 
   * to the front to make sure it is visible. */
   if(panel1.Contains(label1))
   {
      label1.BringToFront();
   }
}

Visual C++

private:
   void MakeLabelVisible()
   {

      /* If the panel contains label1, bring it
         * to the front to make sure it is visible. */
      if ( panel1->Contains( label1 ) )
      {
         label1->BringToFront();
      }
   }

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

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

Reference

Control Class

Control Members

System.Windows.Forms Namespace

Contains

Controls

Parent