Export (0) Print
Expand All

ControlCollection.IndexOf Method

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

[Visual Basic]
Public Overridable Function IndexOf( _
   ByVal value As Control _
) As Integer
[C#]
public virtual int IndexOf(
 Control value
);
[C++]
public: virtual int IndexOf(
 Control* value
);
[JScript]
public function IndexOf(
   value : Control
) : int;

Parameters

value
The Control object for which the index is returned.

Return Value

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.

Example

[Visual Basic] The following example uses the IndexOf method to write the index location of a control, myLiteralControl, in the ControlCollection 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#, C++, JScript] No example is available for C#, C++, or JScript. To view a Visual Basic example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

ControlCollection Class | ControlCollection Members | System.Web.UI Namespace | Controls

Show:
© 2014 Microsoft