SettingsBase.Item Property

Gets or sets the value of the specified settings property.

Namespace: System.Configuration
Assembly: System (in system.dll)

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

/** @property */
public void set_Item (String propertyName, Object value)

Not applicable.

Parameters

propertyName

A String containing the name of the property to access.

Property Value

If found, the value of the named settings property.

Exception typeCondition

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.

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.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: