Class EnumerationMetadataAttribute

Associates enumeration field description information with a target element. This class cannot be inherited.

Inheritance

System.Object

System.Attribute

EnumerationMetadataAttribute

Implements

System.IComparable

Inherited Members

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.IsDefaultAttribute()

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.Module, System.Type)

System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.Match(System.Object)

System.Attribute.TypeId

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Argotic.Common

Assembly: Argotic.Common.dll

Syntax

[AttributeUsage(AttributeTargets.Field, Inherited = false, AllowMultiple = false)]
[Serializable]
public sealed class EnumerationMetadataAttribute : Attribute, IComparable

Constructors

| Improve this Doc View Source

EnumerationMetadataAttribute()

Initializes a new instance of the EnumerationMetadataAttribute class.

Declaration

public EnumerationMetadataAttribute()

Properties

| Improve this Doc View Source

AlternateValue

Gets or sets the alternate textual value for the attributed field.

Declaration

public string AlternateValue { get; set; }

Property Value

Type	Description
System.String	The alternate textual value for the attributed field.

| Improve this Doc View Source

DisplayName

Gets or sets the display name for the attributed field.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String	The display name for the attributed field.

Methods

| Improve this Doc View Source

CompareTo(Object)

Compares the current instance with another object of the same type.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object to compare with this instance.

Returns

Type	Description
System.Int32	A 32-bit signed integer that indicates the relative order of the objects being compared.

Exceptions

Type	Condition
System.ArgumentException	The `obj` is not the expected System.Type.

| Improve this Doc View Source

Equals(Object)

Determines whether the specified System.Object is equal to the current instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The System.Object to compare with the current instance.

Returns

Type	Description
System.Boolean	true if the specified System.Object is equal to the current instance; otherwise, false.

Overrides

System.Attribute.Equals(System.Object)

| Improve this Doc View Source

GetHashCode()

Returns a hash code for the current instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A 32-bit signed integer hash code.

Overrides

System.Attribute.GetHashCode()

| Improve this Doc View Source

ToString()

Returns a System.String that represents the current EnumerationMetadataAttribute.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current EnumerationMetadataAttribute.

Overrides

System.Object.ToString()

Remarks

This method returns a human-readable string for the current instance.

Operators

| Improve this Doc View Source

Equality(EnumerationMetadataAttribute, EnumerationMetadataAttribute)

Determines if operands are equal.

Declaration

public static bool operator ==(EnumerationMetadataAttribute first, EnumerationMetadataAttribute second)

Parameters

Type	Name	Description
EnumerationMetadataAttribute	first	Operand to be compared.
EnumerationMetadataAttribute	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the values of its operands are equal, otherwise; false.

| Improve this Doc View Source

GreaterThan(EnumerationMetadataAttribute, EnumerationMetadataAttribute)

Determines if first operand is greater than second operand.

Declaration

public static bool operator>(EnumerationMetadataAttribute first, EnumerationMetadataAttribute second)

Parameters

Type	Name	Description
EnumerationMetadataAttribute	first	Operand to be compared.
EnumerationMetadataAttribute	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is greater than the second, otherwise; false.

| Improve this Doc View Source

Inequality(EnumerationMetadataAttribute, EnumerationMetadataAttribute)

Determines if operands are not equal.

Declaration

public static bool operator !=(EnumerationMetadataAttribute first, EnumerationMetadataAttribute second)

Parameters

Type	Name	Description
EnumerationMetadataAttribute	first	Operand to be compared.
EnumerationMetadataAttribute	second	Operand to compare to.

Returns

Type	Description
System.Boolean	false if its operands are equal, otherwise; true.

| Improve this Doc View Source

LessThan(EnumerationMetadataAttribute, EnumerationMetadataAttribute)

Determines if first operand is less than second operand.

Declaration

public static bool operator <(EnumerationMetadataAttribute first, EnumerationMetadataAttribute second)

Parameters

Type	Name	Description
EnumerationMetadataAttribute	first	Operand to be compared.
EnumerationMetadataAttribute	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is less than the second, otherwise; false.

Implements

System.IComparable