ObservableSettingsListBase<TValue> Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.12.40392

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.

A base type for observable ISettingsList instances of strongly-typed values.

generic <typename ValueT>
 where ValueT : class, IComparable<ValueT>public ref class ObservableSettingsListBase abstract

generic <typename TValue>
 where TValue : class, IComparable<TValue>public ref class ObservableSettingsListBase abstract

public abstract class ObservableSettingsListBase<ValueT> where ValueT : class, IComparable<ValueT>

public abstract class ObservableSettingsListBase<TValue> where TValue : class, IComparable<TValue>

type ObservableSettingsListBase<'ValueT (requires 'ValueT : null and 'ValueT :> IComparable<'ValueT>)> = class

type ObservableSettingsListBase<'Value (requires 'Value : null and 'Value :> IComparable<'Value>)> = class

Public MustInherit Class ObservableSettingsListBase(Of ValueT)

Public MustInherit Class ObservableSettingsListBase(Of TValue)

Type Parameters

ValueT TValue

Inheritance: Object
ObservableSettingsListBase<TValue>

Derived: Microsoft.VisualStudio.Shell.CodeContainerManagement.CodeContainerRegistry

Microsoft.VisualStudio.Shell.CodeContainerManagement.RemoteCodeContainerRegistry

Constructors

ObservableSettingsListBase<TValue>(ISettingsManager)

Fields

CompletedTask

Properties

Capacity
IsRoamed	A flag that indicates whether the underlying settings list will be roamed to other devices or not.
Recycle
SettingsList	The actual settings list where the Code Container data is persisted.
SettingsListName	Determines the name of the ISettingsList the Registry will employ to store its data.

Methods

AddOrUpdateAsync(String, ValueT, Object, CancellationToken)	Adds or updates `value` to the Registry under the supplied `key`.
AddToFrontAsync(String, ValueT, Object)
ClearAsync(Object, CancellationToken)	Clears all keys and values stored on the list.
ClearAsync(Object)
CodeContainerSettingsList_CollectionChangedAsync(Object, SettingsListChangedEventArgs)	An event-handler that is fired whenever changes to the underlying ISettingsList maintained by the Registry are made.
GetAsync(String, CancellationToken)	Retrieves the Code Container associated with `key` if any. Returns null otherwise.
GetValueOrDefault(String)
PurgeIfNecessaryAsync(Object, CancellationToken)	Removes a fixed number of the least-accessed values to keep the underlying ISettingsList from growing indefinitely.
RemoveAsync(String, Object, CancellationToken)	Removes the value stored under the supplied `key` if any.
RemoveAsync(String, Object)
SubscribeAsync(ITargetBlock<StatefulReadOnlyList<ValueT,Object>>, CancellationToken)	Allows `targetBlock` to receive updates of the list of items stored on the list and receive up-to-date versions of it whenever it gets modified.
SuspendUpdatesAsync()	Suspends sending updates to any subscribed observers. This is useful in case multiple changes are made to the list cause it keeps the list from pushing updates to subscribers every single time a change is made. Any updates made to the underlying list during suspension will cause an up-to-date copy to be pushed to subscribers as soon as suspensions are disposed of.

Applies to

Partager via