ControlCollection.IndexOf Method (Object)

Searches for the specified control and returns the zero-based index of the first occurrence in the ControlCollection instance.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
Function IndexOf ( _
    control As Object _
) As Integer
int IndexOf(
    Object control
)

Parameters

Return Value

Type: System.Int32
The index of the control, or -1 if the control is not in the ControlCollection instance.

Examples

The following code example adds a Button control to the start of the document, and then displays the index of the button in a message box.

Private Sub WordControlIndexOf()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Button1 As Microsoft.Office.Tools.Word.Controls.Button _
        = Me.Controls.AddButton(0, 0, 56.25F, 17.25F, "Button1")
    Button1.Text = "OK" 

    If Me.Controls.Contains(Button1) Then
        MessageBox.Show("The index of Button1 is " _
        & Controls.IndexOf(Button1))
    End If 
End Sub
private void WordControlIndexOf()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.Button button1 =
        this.Controls.AddButton(0, 0, 56.25F, 17.25F,
        "button1");
    button1.Text = "OK";

    if (this.Controls.Contains(button1))
    {
        MessageBox.Show("The index of button1 is " + 
            Controls.IndexOf(button1));
    }
}

.NET Framework Security

See Also

Reference

ControlCollection Interface

IndexOf Overload

Microsoft.Office.Tools.Word Namespace