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)

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

NameDescription
System_CAPS_pubpropertyActive

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.

System_CAPS_pubpropertyAlternativeText

Gets or sets the descriptive (alternative) text string for the specified table.

System_CAPS_pubpropertyApplication

Gets an Application that represents either the Microsoft Office Excel application or the creator of the ListObject.

System_CAPS_pubpropertyAutoFilter

Gets a filtered table.

System_CAPS_pubpropertyAutoSelectRows

Gets or sets a value that indicates whether the entire row is selected when the SelectedIndex changes.

System_CAPS_pubpropertyAutoSetDataBoundColumnHeaders

Gets or sets a value that determines whether the column headers are automatically set to match the data source.

System_CAPS_pubpropertyBindingContext

(Inherited from IBindableComponent.)

System_CAPS_pubpropertyComment

Gets or sets a comment that is associated with the ListObject.

System_CAPS_pubpropertyContainer

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyCreator

Gets the application in which the ListObject was created.

System_CAPS_pubpropertyDataBindings

(Inherited from IBindableComponent.)

System_CAPS_pubpropertyDataBodyRange

Gets a Range that represents the range that contains the data area in the list between the header row and the insert row.

System_CAPS_pubpropertyDataBoundFormat

Gets or sets the format style for data-bound ListObject controls.

System_CAPS_pubpropertyDataBoundFormatSettings

Gets or sets which FormatSettings of the specified XlRangeAutoFormat are applied to the ListObject control.

System_CAPS_pubpropertyDataMember

Gets or sets the specific data member in a multimember data source to bind to the ListObject control.

System_CAPS_pubpropertyDataSource

Gets or sets the source that contains a list of values that are used to populate the items within the control.

System_CAPS_pubpropertyDefaultDataSourceUpdateMode

Gets or sets the default DataSourceUpdateMode.

System_CAPS_pubpropertyDisplayName

Gets or sets the displayed name.

System_CAPS_pubpropertyDisplayRightToLeft

Gets a value that indicates whether the ListObject is displayed from right to left instead of from left to right.

System_CAPS_pubpropertyHeaderRowRange

Gets a Range that represents the range of the header row.

System_CAPS_pubpropertyInnerObject

Gets a Microsoft.Office.Interop.Excel.ListObject that represents the underlying native object for the Microsoft.Office.Tools.Excel.ListObject.

System_CAPS_pubpropertyInsertRowRange

Gets a Range that represents the Insert row, if any, of the ListObject control.

System_CAPS_pubpropertyIsBinding

Gets a value that indicates whether data binding is active.

System_CAPS_pubpropertyIsSelected

Gets a value that indicates whether the ListObject is selected.

System_CAPS_pubpropertyListColumns

Gets a ListColumns collection that represents all the columns in the ListObject control.

System_CAPS_pubpropertyListRows

Gets a ListRows object that represents all the rows of data in the ListObject control.

System_CAPS_pubpropertyMappedColumns

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyName

Gets or sets the name of the ListObject control.

System_CAPS_pubpropertyParent

Gets the parent object of the ListObject control.

System_CAPS_pubpropertyQueryTable

Gets the QueryTable that provides a link for the ListObject control to the list server.

System_CAPS_pubpropertyRange

Gets a Range that represents the range to which the ListObject applies.

System_CAPS_pubpropertySaveSortOrder

Gets or sets a value that indicates whether the row order of the ListObject control is saved in the worksheet.

System_CAPS_pubpropertySelectedIndex

Gets or sets the index of the row that is currently selected.

System_CAPS_pubpropertySharePointURL

Gets the URL of the SharePoint list for a given ListObject control.

System_CAPS_pubpropertyShowAutoFilter

Gets or sets a value that indicates whether the AutoFilter is displayed.

System_CAPS_pubpropertyShowHeaders

Gets or sets a value that indicates whether the header information should be displayed.

System_CAPS_pubpropertyShowTableStyleColumnStripes

Gets or sets a value that indicates whether the Column Stripes table style is used.

System_CAPS_pubpropertyShowTableStyleFirstColumn

Gets or sets a value that indicates whether the first column is formatted.

System_CAPS_pubpropertyShowTableStyleLastColumn

Gets or sets a value that indicates whether the last column is formatted.

System_CAPS_pubpropertyShowTableStyleRowStripes

Gets or sets a value that indicates whether the Row Stripes table style is used.

System_CAPS_pubpropertyShowTotals

Gets or sets a value that indicates whether the Total row is visible.

System_CAPS_pubpropertySite

(Inherited from IComponent.)

System_CAPS_pubpropertySort

Gets the sort column or columns, and the sort order for the ListObject collection.

System_CAPS_pubpropertySourceType

Gets the current source of the list.

System_CAPS_pubpropertySummary

Gets or sets the description associated with the alternative text string for the specified table.

System_CAPS_pubpropertyTableStyle

Gets or sets the table style.

System_CAPS_pubpropertyTag

Gets or sets the object that contains data about the Tag control.

System_CAPS_pubpropertyTotalsRowRange

Gets a Range that represents the Total row of the ListObject control.

System_CAPS_pubpropertyXmlMap

Gets an XmlMap that represents the schema map used for the list.

NameDescription
System_CAPS_pubmethodBeginInit()

(Inherited from ISupportInitialize.)

System_CAPS_pubmethodDelete()

Deletes a dynamically created ListObject control, clears the cell data from the worksheet, and removes the control from the ControlCollection.

System_CAPS_pubmethodDisconnect()

Removes data binding from the ListObject control.

System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodEndInit()

(Inherited from ISupportInitialize.)

System_CAPS_pubmethodExportToVisio()

Exports a ListObject to Visio.

System_CAPS_pubmethodPublish(Object, Boolean)

Publishes the ListObject control to a server that is running Microsoft Windows SharePoint Services.

System_CAPS_pubmethodRefresh()

Updates the ListObject control with current data and schema from a server that is running Microsoft Windows SharePoint Services.

System_CAPS_pubmethodRefreshDataRow(Int32)

Updates the ListObject data row that is associated with the specified data row.

System_CAPS_pubmethodRefreshDataRows()

Updates all of the rows in the ListObject with data from the data source.

System_CAPS_pubmethodResetPersistedBindingInformation()

Clears information about changes made to the ListObject control by the user.

System_CAPS_pubmethodResize(Range)

Enables a ListObject control to be resized over a new range.

System_CAPS_pubmethodSetDataBinding(Object)

Binds a ListObject control to a data source.

System_CAPS_pubmethodSetDataBinding(Object, String)

Binds a ListObject control to a specified data member of a data source.

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

System_CAPS_pubmethodUnlink()

Removes the link to a Microsoft Windows SharePoint Services site from a ListObject control.

System_CAPS_pubmethodUnlist()

Removes the list functionality from a Microsoft.Office.Interop.Excel.ListObject control.

NameDescription
System_CAPS_pubeventBeforeAddDataBoundRow

Occurs just before an attempt to add a new row to a ListObject control that is bound to data.

System_CAPS_pubeventBeforeDoubleClick

Occurs when the ListObject control is double-clicked, before the default double-click action.

System_CAPS_pubeventBeforeRightClick

Occurs when the ListObject control is right-clicked, before the default right-click action.

System_CAPS_pubeventBindingContextChanged

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubeventChange

Occurs when something changes in the ListObject control.

System_CAPS_pubeventDataBindingFailure

Occurs when a condition causes the data binding of a ListObject control to fail.

System_CAPS_pubeventDataMemberChanged

Occurs when the value of the DataMember property changes.

System_CAPS_pubeventDataSourceChanged

Occurs when the value of the DataSource property changes.

System_CAPS_pubeventDeselected

Occurs when selection moves from the ListObject control to outside of the ListObject control.

System_CAPS_pubeventDisposed

(Inherited from IComponent.)

System_CAPS_pubeventErrorAddDataBoundRow

Occurs when a user tries to add a row to a data-bound ListObject control, but the row cannot be added.

System_CAPS_pubeventOriginalDataRestored

Occurs when a user performs an action that is not allowed, and the ListObject control then reverts back to its original state.

System_CAPS_pubeventSelected

Occurs when the ListObject control is selected.

System_CAPS_pubeventSelectedIndexChanged

Occurs when the value of the SelectedIndex property changes.

System_CAPS_pubeventSelectionChange

Occurs when the selection changes inside the ListObject control.

For more information, see ListObject Control.

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

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. 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.

Return to top
Show: