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.181-beta

Syntax

C++

JavaScript

Copy

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field)]
public sealed class SettingNameAttribute : Attribute

<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field)>
Public NotInheritable Class SettingNameAttribute
	Inherits Attribute

[AttributeUsageAttribute(AttributeTargets::Property|AttributeTargets::Field)]
public ref class SettingNameAttribute sealed : public Attribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field)>]
type SettingNameAttribute = 
    class
        inherit Attribute
    end

GSF.Configuration.SettingNameAttribute = function();

Type.createClass(
	'GSF.Configuration.SettingNameAttribute',
	Attribute);

View Source

The SettingNameAttribute type exposes the following members.

Constructors

	Name	Description
	SettingNameAttribute	Creates a new SettingNameAttribute with the specified names value.

Top

Properties

	Name	Description
	Name	Gets the name used to serialize field or property into config file.
	Names	Gets the names used to serialize field or property into config file.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	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.

Reference

GSF.Configuration Namespace