ISettingsManagerHost4 Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Settings

Assembly:: Microsoft.VisualStudio.Utilities.dll

Package:: Microsoft.VisualStudio.Utilities 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.

public interface class ISettingsManagerHost4 : Microsoft::VisualStudio::Settings::ISettingsManagerHost3

public interface ISettingsManagerHost4 : Microsoft.VisualStudio.Settings.ISettingsManagerHost3

type ISettingsManagerHost4 = interface
    interface ISettingsManagerHost3
    interface ISettingsManagerHost2
    interface ISettingsManagerHost

Public Interface ISettingsManagerHost4
Implements ISettingsManagerHost3

Derived: Microsoft.VisualStudio.Settings.ISettingsManagerHost5

Implements: ISettingsManagerHost ISettingsManagerHost2 ISettingsManagerHost3

Properties

AppDir	Gets the application directory (Inherited from ISettingsManagerHost)
AppInitCompletionTask	Optional task indicating the host is finished starting. The settings manager will defer resource-intensive tasks until after this task completes. (Inherited from ISettingsManagerHost)
CollectionName	Gets the name of the settings collection to be addressed by this host. This is used to partition settings based on host parameters like VS's /rootSuffix parameter. (Inherited from ISettingsManagerHost)
DurableHostIdentity	Additional process infomation. Use to add context to the log, does not need to follow any specific format.
IsRoamingEnabledByDefault	Gets a value indicating whether roaming and sharing should be enabled when the "RoamingEnabled" setting hasn't been persisted yet.
Logger	A logger for error telemetry. (Inherited from ISettingsManagerHost)
NameTranslator	Optional translator between private and shared setting names. (Inherited from ISettingsManagerHost)
PrivateStorage	The backing store for private settings. (Inherited from ISettingsManagerHost)
RemoteDefaultsStore	The remote defaults store to override setting defaults. (Inherited from ISettingsManagerHost3)
StoreUpdateLogger	A logger for recording updates to setting stores. May be null.
TelemetrySettings	Obsolete. Gets the serialized telemetry settings from the host, obtained via ITelemetrySession.SerializeSettings. This may be null if the host has no telemetry session. (Inherited from ISettingsManagerHost)

Methods

GetTelemetrySettingsAsync()	Gets the serialized telemetry settings from the host, obtained via ITelemetrySession.SerializeSettings. The result may be null if the host has no telemetry session. (Inherited from ISettingsManagerHost2)
IsSharedOrRoamedSetting(String)	Determines whether a setting is private vs. shared/roamed. (Inherited from ISettingsManagerHost)

Events

HostShuttingDown	Raised when the host is about to shut down, to give the settings manager an opportunity to release resources, finish or cancel async tasks, etc. The host should wait until the async event handler is complete (e.g. using the RaiseEventAsync<T>(Delegate, Object, T) extension method) before continuing. (Inherited from ISettingsManagerHost)
IdleStateChanged	Obsolete. Raised when the host application goes idle or becomes active again, to enable reduced resource usage during the idle period. (Inherited from ISettingsManagerHost)

Applies to

Share via