IWpfTableControl Interface

Visual Studio 2015

Displays and manages a data as a table.

Namespace: Microsoft.VisualStudio.Shell.TableControl
Assembly: Microsoft.VisualStudio.Shell.Immutable.14.0 (in Microsoft.VisualStudio.Shell.Immutable.14.0.dll)

Syntax

C++

[CLSCompliantAttribute(false)]
public interface class IWpfTableControl : IDisposable

Properties

	Name	Description
	AutoSubscribe	Indicates whether this table control will automatically subscribe to all data sources added to its Manager.
	ColumnDefinitionManager	Gets the ITableColumnDefinitionManager used by this (and every other) IWpfTableControl.
	ColumnStates	Gets a snapshot of the current column states.
	Control	Gets the WPF control that displays the data from the activated ITableDataSources.
	Entries	Gets the entries displayed in the control.
	Manager	Gets the ITableManager that provides the data for this control.
	SelectedEntries	Gets or sets entries selected in the control.
	SelectedEntry	Gets the selected entry in the table control. Returns null if no items are selected. If multiple items are selected, then we return whatever item considered (by the underlying WPF controls consider to be the selected item.
	SelectedOrFirstEntry	Gets the selected entry in the table control or, if no entry is selected the first entry.
	SelectionMode	Gets or sets the selection mode of the table control. The default is Extended (multi-select with modifier).
	SortFunction	Gets or sets the default sort function associated with the table control.

Methods

	Name	Description
	Dispose()	(Inherited from IDisposable.)
	ForceUpdateAsync()	Force the table control to begin an update (which may not happen immediately).
	GetFilter(String^)	Get the filter for the specified <keyif it exists, or null if there is no corresponding filter.
	RefreshUI()	Force the elements in the table to be redrawn (because, for example, the user changed a setting that changes the way file names are displayed).
	SelectAll()	Selects all entries.
	SetFilter(String^, IEntryFilter^)	Set the filter for the specified key.
	SubscribeToDataSource(ITableDataSource^)	Start subscribing to the ITableEntry objects produced by a ITableDataSource.
	UnselectAll()	Clears all the selections.
	UnsubscribeFromDataSource(ITableDataSource^)	Stop subscribing to the specified ITableDataSource.

Events

	Name	Description
	EntriesChanged	Raised (on the thread that created the control) after the controls entries have changed.
	FiltersChanged	Raised whenever the table's filter is changed via SetFilter.
	PreEntriesChanged	Raised before the control entries have changed.

Remarks

All methods on this interface, unless otherwise marked, can be called from any thread. All events raised by this interface will be raised on the same thread that created the table control.