Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ListObject Interface

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

The ListObject control displays data in a series of rows and columns.

Namespace:  Microsoft.Office.Tools.Excel
Assemblies:   Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

[GuidAttribute("48eb309a-698d-4d40-95af-d9d083e63d30")]
public interface ListObject : IBindableComponent, 
	IComponent, IDisposable, ISupportInitialize

The ListObject type exposes the following members.

  NameDescription
Public property_DefaultInfrastructure.
Public propertyActiveGets a value that indicates whether a ListObject control on a worksheet is active; that is, whether the active cell is inside the range of the ListObject control.
Public propertyAlternativeTextGets or sets the descriptive (alternative) text string for the specified table.
Public propertyApplicationGets an Application that represents either the Microsoft Office Excel application or the creator of the ListObject.
Public propertyAutoFilterGets a filtered table.
Public propertyAutoSelectRowsGets or sets a value that indicates whether the entire row is selected when the SelectedIndex changes.
Public propertyAutoSetDataBoundColumnHeadersGets or sets a value that determines whether the column headers are automatically set to match the data source.
Public propertyBindingContextGets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public propertyCommentGets or sets a comment that is associated with the ListObject.
Public propertyContainerInfrastructure.
Public propertyCreatorGets the application in which the ListObject was created.
Public propertyDataBindingsGets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public propertyDataBodyRangeGets a Range that represents the range that contains the data area in the list between the header row and the insert row.
Public propertyDataBoundFormatGets or sets the format style for data-bound ListObject controls.
Public propertyDataBoundFormatSettingsGets or sets which FormatSettings of the specified XlRangeAutoFormat are applied to the ListObject control.
Public propertyDataMemberGets or sets the specific data member in a multimember data source to bind to the ListObject control.
Public propertyDataSourceGets or sets the source that contains a list of values that are used to populate the items within the control.
Public propertyDefaultDataSourceUpdateModeGets or sets the default DataSourceUpdateMode.
Public propertyDisplayNameGets or sets the displayed name.
Public propertyDisplayRightToLeftGets a value that indicates whether the ListObject is displayed from right to left instead of from left to right.
Public propertyHeaderRowRangeGets a Range that represents the range of the header row.
Public propertyInnerObjectGets a Microsoft.Office.Interop.Excel.ListObject that represents the underlying native object for the Microsoft.Office.Tools.Excel.ListObject.
Public propertyInsertRowRangeGets a Range that represents the Insert row, if any, of the ListObject control.
Public propertyIsBindingGets a value that indicates whether data binding is active.
Public propertyIsSelectedGets a value that indicates whether the ListObject is selected.
Public propertyListColumnsGets a ListColumns collection that represents all the columns in the ListObject control.
Public propertyListRowsGets a ListRows object that represents all the rows of data in the ListObject control.
Public propertyMappedColumnsInfrastructure.
Public propertyNameGets or sets the name of the ListObject control.
Public propertyParentGets the parent object of the ListObject control.
Public propertyQueryTableGets the QueryTable that provides a link for the ListObject control to the list server.
Public propertyRangeGets a Range that represents the range to which the ListObject applies.
Public propertySaveSortOrderGets or sets a value that indicates whether the row order of the ListObject control is saved in the worksheet.
Public propertySelectedIndexGets or sets the index of the row that is currently selected.
Public propertySharePointURLGets the URL of the SharePoint list for a given ListObject control.
Public propertyShowAutoFilterGets or sets a value that indicates whether the AutoFilter is displayed.
Public propertyShowHeadersGets or sets a value that indicates whether the header information should be displayed.
Public propertyShowTableStyleColumnStripesGets or sets a value that indicates whether the Column Stripes table style is used.
Public propertyShowTableStyleFirstColumnGets or sets a value that indicates whether the first column is formatted.
Public propertyShowTableStyleLastColumnGets or sets a value that indicates whether the last column is formatted.
Public propertyShowTableStyleRowStripesGets or sets a value that indicates whether the Row Stripes table style is used.
Public propertyShowTotalsGets or sets a value that indicates whether the Total row is visible.
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertySortGets the sort column or columns, and the sort order for the ListObject collection.
Public propertySourceTypeGets the current source of the list.
Public propertySummaryGets or sets the description associated with the alternative text string for the specified table.
Public propertyTableStyleGets or sets the table style.
Public propertyTagGets or sets the object that contains data about the Tag control.
Public propertyTotalsRowRangeGets a Range that represents the Total row of the ListObject control.
Public propertyXmlMapGets an XmlMap that represents the schema map used for the list.
Top

  NameDescription
Public methodBeginInitSignals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public methodDeleteDeletes a dynamically created ListObject control, clears the cell data from the worksheet, and removes the control from the ControlCollection.
Public methodDisconnectRemoves data binding from the ListObject control.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodEndInitSignals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public methodExportToVisioExports a ListObject to Visio.
Public methodPublishPublishes the ListObject control to a server that is running Microsoft Windows SharePoint Services.
Public methodRefreshUpdates the ListObject control with current data and schema from a server that is running Microsoft Windows SharePoint Services.
Public methodRefreshDataRowUpdates the ListObject data row that is associated with the specified data row.
Public methodRefreshDataRowsUpdates all of the rows in the ListObject with data from the data source.
Public methodResetPersistedBindingInformationClears information about changes made to the ListObject control by the user.
Public methodResizeEnables a ListObject control to be resized over a new range.
Public methodSetDataBinding(Object)Binds a ListObject control to a data source.
Public methodSetDataBinding(Object, String)Binds a ListObject control to a specified data member of a data source.
Public methodSetDataBinding(Object, String, String[])Binds a ListObject control to a specified data member of a data source, and shows only specified columns of that data member.
Public methodUnlinkRemoves the link to a Microsoft Windows SharePoint Services site from a ListObject control.
Public methodUnlistRemoves the list functionality from a Microsoft.Office.Interop.Excel.ListObject control.
Public methodUpdateChangesUpdates the list on a Microsoft Windows SharePoint Services site with the changes made to the ListObject control in the worksheet.
Top

  NameDescription
Public eventBeforeAddDataBoundRowOccurs just before an attempt to add a new row to a ListObject control that is bound to data.
Public eventBeforeDoubleClickOccurs when the ListObject control is double-clicked, before the default double-click action.
Public eventBeforeRightClickOccurs when the ListObject control is right-clicked, before the default right-click action.
Public eventBindingContextChangedInfrastructure.
Public eventChangeOccurs when something changes in the ListObject control.
Public eventDataBindingFailureOccurs when a condition causes the data binding of a ListObject control to fail.
Public eventDataMemberChangedOccurs when the value of the DataMember property changes.
Public eventDataSourceChangedOccurs when the value of the DataSource property changes.
Public eventDeselectedOccurs when selection moves from the ListObject control to outside of the ListObject control.
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public eventErrorAddDataBoundRowOccurs when a user tries to add a row to a data-bound ListObject control, but the row cannot be added.
Public eventOriginalDataRestoredOccurs when a user performs an action that is not allowed, and the ListObject control then reverts back to its original state.
Public eventSelectedOccurs when the ListObject control is selected.
Public eventSelectedIndexChangedOccurs when the value of the SelectedIndex property changes.
Public eventSelectionChangeOccurs when the selection changes inside the ListObject control.
Top

For more information, see ListObject Control.

NoteNote

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Show:
© 2014 Microsoft