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

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 ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As ListBox
'Usage
Dim instance As ControlCollection
Dim range As Range
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As ListBox

returnValue = instance.AddListBox(range, _
    width, height, name)
public ListBox AddListBox(
    Range range,
    float width,
    float height,
    string name
)

Parameters

  • 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 or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.

ControlNameAlreadyExistsException

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

InvalidRangeException

The range that was specified is not valid.

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 first paragraph in the document, adds two items to the list box, and then selects the first item.

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

    End Sub 

private void WordRangeAddListBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.ListBox
         listBox1 = this.Controls.AddListBox(
         this.Paragraphs[1].Range, 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