EncryptSettingAttribute Class

Represents an attribute that determines if a property or field in a class derived from CategorizedSettingsBase or AppSettingsBase should be encrypted when it is serialized to the configuration file.

Inheritance Hierarchy

SystemObject
SystemAttribute
GSF.ConfigurationEncryptSettingAttribute

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 EncryptSettingAttribute : Attribute

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

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

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

GSF.Configuration.EncryptSettingAttribute = function();

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

View Source

The EncryptSettingAttribute type exposes the following members.

Constructors

	Name	Description
	EncryptSettingAttribute	Creates a new EncryptSettingAttribute; defaults to Encrypt = true.
	EncryptSettingAttribute(Boolean)	Creates a new EncryptSettingAttribute with the specified encrypt value.

Top

Properties

	Name	Description
	Encrypt	Gets or sets flag that determines if the property or field this EncryptSettingAttribute modifies should be encrypted when serialized to the configuration file.
	PrivateKey	Gets or sets optional encryption key that will be used on a setting for added security.
	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

Reference

GSF.Configuration Namespace