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

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.

Extension of the ITableEntriesSnapshot that allows an entry provider to override the default behavior for what gets displayed for an entry in a particular column.

public interface class IWpfTableEntriesSnapshot : IDisposable, Microsoft::VisualStudio::Shell::TableManager::ITableEntriesSnapshot

[System.CLSCompliant(false)]
public interface IWpfTableEntriesSnapshot : IDisposable, Microsoft.VisualStudio.Shell.TableManager.ITableEntriesSnapshot

public interface IWpfTableEntriesSnapshot : IDisposable, Microsoft.VisualStudio.Shell.TableManager.ITableEntriesSnapshot

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

type IWpfTableEntriesSnapshot = interface
    interface ITableEntriesSnapshot
    interface IDisposable

Public Interface IWpfTableEntriesSnapshot
Implements IDisposable, ITableEntriesSnapshot

Derived: Microsoft.VisualStudio.Shell.TableControl.WpfTableEntriesSnapshotBase

Attributes: CLSCompliantAttribute

Implements: ITableEntriesSnapshot IDisposable

Remarks

The TryCreate...() methods for entries are called before using the equivalent method from the column definition.

Properties

Count	Number of entries in this snapshot. (Inherited from ITableEntriesSnapshot)
VersionNumber	Get the version number associated with the snapshot. (Inherited from ITableEntriesSnapshot)

Methods

CanCreateDetailsContent(Int32)	Indicates whether the virtual entry at position `index` has details content that can be displayed.
IndexOf(Int32, ITableEntriesSnapshot)	Returns the index of the entry at `currentIndex` in this snapshot in a later snapshot (`newSnapshot`). (Inherited from ITableEntriesSnapshot)
StartCaching()	Hint to the snapshot that there will be a lot of access to the snapshot's data. (Inherited from ITableEntriesSnapshot)
StopCaching()	Hint to the snapshot that the snapshot's entries will no longer be accessed. (Inherited from ITableEntriesSnapshot)
TryCreateColumnContent(Int32, String, Boolean, FrameworkElement)	Get the FrameworkElement for the virtual entry at position `index` and `columnName`.
TryCreateDetailsContent(Int32, FrameworkElement)	Get the details content for the virtual entry `index` so that it can be displayed in the table control.
TryCreateDetailsStringContent(Int32, String)	Get the string equivalent of the details content for the virtual entry `index` (used for search and copy and paste).
TryCreateImageContent(Int32, String, Boolean, ImageMoniker)	Get the ImageMoniker for the virtual entry at position `index` and `columnName`.
TryCreateStringContent(Int32, String, Boolean, Boolean, String)	Get the String for the virtual entry at position `index` and `columnName`.
TryCreateToolTip(Int32, String, Object)	Get the tooltip for the entry and `columnName`.
TryGetValue(Int32, String, Object)	Get the data for the `keyName` of the entry at `index`. (Inherited from ITableEntriesSnapshot)

Applies to

Share via