nuget server logo nuget api documents
↑

API Docs / Microsoft.VisualBasic.Runtime / EnumHelpers

EnumHelpers

Full name Microsoft.VisualBasic.EnumHelpers Assembly Microsoft.VisualBasic.Runtime Members 7

01 Syntax

Microsoft.VisualBasic.EnumHelpers

02 Methods

NameOverloadsSummary
GetAllEnumFlags 1 Get array value from the input flaged enum value.
GetAllEnumFlags 2 Get array value from the input flaged enum enumValue.
Enums 1 Enumerate all of the enum values in the specific Enum type data.
Description 1 Get the description data from a enum type value, if the target have no DescriptionAttribute attribute data then function will return the string value from the ToString() functio…
Enums 1
FlagCombinationDescription 1

03 Members

method GetAllEnumFlags #
GetAllEnumFlags``1(``0)

Get array value from the input flaged enum value.

Type Parameters
NameDescription
T
Parameters
NameTypeDescription
value``0

-

method GetAllEnumFlags #
GetAllEnumFlags(Enum, Type)

Get array value from the input flaged enum enumValue.

method Enums #
Enums``1

Enumerate all of the enum values in the specific Enum type data. (只允许枚举类型,其他的都返回空集合)

Type Parameters
NameDescription
T

泛型类型约束只允许枚举类型,其他的都返回空集合

method Description #
Description(Enum, String)

Get the description data from a enum type value, if the target have no DescriptionAttribute attribute data then function will return the string value from the ToString() function.

Remarks

this extension function has an internal cache table for get the description text of a given enum value

Parameters
NameTypeDescription
valueEnum

-

deliString

a delimiter string for join multiple flag enumeration value theirs enum string

Returns

this function always returns a non-null string value:

for thoese enum member which it has been tagged with DescriptionAttribute, the description data string will returns from this function; otherwise the string value from the enum member its toString() function will be returned.

method GetAllEnumFlags overload 2 #
GetAllEnumFlags(T)
method Enums #
Enums()
method FlagCombinationDescription #
FlagCombinationDescription(Int64, Type, String)