ControlCollection.AddListView Method (Range, String) (2003 System)

Article
10/10/2008

Adds a new ListView control to the worksheet at the range specified.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

Syntax

'Declaration
Public Function AddListView ( _
    range As Range, _
    name As String _
) As ListView
'Usage
Dim instance As ControlCollection
Dim range As Range
Dim name As String
Dim returnValue As ListView

returnValue = instance.AddListView(range, _
    name)

public ListView AddListView(
    Range range,
    string name
)

Parameters

range
Type: Microsoft.Office.Interop.Excel.Range
A Range that provides the bounds for the control.

name
Type: System.String
The name of the control that can be used to index the control in the ControlCollection instance.

Return Value

Type: Microsoft.Office.Tools.Excel.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. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddListView method enables you to add ListView objects to the end of the ControlCollection. To remove a ListView that was previously added programmatically, use the Remove method.

The control automatically resizes when the range is resized.

Examples

The following code example adds a ListView control to cells A1 through B6, changes the view to List, and then adds two items to the ListView.

Private Sub ExcelRangeAddListView()

    Dim ListView1 As Microsoft.Office.Tools.Excel. _
        Controls.ListView = Me.Controls.AddListView( _
        Me.Range("A1", "B6"), "ListView1")

    ListView1.View = View.List
    ListView1.Items.Add("Item 1")
    ListView1.Items.Add("Item 2")

End Sub

     private void ExcelRangeAddListView()
        {

            Microsoft.Office.Tools.Excel.Controls.ListView
                 listView1 = this.Controls.AddListView(
                 this.Range["A1", "B6"], "listView1");
            listView1.View = View.List;
            listView1.Items.Add("Item 1");
            listView1.Items.Add("Item 2");
        }

Permissions

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.