ApplicationSettingsBase.Item[String] Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

ApplicationSettingsBase.cs

Gets or sets the value of the specified application settings property.

public:
 virtual property System::Object ^ default[System::String ^] { System::Object ^ get(System::String ^ propertyName); void set(System::String ^ propertyName, System::Object ^ value); };

public override object this[string propertyName] { get; set; }

member this.Item(string) : obj with get, set

Default Public Overrides Property Item(propertyName As String) As Object

Parameters

propertyName

String

A String containing the name of the property to access.

Property Value

Object

If found, the value of the named settings property; otherwise, null.

Exceptions

SettingsPropertyNotFoundException

There are no properties associated with the current wrapper or the specified property could not be found.

SettingsPropertyIsReadOnlyException

An attempt was made to set a read-only property.

SettingsPropertyWrongTypeException

The value supplied is of a type incompatible with the settings property, during a set operation.

ConfigurationErrorsException

The configuration file could not be parsed.

Remarks

The Item[] property, also known as the indexer, is routinely used in the settings wrapper class derived from ApplicationSettingsBase. Item[] binds the public property of the wrapper class to the corresponding settings property.

Item[] raises several events depending on the operation being performed:

• The first time a property is retrieved, the SettingsLoaded event is raised.

• When a property is set, the OnSettingChanging event is raised. If the handler does not cancel the event, then the property value is set and the PropertyChanged event is raised.

See also

• Properties
• IsReadOnly