ControlExtensions.AddListView Method (ControlCollection, Range, Single, Single, String)
Adds a new ListView control to the document in the specified size and location.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function AddListView ( _
controls As ControlCollection, _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As ListView
public static ListView AddListView(
this ControlCollection controls,
Range range,
float width,
float height,
string name
)
Parameters
- controls
Type: Microsoft.Office.Tools.Word.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 Document.Controls property (in an application-level project) or the DocumentBase.Controls property (in a document-level project), this parameter is supplied automatically.
- range
Type: Microsoft.Office.Interop.Word.Range
The location of the control.
- width
Type: System.Single
The width of the control in points.
- height
Type: System.Single
The height of the control in points.
- name
Type: System.String
The name that can be used to index the control in the ControlCollection instance.
Return Value
Type: Microsoft.Office.Tools.Word.Controls.ListView
The control that was added to the document.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
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. To use this example, run it from the ThisDocument class in a document-level project.
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
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.