SettingsProvider Class

Provides settings storage for ASCOM device drivers. Settings are persisted in the ASCOM Device Profile store.

Definition

Namespace: ASCOM
Assembly: ASCOM.SettingsProvider (in ASCOM.SettingsProvider.dll) Version: 7.1.3+4851.c5da65c2b
C#
public class SettingsProvider : SettingsProvider
Inheritance
Object    ProviderBase    SettingsProvider    SettingsProvider

Remarks

Original version by Tim Long, March 2009. Copyright © 2009 TiGra Astronomy, all rights reserved. http://www.tigranetworks.co.uk/Astronomy

Constructors

SettingsProvider Initializes a new instance of the SettingsProvider class with the default profile provider Profile.
SettingsProvider(IProfile) Initializes a new instance of the SettingsProvider class with the supplied Profile Provider. This is useful for injecting a mock profile object during unit testing.

Properties

ApplicationName Gets the name of the driver or application for which settings are being managed. This value is set during provider initialization and cannot be changed thereafter.
(Overrides SettingsProviderApplicationName)
Description Gets the provider's friendly description.
(Overrides ProviderBaseDescription)
Name Returns the provider's friendly name used during configuration.
(Overrides ProviderBaseName)

Methods

GetPropertyValues Retrieves a collection of settings values from the underlying ASCOM Profile store.
(Overrides SettingsProviderGetPropertyValues(SettingsContext, SettingsPropertyCollection))
Initialize Initializes the ASCOM Settings Provider.
SetPropertyValues Persists a collection of settings values to the underlying ASCOM Profile store.
(Overrides SettingsProviderSetPropertyValues(SettingsContext, SettingsPropertyValueCollection))

See Also