KGy SOFT Core Libraries Help
EnumTEnumParse(String, String, Boolean) Method
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(
string value,
string? separator = ",",
bool ignoreCase = false
)VB
Public Shared Function Parse (
value As String,
Optional separator As String = ",",
Optional ignoreCase As Boolean = false
) As TEnumC++
public:
static TEnum Parse(
String^ value,
String^ separator = L",",
bool ignoreCase = false
)F#
static member Parse :
value : string *
?separator : string *
?ignoreCase : bool
(* Defaults:
let _separator = defaultArg separator ","
let _ignoreCase = defaultArg ignoreCase false
*)
-> 'TEnum Parameters
- value String
- The string representation of the enumerated value or values to parse.
- separator String (Optional)
- In case of more values specified the separator among the values. If or is empty, then comma (,) separator is used. This parameter is optional.
Default value: , - 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 . |
| ArgumentException | value cannot be parsed as TEnum. |