CapyKit/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md
Jordan Wages 87bd044b31 Settings Helper + Documentation
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer.

Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
2024-04-22 18:28:21 -05:00

5.4 KiB

EnumerationAttribute<T> Class

Custom attribute class for decorating enumeration fields with additional data.

Definition

Namespace: CapyKit.Attributes
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0

C#

[AttributeUsageAttribute(AttributeTargets.Field)]
public abstract class EnumerationAttribute<T> : Attribute

F#

[<AbstractClassAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Field)>]
type EnumerationAttribute<'T> = 
    class
        inherit Attribute
    end
InheritanceObjectAttribute → EnumerationAttribute(T)
DerivedCapyKit.Attributes.EnumerationDescriptionAttribute

Type Parameters

Generic type parameter allowing for arbitrary declarations and assignments of meaning.

Constructors

EnumerationAttribute(T) Gets the value of the enumeration represented by this attribute.

Properties

TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)
Value Initializes a new instance of the EnumerationAttribute(T) class with a specified value.

Methods

Equals Returns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
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)
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
ToString Returns a string that represents the current object.
(Inherited from Object)

See Also

Reference

CapyKit.Attributes Namespace