NamespaceSystemLibrary.Common.Net.Attributes SystemLibrary.Common.Net.dll

Decorate Enum Key with text

EnumTextAttribute

[AttributeUsage(AttributeTargets.Field, AllowMultiple = false)] public class EnumTextAttribute : Attribute

Inheritance

System.Object

System.Attribute

EnumTextAttribute

Examples

X

enum Color 
{
    [EnumText("Black Colored Text")]
    Black,
    White
}

var color = Color.Black;

var value = color.ToText();

var value2 = Color.White.ToText();

// 'value' is now "Black Colored Text"
// 'value2' is now "White", 
// Note: .ToText() falls back to ToString() of the enum key

var value = Color.White.GetEnumText();
// 'value' is now null, as White does not contain EnumTextAttribute

var value = Color.Black.GetEnumText();
// 'value' is now a string with value 'Black Colored Text' as 'Black' has the EnumTextAttribute

Arguments

X

Constructors

public EnumTextAttribute(string text = null)

X

Methods arguments

Type	Name	Description
System.String	text	Set additional text metadata for the Enum key

Fields

public string Text

X

Field Value

Type	Description
System.String

Extension Methods

ObjectExtensions.Json(Object, Boolean)

ObjectExtensions.Json(Object, JsonSerializerOptions, Boolean, JsonConverter[])

ObjectExtensions.Json(Object, JsonConverter[])

}