C# Class GSF.Configuration.CategorizedSettingsSection

Represents a section in the config file with one or more CategorizedSettingsElementCollection representing categories, each containing one or more CategorizedSettingsElement objects representing settings under a specific category.

Inheritance: System.Configuration.ConfigurationSection

Exibir arquivo Open project: GridProtectionAlliance/gsf

Private Properties

Property	Type	Description

Public Methods

Method	Description
CategorizedSettingsSection ( ) : System	Creates a new CategorizedSettingsSection.
Remove ( string name ) : void	Removes the specified category name including its associated settings.
SetCryptoKey ( string cryptoKey ) : void	Sets the key to be used for encrypting and decrypting setting values.
this ( string name ) : GSF.Configuration.CategorizedSettingsElementCollection	Gets the CategorizedSettingsElementCollection object representing settings under the specified category name.

Protected Methods

Method	Description
DeserializeSection ( XmlReader reader ) : void	Reads XML from the configuration file.
SerializeSection ( ConfigurationElement parentElement, string name, ConfigurationSaveMode saveMode ) : string	Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.

Method Details

CategorizedSettingsSection() public method

Creates a new CategorizedSettingsSection.

public CategorizedSettingsSection ( ) : System
return	System

DeserializeSection() protected method

Reads XML from the configuration file.

protected DeserializeSection ( XmlReader reader ) : void
reader	XmlReader	The object, which reads from the configuration file.
return	void

Remove() public method

Removes the specified category name including its associated settings.

is null or empty string.

public Remove ( string name ) : void
name	string	Name of the category to be removed.
return	void

SerializeSection() protected method

Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.

protected SerializeSection ( ConfigurationElement parentElement, string name, ConfigurationSaveMode saveMode ) : string
parentElement	System.Configuration.ConfigurationElement	The instance to use as the parent when performing the un-merge.
name	string	The name of the section to create.
saveMode	ConfigurationSaveMode	The instance to use when writing to a string.
return	string

SetCryptoKey() public method

Sets the key to be used for encrypting and decrypting setting values.

public SetCryptoKey ( string cryptoKey ) : void
cryptoKey	string	New crypto key.
return	void

this() public method

Gets the CategorizedSettingsElementCollection object representing settings under the specified category name.

is null or empty string.

public this ( string name ) : GSF.Configuration.CategorizedSettingsElementCollection
name	string	Name of the category whose settings are to be retrieved.
return	GSF.Configuration.CategorizedSettingsElementCollection