SettingsProperty Class

 

Used internally as the class that represents metadata about an individual configuration property.

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

System.Object
  System.Configuration.SettingsProperty

Public Class SettingsProperty

NameDescription
System_CAPS_pubmethodSettingsProperty(SettingsProperty)

Initializes a new instance of the SettingsProperty class, based on the supplied parameter.

System_CAPS_pubmethodSettingsProperty(String)

Initializes a new instance of the SettingsProperty class. based on the supplied parameter.

System_CAPS_pubmethodSettingsProperty(String, Type, SettingsProvider, Boolean, Object, SettingsSerializeAs, SettingsAttributeDictionary, Boolean, Boolean)

Creates a new instance of the SettingsProperty class based on the supplied parameters.

NameDescription
System_CAPS_pubpropertyAttributes

Gets a SettingsAttributeDictionary object containing the attributes of the SettingsProperty object.

System_CAPS_pubpropertyDefaultValue

Gets or sets the default value of the SettingsProperty object.

System_CAPS_pubpropertyIsReadOnly

Gets or sets a value specifying whether a SettingsProperty object is read-only.

System_CAPS_pubpropertyName

Gets or sets the name of the SettingsProperty.

System_CAPS_pubpropertyPropertyType

Gets or sets the type for the SettingsProperty.

System_CAPS_pubpropertyProvider

Gets or sets the provider for the SettingsProperty.

System_CAPS_pubpropertySerializeAs

Gets or sets a SettingsSerializeAs object for the SettingsProperty.

System_CAPS_pubpropertyThrowOnErrorDeserializing

Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully deserialized.

System_CAPS_pubpropertyThrowOnErrorSerializing

Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully serialized.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

SettingsProperty is used to describe settings properties of a class derived from SettingsBase. The Settings API allows a collection of settings properties to be grouped into a common language runtime class.

When persisting settings, the SettingsBase base class asks for a collection of SettingsProperty objects, grouped in a collection of type SettingsPropertyCollection. It does this by calling its own Properties member. Inherited classes should return a collection of properties to persist.

Each SettingsProperty object includes metadata about the property, including the following:

  • Name.

  • Default value.

  • Property type.

  • Serialization method.

  • Provider to use for persistence.

  • Other arbitrary attributes that are context and provider specific.

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: