C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.Properties.SharedSettingsProvider Class Reference

A SettingsProvider that can be shared by both the AnalyzeRe.Client library, and users of the library like the Excel add-in. Allows switching between the (default) LocalFileSettingsProvider and a registry settings provider which also shares settings entries between applications. Set API.UseRegistrySettings to enable the shared registry provider. More...

Public Types

enum  SettingsLocation { Registry , NativeLocalFile }
 Allows configuration of the internal settings provider used by instances of this class. More...
 

Public Member Functions

 SharedSettingsProvider ()
 Constructs a new instance of the SharedSettingsProvider, using the configuration to determine which settings provider to delegate to. Should not be explicitly instantiated, but is created by the System.Configuration settings infrastructure.
 
override SettingsPropertyValueCollection GetPropertyValues (SettingsContext context, SettingsPropertyCollection collection)
 Returns the collection of settings property values for the specified application instance and settings property group.
 
override void Initialize (string name, NameValueCollection config)
 Recall initialization parameters so that we can appropriately initialize whichever provider we toggle use behind the scenes as needed.
 
override void SetPropertyValues (SettingsContext context, SettingsPropertyValueCollection collection)
 Sets the values of the specified group of property settings.
 

Static Public Attributes

static SettingsLocation GlobalSettingsLocation = SettingsLocation.Registry
 Sets the location.
 

Properties

override string ApplicationName [get, set]
 
override string Description [get]
 
override string Name [get]
 

Detailed Description

A SettingsProvider that can be shared by both the AnalyzeRe.Client library, and users of the library like the Excel add-in. Allows switching between the (default) LocalFileSettingsProvider and a registry settings provider which also shares settings entries between applications. Set API.UseRegistrySettings to enable the shared registry provider.

Definition at line 14 of file SharedSettingsProvider.cs.

Inheritance diagram for AnalyzeRe.Properties.SharedSettingsProvider:

Member Enumeration Documentation

◆ SettingsLocation

Allows configuration of the internal settings provider used by instances of this class.

Enumerator
Registry 

Enables storing persistent user settings in the registry (instead of a user.config file). All applications that use the client library will share settings values stored in the registry.

NativeLocalFile 

Uses the default system settings provider, which creates a configuration file on disk in a someone ambiguous location. For details, see https://msdn.microsoft.com/en-us/library/aa730869%28v=vs.80%29.aspx.

Definition at line 17 of file SharedSettingsProvider.cs.

Constructor & Destructor Documentation

◆ SharedSettingsProvider()

AnalyzeRe.Properties.SharedSettingsProvider.SharedSettingsProvider ( )
inline

Constructs a new instance of the SharedSettingsProvider, using the configuration to determine which settings provider to delegate to. Should not be explicitly instantiated, but is created by the System.Configuration settings infrastructure.

Definition at line 95 of file SharedSettingsProvider.cs.

Member Function Documentation

◆ GetPropertyValues()

override SettingsPropertyValueCollection AnalyzeRe.Properties.SharedSettingsProvider.GetPropertyValues ( SettingsContext  context,
SettingsPropertyCollection  collection 
)
inline

Returns the collection of settings property values for the specified application instance and settings property group.

Definition at line 120 of file SharedSettingsProvider.cs.

◆ Initialize()

override void AnalyzeRe.Properties.SharedSettingsProvider.Initialize ( string  name,
NameValueCollection  config 
)
inline

Recall initialization parameters so that we can appropriately initialize whichever provider we toggle use behind the scenes as needed.

Definition at line 103 of file SharedSettingsProvider.cs.

◆ SetPropertyValues()

override void AnalyzeRe.Properties.SharedSettingsProvider.SetPropertyValues ( SettingsContext  context,
SettingsPropertyValueCollection  collection 
)
inline

Sets the values of the specified group of property settings.

Definition at line 129 of file SharedSettingsProvider.cs.

Member Data Documentation

◆ GlobalSettingsLocation

SettingsLocation AnalyzeRe.Properties.SharedSettingsProvider.GlobalSettingsLocation = SettingsLocation.Registry
static

Sets the location.

Definition at line 31 of file SharedSettingsProvider.cs.

Property Documentation

◆ ApplicationName

override string AnalyzeRe.Properties.SharedSettingsProvider.ApplicationName
getset

Definition at line 83 of file SharedSettingsProvider.cs.

◆ Description

override string AnalyzeRe.Properties.SharedSettingsProvider.Description
get

Definition at line 80 of file SharedSettingsProvider.cs.

◆ Name

override string AnalyzeRe.Properties.SharedSettingsProvider.Name
get

Definition at line 77 of file SharedSettingsProvider.cs.


The documentation for this class was generated from the following file: