NamedRange.ListObject Property

Gets a Microsoft.Office.Interop.Excel.ListObject for the NamedRange control.

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

Syntax

'Declaration
ReadOnly Property ListObject As ListObject
    Get
ListObject ListObject { get; }

Property Value

Type: Microsoft.Office.Interop.Excel.ListObject
A Microsoft.Office.Interop.Excel.ListObject for the NamedRange control.

Examples

The following code example creates a ListObject inside of a NamedRange and then uses the ListObject property of the NamedRange to display the number of rows in the ListObject.

This example is for a document-level customization.

    Private Sub GetListObject()
        Me.Range("B2").Value2 = "Row 1"
        Me.Range("C2").Value2 = "Row 2"
        Me.Range("D2").Value2 = "Row 3"

        Me.Range("B3", "B5").Value2 = 10
        Me.Range("C3", "C5").Value2 = 20
        Me.Range("D3", "C5").Value2 = 30

        Dim listObject1 As Microsoft.Office.Tools.Excel.ListObject _
            = Me.Controls.AddListObject(Me.Range("B2", "D5"), _
            "listObject1")

        Dim getListObjectRange As _
            Microsoft.Office.Tools.Excel.NamedRange = _
            Me.Controls.AddNamedRange(Me.Range("A1", "E6"), _
            "getListObjectRange")
        getListObjectRange.Select()

        Dim numberOfRows As Integer = _
            getListObjectRange.ListObject.DataBodyRange.Rows.Count
        MessageBox.Show("The DataBodyRange of the ListObject contains " & _
            numberOfRows & " rows.")
    End Sub

private void GetListObject()
{
    this.Range["B2", missing].Value2 = "Row 1";
    this.Range["C2", missing].Value2 = "Row 2";
    this.Range["D2", missing].Value2 = "Row 3";

    this.Range["B3", "B5"].Value2 = 10;
    this.Range["C3", "C5"].Value2 = 20;
    this.Range["D3", "C5"].Value2 = 30;

    Microsoft.Office.Tools.Excel.ListObject listObject1 =
        this.Controls.AddListObject(
        this.Range["B2", "D5"], "listObject1");

    Microsoft.Office.Tools.Excel.NamedRange getListObjectRange = 
        this.Controls.AddNamedRange(
        this.Range["A1", "E6"], "getListObjectRange");
    getListObjectRange.Select();

    int numberOfRows = 
        getListObjectRange.ListObject.DataBodyRange.Rows.Count;
    MessageBox.Show("The DataBodyRange of the ListObject contains " +
        numberOfRows + " rows.");
}

.NET Framework Security

See Also

Reference

NamedRange Interface

Microsoft.Office.Tools.Excel Namespace