ControlCollection.AddListView Method (, Single, Single, String) (2007 System)

  • Article

Adds a new ListView 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 AddListView ( _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As ListView

'Usage
Dim instance As ControlCollection 
Dim range As Range 
Dim width As Single 
Dim height As Single 
Dim name As String 
Dim returnValue As ListView 

returnValue = instance.AddListView(range, _
    width, height, name)

public ListView AddListView(
    Range range,
    float width,
    float height,
    string name
)

public:
ListView^ AddListView(
    Range^ range, 
    float width, 
    float height, 
    String^ name
)

public function AddListView(
    range : Range, 
    width : float, 
    height : float, 
    name : String
) : ListView

Parameters

  • range
    Type: Range

    A Range that provides the location for the control.

  • height
    Type: System.Single

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.ListView
The ListView 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 ListView objects to the end of the ControlCollection.

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

Examples

The following code example adds a ListView control to the first paragraph in the document, changes the view to List, and then adds two items to the ListView.

Private Sub WordRangeAddListView()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim ListView1 As Microsoft.Office.Tools.Word.Controls. _
        ListView = Me.Controls.AddListView(Me.Paragraphs(1). _
        Range, 90.75F, 72.75F, "ListView1")
    ListView1.View = View.List
    ListView1.Items.Add("Item 1")
    ListView1.Items.Add("Item 2")

End Sub

private void WordRangeAddListView()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.ListView
         listView1 = this.Controls.AddListView(
         this.Paragraphs[1].Range, 90.75F, 72.75F, "listView1");
    listView1.View = View.List;
    listView1.Items.Add("Item 1");
    listView1.Items.Add("Item 2");
}

.NET Framework Security

See Also

Reference

ControlCollection Class

ControlCollection Members

AddListView Overload

Microsoft.Office.Tools.Word Namespace