ITableEntriesSnapshot Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.TableManager

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.

An abstraction for a fixed set of ITableEntrys.

public interface class ITableEntriesSnapshot : IDisposable

public interface ITableEntriesSnapshot : IDisposable

type ITableEntriesSnapshot = interface
    interface IDisposable

Public Interface ITableEntriesSnapshot
Implements IDisposable

Derived: Microsoft.VisualStudio.Shell.TableControl.IWpfTableEntriesSnapshot

Microsoft.VisualStudio.Shell.TableControl.WpfTableEntriesSnapshotBase

Microsoft.VisualStudio.Shell.TableManager.TableEntriesSnapshotBase

Implements: IDisposable

Remarks

A ITableEntriesSnapshot and its virtual entries must be immutable and callable from any thread. The one exception is that the snapshot's Dispose() method will be called when the snapshot is no longer being used (at which point there should not be any calls to get data from the snapshot or its entries).

Properties

Count	Number of entries in this snapshot.
VersionNumber	Get the version number associated with the snapshot.

Methods

IndexOf(Int32, ITableEntriesSnapshot)	Returns the index of the entry at `currentIndex` in this snapshot in a later snapshot (`newSnapshot`).
StartCaching()	Hint to the snapshot that there will be a lot of access to the snapshot's data.
StopCaching()	Hint to the snapshot that the snapshot's entries will no longer be accessed.
TryGetValue(Int32, String, Object)	Get the data for the `keyName` of the entry at `index`.

Applies to

Share via