ControlCollection.IndexOf Method

Definition

Namespace:

Microsoft.Office.Tools.Word

Assemblies:

Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Overloads

IndexOf(Object)	Searches for the specified control and returns the zero-based index of the first occurrence in the ControlCollection instance.
IndexOf(String)	Searches for the first occurrence of a control with the specified name in the ControlCollection instance.

IndexOf(Object)

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

public:
 int IndexOf(System::Object ^ control);

public int IndexOf (object control);

abstract member IndexOf : obj -> int

Public Function IndexOf (control As Object) As Integer

Parameters

control

Object

The control to find the index of.

Returns

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 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));
    }
}

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 

IndexOf(String)

Searches for the first occurrence of a control with the specified name in the ControlCollection instance.

public:
 int IndexOf(System::String ^ name);

public int IndexOf (string name);

abstract member IndexOf : string -> int

Public Function IndexOf (name As String) As Integer

Parameters

name

String

The name of the control that you want to find the index of.

Returns

Int32

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