Config Class

Provide an access to the configuration.

Inheritance Hierarchy

SystemObject
AskiaPortalCmn.ConfigurationConfig

Namespace: AskiaPortalCmn.Configuration
Assembly: AskiaPortalCmn (in AskiaPortalCmn.dll) Version: 1.7.0-build068

Syntax

C++

Copy

public class Config : IConfig, IEnumerable<IConfigItem>, 
	IEnumerable

Public Class Config
	Implements IConfig, IEnumerable(Of IConfigItem), 
	IEnumerable

public ref class Config : IConfig, IEnumerable<IConfigItem^>, 
	IEnumerable

The Config type exposes the following members.

Properties

	Name	Description
	EnvironmentMode	Current environment mode
	ItemConfigKey	Get the configuration item in the `askiaportal` namespace
	ItemString, NullableGuid	Get the configuration item of the specified module.
	MainDatabase	Get the connection of the main SQL database
	RootPath	Get the root path of the configuration directory
	SqlLocalDbInstanceName	Instance name of the SQLLocalDB for the tests
	TestDatabase	Get or set the connection of the test SQL database
	TestLicensesKey	Get the licenses key for the unit tests.

Top

Methods

	Name	Description
	ApplyRecordedChanges	Save configuration item that has been changed since the initialization, and reload the configuration in order to make the changes visible.
	Contains	Indicates if the specified item is contains in the configuration of the specified module.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindAllReferences(ValueReference, Guid)	Get the list of configuration item that refers to the specified item.
	FindAllReferences(ValueReference, Int32)	Get the list of configuration item that refers to the specified item.
	GetConfigFileContent	Read the configuration file and return his content in dictionary format
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInstance	Get the single instance of the configuration
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RecordChange(IContext, ConfigKey, Boolean)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, ConfigKey, Double)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, ConfigKey, Guid)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, ConfigKey, Int32)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, ConfigKey, String)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, String, Boolean, NullableGuid)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, String, Double, NullableGuid)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, String, Guid, NullableGuid)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, String, Int32, NullableGuid)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	RecordChange(IContext, String, String, NullableGuid)	Record a new value for the specified configuration item. It will not apply the change in the configuration, nor save in the database unless you explicitly call the ApplyRecordedChanges(IContext) method.
	Reload	Reload the configuration using the current database values.
	SetEnvironment	Indicates which environment is currently used.
	SetTestDatabase	Override the connection string of the test database
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UseSqlLocalDbForTests	Usage of the SQLLocalDB for the Test environment. https://docs.microsoft.com/en-us/sql/tools/sqllocaldb-utility

Top

Remarks

Singleton object, use the GetInstance to instantiate it.

It open the AskiaPortal.config store in ProgramData\AskiaPortal folder.

Examples

The content of the config file should looks like this:

Copy

<configuration version="1.0"><askiaportalcmn><settings key="mainDatabase" value="Data Source=[SERVER];Initial Catalog=AskiaPortal;Persist Security Info=True;User ID=[USER_ID];Password=[PASSWORD];" /></askiaportalcmn></configuration>

Examples

Basic usage:

Copy

using AskiaPortalCmn.Configuration;

// ...
var config = Config.GetInstance();
Console.WriteLine("The path of the AskiaPortal configuration directory is `{0}`", config.RootPath);
Console.WriteLine("The connection string of the main database (AskiaPortal) is `{0}`", config.MainDatabase);

Reference

AskiaPortalCmn.Configuration Namespace