Export (0) Print
Expand All

ListObject.Name Property

Gets or sets the name of the ListObject control.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in microsoft.office.tools.excel.dll)

public string Name { get; set; }

Property Value

The name of the ListObject control.

This name is used solely as a unique identifier for the Microsoft.Office.Interop.Excel.ListObjects.Item(System.Object) property of the Microsoft.Office.Interop.Excel.ListObjects collection. This property can only be set through the object model.

By default, each ListObject control name begins with the word "List", followed by a number (no spaces). If an attempt is made to set the Name property to a name already used by another ListObject control, an exception is thrown.

The following code example creates a ListObject in the current worksheet and then uses the Name property to set the name of the ListObject to "Employees".

private void ListObject_Metadata()
{
    Microsoft.Office.Tools.Excel.ListObject list1 =
        this.Controls.AddListObject(this.Range["A1", "D4"], "Employees");

    list1.Name = "Employees";
    list1.Tag = "Employee data";

    MessageBox.Show("The list name is " + list1.Name.ToString() +
        " and the tag is " + list1.Tag.ToString() + ".");
}

Show:
© 2014 Microsoft