ListObject Interface

Definition

Namespace:

Microsoft.Office.Interop.Excel

Assembly:

Microsoft.Office.Interop.Excel.dll

Represents a list object on a worksheet.

public interface class ListObject

[System.Runtime.InteropServices.Guid("00024471-0000-0000-C000-000000000046")]
[System.Runtime.InteropServices.InterfaceType(2)]
public interface ListObject

Public Interface ListObject

Attributes

GuidAttribute InterfaceTypeAttribute

Remarks

The ListObject object is a member of the ListObjects collection. The ListObjects collection contains all the list objects on a worksheet.

Use the ListObjects property of the Worksheet to return a ListObjects collection.

Properties

_Default	Reserved for internal use.
Active	Returns a Boolean value indicating whether a ListObject object in a worksheet is active — that is, whether the active cell is inside the range of the ListObject object.
AlternativeText	Gets or sets the descriptive (alternative) text string for the specified table.
Application	Returns an Application object that represents the Microsoft Excel application.
AutoFilter	Filters a list using the AutoFilter. Read-only.
Comment	Returns or sets the comment associated with the list object. Read/write String.
Creator	Returns a 32-bit integer that indicates the application in which this object was created.
DataBodyRange	Returns a Range object that represents the range that contains the data area in the list between the header row and the insert row.
DisplayName	Returns or sets the display name for the specified ListObject object. Read/write String.
DisplayRightToLeft	Determines if the specified window, worksheet, or ListObject object is displayed from right to left instead of from left to right.
HeaderRowRange	Returns a Range object that represents the range of the header row for a list.
InsertRowRange	Returns a Range object representing the Insert row, if any, of a specified ListObject object.
ListColumns	Returns a ListColumns collection that represents all the columns in a ListObject object.
ListRows	Returns a ListRows object that represents all the rows of data in the ListObject object.
Name	Returns or sets the name of the ListObject object.
Parent	Returns the parent object for the specified object.
QueryTable	Returns the QueryTable object that provides a link for the ListObject object to the list server.
Range	Returns a Range object that represents the range to which the specified list object applies.
SharePointURL	Returns a String representing the URL of the SharePoint list for a given ListObject object.
ShowAutoFilter	Returns a Boolean value indicating whether the AutoFilter will be displayed.
ShowAutoFilterDropDown	True when the AutoFilter drop down for the ListObject object is displayed. Boolean (bool in C#) Read/Write
ShowHeaders	Returns or sets if the header information should be displayed for the specified ListObject object. Read/write Boolean.
ShowTableStyleColumnStripes	Returns or sets if the Column Stripes table style is used for the specified ListObject object. Read/write Boolean.
ShowTableStyleFirstColumn	Returns or sets if the first column is formatted for the specified ListObject object. Read/write Boolean.
ShowTableStyleLastColumn	Returns or sets if the last column is displayed for the specified ListObject object. Read/write Boolean.
ShowTableStyleRowStripes	Returns or sets if the Row Stripes table style is used for the specified ListObject object. Read/write Boolean.
ShowTotals	Returns or sets a Boolean value to indicate whether the Total row is visible.
Slicers	Returns a list of the table slicers associated with a ListObject. Read-only
Sort	Gets or sets the sort column or columns, and sort order for the ListObject collection.
SourceType	Returns one of the XlListObjectSourceType constants indicating the current source of the list.
Summary	Gets or sets the description associated with the alternative text string for the specified table.
TableObject	Returns a TableObject object. Read-only
TableStyle	Gets or sets the table style for the specified ListObject object. Read/write Object.
TotalsRowRange	Returns a Range object representing the Total row, if any, from a specified ListObject object.
XmlMap	Returns an XmlMap object that represents the schema map used for the specified list.

Methods

Delete()	Deletes the ListObject object and clears the cell data from the worksheet.
ExportToVisio()	Exports a ListObject object to Visio.
Publish(Object, Boolean)	Publishes the ListObject object to a server that is running Microsoft Windows SharePoint Services.
Refresh()	Returns the current data and schema for the list from the server that is running Microsoft Windows SharePoint Services.
Resize(Range)	The Resize method allows a ListObject object to be resized over a new range.
Unlink()	Removes the link to a Microsoft Windows SharePoint Services site from a list.
Unlist()	Removes the list functionality from a ListObject object.
UpdateChanges(XlListConflict)	Updates the list on a Microsoft Windows SharePoint Services site with the changes made to the list in the worksheet.