ListObject Interface

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

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

Syntax

'Declaration
<GuidAttribute("48eb309a-698d-4d40-95af-d9d083e63d30")> _
Public Interface ListObject _
    Inherits IBindableComponent, IComponent, IDisposable, ISupportInitialize
[GuidAttribute("48eb309a-698d-4d40-95af-d9d083e63d30")]
public interface ListObject : IBindableComponent, 
    IComponent, IDisposable, ISupportInitialize

The ListObject type exposes the following members.

Properties

  Name Description
Public property _Default Infrastructure.
Public property Active Gets 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 property AlternativeText Gets or sets the descriptive (alternative) text string for the specified table. This property can be used only in Excel 2010 projects.
Public property Application Gets an Application that represents either the Microsoft Office Excel application or the creator of the ListObject.
Public property AutoFilter Gets a filtered table.
Public property AutoSelectRows Gets or sets a value that indicates whether the entire row is selected when the SelectedIndex changes.
Public property AutoSetDataBoundColumnHeaders Gets or sets a value that determines whether the column headers are automatically set to match the data source.
Public property BindingContext Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public property Comment Gets or sets a comment that is associated with the ListObject.
Public property Container Infrastructure.
Public property Creator Gets the application in which the ListObject was created.
Public property DataBindings Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public property DataBodyRange Gets a Range that represents the range that contains the data area in the list between the header row and the insert row.
Public property DataBoundFormat Gets or sets the format style for data-bound ListObject controls.
Public property DataBoundFormatSettings Gets or sets which FormatSettings of the specified XlRangeAutoFormat are applied to the ListObject control.
Public property DataMember Gets or sets the specific data member in a multimember data source to bind to the ListObject control.
Public property DataSource Gets or sets the source that contains a list of values that are used to populate the items within the control.
Public property DefaultDataSourceUpdateMode Gets or sets the default DataSourceUpdateMode.
Public property DisplayName Gets or sets the displayed name.
Public property DisplayRightToLeft Gets a value that indicates whether the ListObject is displayed from right to left instead of from left to right.
Public property HeaderRowRange Gets a Range that represents the range of the header row.
Public property InnerObject Gets a Microsoft.Office.Interop.Excel.ListObject that represents the underlying native object for the Microsoft.Office.Tools.Excel.ListObject.
Public property InsertRowRange Gets a Range that represents the Insert row, if any, of the ListObject control.
Public property IsBinding Gets a value that indicates whether data binding is active.
Public property IsSelected Gets a value that indicates whether the ListObject is selected.
Public property ListColumns Gets a ListColumns collection that represents all the columns in the ListObject control.
Public property ListRows Gets a ListRows object that represents all the rows of data in the ListObject control.
Public property MappedColumns Infrastructure.
Public property Name Gets or sets the name of the ListObject control.
Public property Parent Gets the parent object of the ListObject control.
Public property QueryTable Gets the QueryTable that provides a link for the ListObject control to the list server.
Public property Range Gets a Range that represents the range to which the ListObject applies.
Public property SaveSortOrder Gets or sets a value that indicates whether the row order of the ListObject control is saved in the worksheet.
Public property SelectedIndex Gets or sets the index of the row that is currently selected.
Public property SharePointURL Gets the URL of the SharePoint list for a given ListObject control.
Public property ShowAutoFilter Gets or sets a value that indicates whether the AutoFilter is displayed.
Public property ShowHeaders Gets or sets a value that indicates whether the header information should be displayed.
Public property ShowTableStyleColumnStripes Gets or sets a value that indicates whether the Column Stripes table style is used.
Public property ShowTableStyleFirstColumn Gets or sets a value that indicates whether the first column is formatted.
Public property ShowTableStyleLastColumn Gets or sets a value that indicates whether the last column is formatted.
Public property ShowTableStyleRowStripes Gets or sets a value that indicates whether the Row Stripes table style is used.
Public property ShowTotals Gets or sets a value that indicates whether the Total row is visible.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property Sort Gets the sort column or columns, and the sort order for the ListObject collection.
Public property SourceType Gets the current source of the list.
Public property Summary Gets or sets the description associated with the alternative text string for the specified table. This property can be used only in Excel 2010 projects.
Public property TableStyle Gets or sets the table style.
Public property Tag Gets or sets the object that contains data about the Tag control.
Public property TotalsRowRange Gets a Range that represents the Total row of the ListObject control.
Public property XmlMap Gets an XmlMap that represents the schema map used for the list.

Top

Methods

  Name Description
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method Delete Deletes a dynamically created ListObject control, clears the cell data from the worksheet, and removes the control from the ControlCollection.
Public method Disconnect Removes data binding from the ListObject control.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method EndInit Signals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public method ExportToVisio Exports a ListObject to Visio.
Public method Publish Publishes the ListObject control to a server that is running Microsoft Windows SharePoint Services.
Public method Refresh Updates the ListObject control with current data and schema from a server that is running Microsoft Windows SharePoint Services.
Public method RefreshDataRow Updates the ListObject data row that is associated with the specified data row.
Public method RefreshDataRows Updates all of the rows in the ListObject with data from the data source.
Public method ResetPersistedBindingInformation Clears information about changes made to the ListObject control by the user.
Public method Resize Enables a ListObject control to be resized over a new range.
Public method SetDataBinding(Object) Binds a ListObject control to a data source.
Public method SetDataBinding(Object, String) Binds a ListObject control to a specified data member of a data source.
Public method SetDataBinding(Object, String, array<String[]) Binds a ListObject control to a specified data member of a data source, and shows only specified columns of that data member.
Public method Unlink Removes the link to a Microsoft Windows SharePoint Services site from a ListObject control.
Public method Unlist Removes the list functionality from a Microsoft.Office.Interop.Excel.ListObject control.
Public method UpdateChanges Updates the list on a Microsoft Windows SharePoint Services site with the changes made to the ListObject control in the worksheet.

Top

Events

  Name Description
Public event BeforeAddDataBoundRow Occurs just before an attempt to add a new row to a ListObject control that is bound to data.
Public event BeforeDoubleClick Occurs when the ListObject control is double-clicked, before the default double-click action.
Public event BeforeRightClick Occurs when the ListObject control is right-clicked, before the default right-click action.
Public event BindingContextChanged Infrastructure.
Public event Change Occurs when something changes in the ListObject control.
Public event DataBindingFailure Occurs when a condition causes the data binding of a ListObject control to fail.
Public event DataMemberChanged Occurs when the value of the DataMember property changes.
Public event DataSourceChanged Occurs when the value of the DataSource property changes.
Public event Deselected Occurs when selection moves from the ListObject control to outside of the ListObject control.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event ErrorAddDataBoundRow Occurs when a user tries to add a row to a data-bound ListObject control, but the row cannot be added.
Public event OriginalDataRestored Occurs when a user performs an action that is not allowed, and the ListObject control then reverts back to its original state.
Public event Selected Occurs when the ListObject control is selected.
Public event SelectedIndexChanged Occurs when the value of the SelectedIndex property changes.
Public event SelectionChange Occurs when the selection changes inside the ListObject control.

Top

Remarks

For more information, see ListObject Control.

Note

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. 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.

See Also

Reference

Microsoft.Office.Tools.Excel Namespace