SettingsBase.Item[String] Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

SettingsBase.cs

Gets or sets the value of the specified 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 virtual object this[string propertyName] { get; set; }

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

Default Public Overridable 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.

Exceptions

SettingsPropertyNotFoundException

There are no properties associated with the current object, 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.

Remarks

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

The first time a property is accessed, the SettingsBase instance will find all other properties that share the same provider as the requested property. The SettingsBase instance will then call the provider, passing it the set of SettingsProperty objects that represent the data the provider should retrieve.

Note that the indexer will get and set property data in a thread-safe manner if IsSynchronized is true. A SettingsBase instance by default is not thread safe. However, you can call Synchronized, passing in a SettingsBase instance to make the SettingsBase indexer operate in a thread-safe manner.

See also

• IsReadOnly