ControlCollection.IndexOf Method (System.Web.UI)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
ControlCollection.IndexOf Method

Retrieves the index of a specified Control object in the collection.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
Syntax
Visual Basic
Public Overridable Function IndexOf ( _
	value As Control _
) As Integer
C#
public virtual int IndexOf(
	Control value
)
Visual C++
public:
virtual int IndexOf(
	Control^ value
)
F#
abstract IndexOf : 
        value:Control -> int 
override IndexOf : 
        value:Control -> int

Parameters

value
Type: System.Web.UI.Control
The Control for which the index is returned.

Return Value

Type: System.Int32
The index of the specified server control. If the server control is not currently a member of the collection, it returns -1.
Remarks

Use this method to determine the index location of the specified server control in the ControlCollection object.

Examples

The following code example uses the IndexOf method to write the index location of a control, myLiteralControl, in the ControlCollection collection of a Button control named myButton.

Visual Basic

' Create a LiteralControl and use the Add method to add it
' to a button's ControlCollection, then use the AddAt method
' to add another LiteralControl to the collection at the
' index location of 1.
Dim myLiteralControl As LiteralControl =  _
    new LiteralControl("ChildControl1")
myButton.Controls.Add(myLiteralControl)
myButton.Controls.AddAt(1,new LiteralControl("ChildControl2"))
Response.Write("<b>ChildControl2 is added at index 1</b>")

' Get the Index location of the myLiteralControl LiteralControl
' and write it to the page.
Response.Write("<br /><b>Index of the ChildControl myLiteralControl is </b>" & _
                 myButton.Controls.IndexOf(myLiteralControl))
C#

// Create a LiteralControl and use the Add method to add it
// to a button's ControlCollection, then use the AddAt method
// to add another LiteralControl to the collection at the
// index location of 1.
LiteralControl myLiteralControl = new LiteralControl("ChildControl1");
myButton.Controls.Add(myLiteralControl);
myButton.Controls.AddAt(1,new LiteralControl("ChildControl2"));
Response.Write("<b>ChildControl2 is added at index 1</b>");

// Get the Index location of the myLiteralControl LiteralControl
// and write it to the page.
Response.Write("<br /><b>Index of the ChildControl myLiteralControl is " +
    "</b>" + myButton.Controls.IndexOf(myLiteralControl));
Version Information

.NET Framework

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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

ControlCollection Class
System.Web.UI Namespace
Controls