ISettingsManagerHost Interface

Visual Studio 2015
 

Functionality provided by the application that creates an ISettingsManager viaSettingsManagerFactory.CreateInstance.

Namespace:   Microsoft.VisualStudio.Settings
Assembly:  Microsoft.VisualStudio.Utilities (in Microsoft.VisualStudio.Utilities.dll)

public interface ISettingsManagerHost

NameDescription
System_CAPS_pubpropertyAppInitCompletionTask

Optional task indicating the host is finished starting. The settings manager will defer resource-intensive tasks until after this task completes.

System_CAPS_pubpropertyLogger

Gets a logger for error telemetry.

System_CAPS_pubpropertyNameTranslator

Gets an optional translator between private and shared setting names.

System_CAPS_pubpropertyPrivateStorage

Gets the backing store for private settings.

NameDescription
System_CAPS_pubmethodIsSharedOrRoamedSetting(String)

Determines whether a setting is private vs. shared/roamed.

System_CAPS_pubmethodRetrieveHubService()

Provides the hub service for the settings manager to communicate with the VS hub for sharing and roaming settings.

NameDescription
System_CAPS_pubeventHostShuttingDown

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 theRaiseEventAsync<T> extension method) before continuing.

System_CAPS_pubeventIdleStateChanged

Raised when the host application goes idle or becomes active again, to enable reduced resource usage during the idle period.

Return to top
Show: