C# Class ClearCanvas.Common.Configuration.SettingsStoreSettingsProvider

Communicates with an ISettingsStore to manage loading and saving of settings from the store.
Supports the framework and is not intended for use by application code. Use StandardSettingsProvider instead.
Inheritance: System.Configuration.SettingsProvider, IApplicationSettingsProvider, ISharedApplicationSettingsProvider
Show file Open project: jasper-yeh/ClearCanvas

Public Methods

Method Description
CanUpgradeSharedPropertyValues ( SettingsContext context ) : bool
GetPreviousSharedPropertyValues ( SettingsContext context, SettingsPropertyCollection properties, string ignoredPreviousExeConfigFilename ) : SettingsPropertyValueCollection
GetPreviousVersion ( SettingsContext context, SettingsProperty property ) : SettingsPropertyValue

Not implemented.
GetPropertyValues ( SettingsContext context, SettingsPropertyCollection props ) : SettingsPropertyValueCollection

Returns the collection of settings property values for the specified application instance and settings property group.
GetSharedPropertyValues ( SettingsContext context, SettingsPropertyCollection properties ) : SettingsPropertyValueCollection
Reset ( SettingsContext context ) : void

Resets all settings back to the defaults.

Note that this implementation resets the user-scoped settings only. It does not modify application-scoped settings.

SetPropertyValues ( SettingsContext context, SettingsPropertyValueCollection settings ) : void

Sets the values of the specified group of property settings.
SetSharedPropertyValues ( SettingsContext context, SettingsPropertyValueCollection values ) : void
SettingsStoreSettingsProvider ( ISettingsStore store ) : System
Upgrade ( SettingsContext context, SettingsPropertyCollection properties ) : void

Upgrades the settings from a previous version.

Note that this implementation upgrades user-scoped settings only; it does not modify application-scoped settings.

UpgradeSharedPropertyValues ( SettingsContext context, SettingsPropertyCollection properties, string previousExeConfigFilename ) : void

Private Methods

Method Description
AnyUserScoped ( SettingsPropertyCollection properties ) : bool
GetPreviousSettingsValues ( SettingsGroupDescriptor group, string user, string settingsKey ) : string>.Dictionary
GetPropertyValues ( SettingsContext context, SettingsPropertyCollection properties, bool returnPrevious ) : SettingsPropertyValueCollection
GetSettingsValues ( SettingsPropertyCollection properties, string>.IDictionary storedValues ) : SettingsPropertyValueCollection
GetSharedPropertyValues ( SettingsGroupDescriptor group, string settingsKey, SettingsPropertyCollection properties ) : SettingsPropertyValueCollection
IsUserScoped ( SettingsProperty property ) : bool
SetPropertyValues ( SettingsContext context, SettingsPropertyValueCollection settings, string user ) : void
Upgrade ( SettingsContext context, SettingsPropertyCollection properties, string user ) : void

Method Details

CanUpgradeSharedPropertyValues() public method

public CanUpgradeSharedPropertyValues ( SettingsContext context ) : bool
context System.Configuration.SettingsContext
return bool

GetPreviousSharedPropertyValues() public method

public GetPreviousSharedPropertyValues ( SettingsContext context, SettingsPropertyCollection properties, string ignoredPreviousExeConfigFilename ) : SettingsPropertyValueCollection
context System.Configuration.SettingsContext
properties System.Configuration.SettingsPropertyCollection
ignoredPreviousExeConfigFilename string
return System.Configuration.SettingsPropertyValueCollection

GetPreviousVersion() public method

Not implemented.
public GetPreviousVersion ( SettingsContext context, SettingsProperty property ) : SettingsPropertyValue
context System.Configuration.SettingsContext
property System.Configuration.SettingsProperty
return System.Configuration.SettingsPropertyValue

GetPropertyValues() public method

Returns the collection of settings property values for the specified application instance and settings property group.
public GetPropertyValues ( SettingsContext context, SettingsPropertyCollection props ) : SettingsPropertyValueCollection
context System.Configuration.SettingsContext
props System.Configuration.SettingsPropertyCollection
return System.Configuration.SettingsPropertyValueCollection

GetSharedPropertyValues() public method

public GetSharedPropertyValues ( SettingsContext context, SettingsPropertyCollection properties ) : SettingsPropertyValueCollection
context System.Configuration.SettingsContext
properties System.Configuration.SettingsPropertyCollection
return System.Configuration.SettingsPropertyValueCollection

Reset() public method

Resets all settings back to the defaults.
Note that this implementation resets the user-scoped settings only. It does not modify application-scoped settings.
public Reset ( SettingsContext context ) : void
context System.Configuration.SettingsContext
return void

SetPropertyValues() public method

Sets the values of the specified group of property settings.
public SetPropertyValues ( SettingsContext context, SettingsPropertyValueCollection settings ) : void
context System.Configuration.SettingsContext
settings System.Configuration.SettingsPropertyValueCollection
return void

SetSharedPropertyValues() public method

public SetSharedPropertyValues ( SettingsContext context, SettingsPropertyValueCollection values ) : void
context System.Configuration.SettingsContext
values System.Configuration.SettingsPropertyValueCollection
return void

SettingsStoreSettingsProvider() public method

public SettingsStoreSettingsProvider ( ISettingsStore store ) : System
store ISettingsStore
return System

Upgrade() public method

Upgrades the settings from a previous version.
Note that this implementation upgrades user-scoped settings only; it does not modify application-scoped settings.
public Upgrade ( SettingsContext context, SettingsPropertyCollection properties ) : void
context System.Configuration.SettingsContext
properties System.Configuration.SettingsPropertyCollection
return void

UpgradeSharedPropertyValues() public method

public UpgradeSharedPropertyValues ( SettingsContext context, SettingsPropertyCollection properties, string previousExeConfigFilename ) : void
context System.Configuration.SettingsContext
properties System.Configuration.SettingsPropertyCollection
previousExeConfigFilename string
return void