IWpfTableControl Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.TableControl

Assemblies:: Microsoft.VisualStudio.Shell.Framework.dll, Microsoft.VisualStudio.Shell.Immutable.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Framework.dll

Package:: Microsoft.VisualStudio.Shell.Framework v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Important

This API is not CLS-compliant.

Interface for displaying and managing a data as a table.

public interface class IWpfTableControl : IDisposable

[System.CLSCompliant(false)]
public interface IWpfTableControl : IDisposable

public interface IWpfTableControl : IDisposable

[<System.CLSCompliant(false)>]
type IWpfTableControl = interface
    interface IDisposable

type IWpfTableControl = interface
    interface IDisposable

Public Interface IWpfTableControl
Implements IDisposable

Derived: Microsoft.VisualStudio.Shell.TableControl.IWpfTableControl2

Microsoft.VisualStudio.Shell.TableControl.IWpfTableControl3

Microsoft.VisualStudio.Shell.TableControl.IWpfTableControl4

Attributes: CLSCompliantAttribute

Implements: IDisposable

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.

Properties

AutoSubscribe	Indicates whether this table control will automatically subscribe to all data sources added to its Manager.
ColumnDefinitionManager	Gets the ITableColumnDefinitionManager use by this (and every other) IWpfTableControl.
ColumnStates	A snapshot of the current column states.
Control	The WPF control that displays the data from the activated ITableDataSources.
Entries	Gets the entries displayed in the control.
Manager	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 the we return whatever item is the underlying WPF controls considers 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/sets the selection mode of the table control. Default is Extended (multi-select with modifier).
SortFunction	Gets/sets the default sort function associated with the table control.

Methods

ForceUpdateAsync()	Force the table control to begin an update (which may not happen immediately).
GetFilter(String)	Get the filter for the specified `key` if 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 ITableEntrys produced by a ITableDataSource.
UnselectAll()	Clears all the selection.
UnsubscribeFromDataSource(ITableDataSource)	Stop subscribing to the specified ITableDataSource.

Events

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.

Applies to