ISettingsManagerHost Interface
Definition
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.
Functionality provided by the application that creates an ISettingsManager via CreateInstance(ISettingsManagerHost).
public interface class ISettingsManagerHostpublic interface class ISettingsManagerHost__interface ISettingsManagerHostpublic interface ISettingsManagerHosttype ISettingsManagerHost = interfacePublic Interface ISettingsManagerHost- Derived
Properties
| AppDir |
Gets the application directory |
| AppInitCompletionTask |
Optional task indicating the host is finished starting. The settings manager will defer resource-intensive tasks until after this task completes. |
| 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. |
| Logger |
A logger for error telemetry. |
| NameTranslator |
Optional translator between private and shared setting names. |
| PrivateStorage |
The backing store for private settings. |
| 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. |
Methods
| IsSharedOrRoamedSetting(String) |
Determines whether a setting is private vs. shared/roamed. |
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. |
| IdleStateChanged |
Raised when the host application goes idle or becomes active again, to enable reduced resource usage during the idle period. |