KGy SOFT Core Libraries Help
EnumTEnumParse(String
Converts the string representation of the name or numeric value of one or more enumerated values to an equivalent enumerated object.
Definition
Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
The parsed enum value.
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
C#
public static TEnum Parse(
StringSegment value,
StringSegment separator = default,
bool ignoreCase = false
)VB
Public Shared Function Parse (
value As StringSegment,
Optional separator As StringSegment = Nothing,
Optional ignoreCase As Boolean = false
) As TEnumC++
public:
static TEnum Parse(
StringSegment value,
StringSegment separator = StringSegment(),
bool ignoreCase = false
)F#
static member Parse :
value : StringSegment *
?separator : StringSegment *
?ignoreCase : bool
(* Defaults:
let _separator = defaultArg separator new StringSegment()
let _ignoreCase = defaultArg ignoreCase false
*)
-> 'TEnum Parameters
- value StringSegment
- The string representation of the enumerated value or values to parse.
- separator StringSegment (Optional)
- In case of more values specified the separator among the values. If Null or Empty, then comma (,) separator is used. This parameter is optional.
Default value: Null. - ignoreCase Boolean (Optional)
- If , ignores case; otherwise, regards case. This parameter is optional.
Default value: .
Return Value
TEnumThe parsed enum value.
Exceptions
| ArgumentNullException | value is Null. |
| ArgumentException | value cannot be parsed as TEnum. |