Click or drag to resize

SettingNameAttribute Class

Represents an attribute that defines the setting name of a property or field in a class derived from CategorizedSettingsBase or AppSettingsBase when serializing the value to the configuration file.
Inheritance Hierarchy
SystemObject
  SystemAttribute
    GSF.ConfigurationSettingNameAttribute

Namespace: GSF.Configuration
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field)]
public sealed class SettingNameAttribute : Attribute
View Source

The SettingNameAttribute type exposes the following members.

Constructors
 NameDescription
Public methodSettingNameAttribute Creates a new SettingNameAttribute with the specified names value.
Top
Properties
 NameDescription
Public propertyName Gets the name used to serialize field or property into config file.
Public propertyNames Gets the names used to serialize field or property into config file.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)
Top
Methods
 NameDescription
Public methodEqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
Public methodGetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
Remarks
This attribute allows consumers to override the name of the setting going into the configuration file, if the attribute doesn't exist the property or field name is used.
See Also