ControlExtensions.AddListView Method

Definition

Namespace:

Microsoft.Office.Tools.Word

Assembly:

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

Overloads

AddListView(ControlCollection, Range, Single, Single, String)	Adds a new ListView control to the document in the specified size and location.
AddListView(ControlCollection, Single, Single, Single, Single, String)	Adds a new ListView control to the document in the specified size and location.

AddListView(ControlCollection, Range, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::ListView ^ AddListView(Microsoft::Office::Tools::Word::ControlCollection ^ controls, Microsoft::Office::Interop::Word::Range ^ range, float width, float height, System::String ^ name);

public static Microsoft.Office.Tools.Word.Controls.ListView AddListView (this Microsoft.Office.Tools.Word.ControlCollection controls, Microsoft.Office.Interop.Word.Range range, float width, float height, string name);

static member AddListView : Microsoft.Office.Tools.Word.ControlCollection * Microsoft.Office.Interop.Word.Range * single * single * string -> Microsoft.Office.Tools.Word.Controls.ListView

<Extension()>
Public Function AddListView (controls As ControlCollection, range As Range, width As Single, height As Single, name As String) As ListView

Parameters

controls

ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

range

Range

The location of the control.

width

Single

The width of the control in points.

height

Single

The height of the control in points.

name

String

The name that can be used to index the control in the ControlCollection instance.

Returns

ListView

The control that was added to the document.

Exceptions

ArgumentNullException

The name or range argument is null, 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.

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. To use this example, run it from the ThisDocument class in a document-level project.

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

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 

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.

AddListView(ControlCollection, Single, Single, Single, Single, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Word::Controls::ListView ^ AddListView(Microsoft::Office::Tools::Word::ControlCollection ^ controls, float left, float top, float width, float height, System::String ^ name);

public static Microsoft.Office.Tools.Word.Controls.ListView AddListView (this Microsoft.Office.Tools.Word.ControlCollection controls, float left, float top, float width, float height, string name);

static member AddListView : Microsoft.Office.Tools.Word.ControlCollection * single * single * single * single * string -> Microsoft.Office.Tools.Word.Controls.ListView

<Extension()>
Public Function AddListView (controls As ControlCollection, left As Single, top As Single, width As Single, height As Single, name As String) As ListView

Parameters

controls

ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

left

Single

The distance in points between the left edge of the control and the left edge of the document.

top

Single

The distance in points between the top edge of the control and the top edge of the document.

width

Single

The width of the control in points.

height

Single

The height of the control in points.

name

String

The name that can be used to index the control in the ControlCollection instance.

Returns

ListView

The control that was added to the document.

Exceptions

ArgumentNullException

The name argument is null or has zero length.

ControlNameAlreadyExistsException

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

Examples

The following code example adds a ListView control to start of the document, changes the view to List, and then adds two items to the ListView. To use this example, run it from the ThisDocument class in a document-level project.

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

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

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.