ControlCollection.AddListBox Method (Single, Single, Single, Single, String)

  • Article

Adds a new ListBox control to the document in the specified size and location.

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

Syntax

'Declaration
Public Function AddListBox ( _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As ListBox
'Usage
Dim instance As ControlCollection
Dim left As Single
Dim top As Single
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As ListBox

returnValue = instance.AddListBox(left, _
    top, width, height, name)

public ListBox AddListBox(
    float left,
    float top,
    float width,
    float height,
    string name
)

Parameters

  • left
    Type: System.Single
    The distance in points between the left edge of the control and the left edge of the document.
  • top
    Type: System.Single
    The distance in points between the top edge of the control and the top edge of the document.
  • height
    Type: System.Single
    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.ListBox
The ListBox control that was added to the ControlCollection instance.

Exceptions

Exception Condition
ArgumentNullException

The name argument is nulla null reference (Nothing in Visual Basic) or has zero length.
ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

Remarks

This method enables you to add ListBox objects to the end of the ControlCollection.

To remove a ListBox that was added programmatically, use the Remove method.

Examples

The following code example adds a ListBox control to the start of the document, adds two items to the list box, and then selects the first item.

    Private Sub WordAddListBox()
        Me.Paragraphs(1).Range.InsertParagraphBefore()
        Dim ListBox1 As Microsoft.Office.Tools.Word.Controls. _
            ListBox = Me.Controls.AddListBox(0, 0, 90, 71.25F, _
            "ListBox1")
        ListBox1.Items.Add("First Item")
        ListBox1.Items.Add("Second Item")
        ListBox1.SelectedIndex = 0

    End Sub 


private void WordAddListBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.ListBox
         listBox1 = this.Controls.AddListBox(
         0, 0, 90, 71.25F, "lisBox1");
    listBox1.Items.Add("First Item");
    listBox1.Items.Add("Second Item");
    listBox1.SelectedIndex = 0;
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddListBox Overload

Microsoft.Office.Tools.Word Namespace