SettingsExtensibility Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility

Assembly:: Microsoft.VisualStudio.Extensibility.dll

Package:: Microsoft.VisualStudio.Extensibility v17.11.350

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.

Provides the surface area for settings.

public sealed class SettingsExtensibility : Microsoft.VisualStudio.Extensibility.ExtensibilityPoint

type SettingsExtensibility = class
    inherit ExtensibilityPoint

Public NotInheritable Class SettingsExtensibility
Inherits ExtensibilityPoint

Inheritance: Object

ExtensibilityPoint
SettingsExtensibility

Properties

IsDisposed	Gets a value indicating whether the object is disposed. (Inherited from ExtensibilityPoint)
LocalServiceProvider	Gets the local service provider. (Inherited from ExtensibilityPoint)
ResourceDictionary	Gets the resource dictionary instance for querying localized strings. (Inherited from ExtensibilityPoint)
ServiceBroker	Gets the underlying service broker instance. (Inherited from ExtensibilityPoint)
ServiceBrokerClient	Gets the service broker client instance that can be used to query for brokered services. (Inherited from ExtensibilityPoint)
TraceSource	Gets the trace source instance to utilize for logging. (Inherited from ExtensibilityPoint)

Methods

Dispose()	(Inherited from ExtensibilityPoint)
Dispose(Boolean)	Disposes the instane and underlying proxies. (Inherited from ExtensibilityPoint)
ReadEffectiveValueAsync<T>(Setting+ObjectArray, CancellationToken)	Reads the effective value of `setting`.
ReadEffectiveValueAsync<T>(Setting<T>, CancellationToken)	Reads the effective value of `setting`.
ReadEffectiveValueAsync<T>(SettingIdentifier<T>, CancellationToken)	Reads the effective value of a setting.
ReadEffectiveValuesAsync(IReadOnlyCollection<Setting>, CancellationToken)	Reads the effective values of multiple settings.
ReadEffectiveValuesAsync(IReadOnlyCollection<SettingCategory>, CancellationToken)	Reads the effective values of multiple settings.
ReadEffectiveValuesAsync(IReadOnlyCollection<String>, CancellationToken)	Reads the effective values of multiple settings having known setting identifiers.
SubscribeAsync(IReadOnlyCollection<Setting>, CancellationToken, Action<SettingValues>)	Subscribes to receive updates when the values of settings is changed.
SubscribeAsync(IReadOnlyCollection<SettingCategory>, CancellationToken, Action<SettingValues>)	Subscribes to receive updates when the values of settings is changed.
SubscribeAsync(IReadOnlyCollection<SettingIdentifier>, CancellationToken, Action<SettingValues>)	Subscribes to receive updates when the values of settings is changed.
SubscribeAsync<T>(Setting+ObjectArray, CancellationToken, Action<SettingValue<T[]>>)	Subscribes to receive updates when the values of a setting is changed.
SubscribeAsync<T>(Setting<T>, CancellationToken, Action<SettingValue<T>>)	Subscribes to receive updates when the values of a setting is changed.
SubscribeAsync<T>(SettingIdentifier<T>, CancellationToken, Action<SettingValue<T>>)	Subscribes to receive updates when the values of a setting is changed.
ThrowIfDisposed()	Throws if object is disposed. (Inherited from ExtensibilityPoint)
WriteAsync(Action<SettingsWriteBatch>, String, CancellationToken)	Starts a batch write of multiple setting values, allowing to add multiple write operations to it.

Events

Disposing

Raised when object is being disposed.

(Inherited from ExtensibilityPoint)

Applies to

Share via