Export (0) Print
Expand All

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)

'Declaration
Public Overridable Function IndexOf ( _
	value As Control _
) As Integer

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.

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

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.

' 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))

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1
Show:
© 2015 Microsoft