ControlCollection.AddListView Method (Double, Double, Double, Double, String)

Article
06/18/2009

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

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

Syntax

'Declaration
Public Function AddListView ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As ListView
'Usage
Dim instance As ControlCollection
Dim left As Double
Dim top As Double
Dim width As Double
Dim height As Double
Dim name As String
Dim returnValue As ListView

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

public ListView AddListView(
    double left,
    double top,
    double width,
    double height,
    string name
)

Parameters

left
Type: System.Double
The distance in points between the left edge of the control and the left edge of the worksheet.

top
Type: System.Double
The distance in points between the top edge of the control and the top edge of the worksheet.

width
Type: System.Double
The width of the control in points.

height
Type: System.Double
The height of the control in points.

name
Type: System.String
The name of the control.

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 argument is nulla null reference (Nothing in Visual Basic) or has zero length.
ControlNameAlreadyExistsException	A control with the same name is already in the ControlCollection instance.

Remarks

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

Examples

The following code example adds a ListView control to the top of the worksheet, changes the view to List, and then adds two items to the ListView.

    Private Sub ExcelAddListView()

        Dim ListView1 As Microsoft.Office.Tools.Excel. _
            Controls.ListView = Me.Controls.AddListView( _
            0, 0, 90.75, 72.75, "ListView1")

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

    End Sub

private void ExcelAddListView()
{

    Microsoft.Office.Tools.Excel.Controls.ListView
         listView1 = this.Controls.AddListView(
         0, 0, 90.75, 72.75, "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.

Share via