JsonValueExtensionsTryGetEnumTEnum(JsonValue, Boolean, TEnum, String, JsonValueType) Method

Tries to get the specified JsonValue as TEnum if expectedType is Undefined or matches the Type property of the specified json parameter.

Definition

Namespace: KGySoft.Json
Assembly: KGySoft.Json (in KGySoft.Json.dll) Version: 3.0.0

public static bool TryGetEnum<TEnum>(
	this JsonValue json,
	bool ignoreFormat,
	out TEnum value,
	string? flagsSeparator = null,
	JsonValueType expectedType = JsonValueType.Undefined
)
where TEnum : struct, new()

<ExtensionAttribute>
Public Shared Function TryGetEnum(Of TEnum As {Structure, New}) ( 
	json As JsonValue,
	ignoreFormat As Boolean,
	<OutAttribute> ByRef value As TEnum,
	Optional flagsSeparator As String = Nothing,
	Optional expectedType As JsonValueType = JsonValueType.Undefined
) As Boolean

C++

public:
[ExtensionAttribute]
generic<typename TEnum>
where TEnum : value class, gcnew()
static bool TryGetEnum(
	JsonValue json, 
	bool ignoreFormat, 
	[OutAttribute] TEnum% value, 
	String^ flagsSeparator = nullptr, 
	JsonValueType expectedType = JsonValueType::Undefined
)

[<ExtensionAttribute>]
static member TryGetEnum : 
        json : JsonValue * 
        ignoreFormat : bool * 
        value : 'TEnum byref * 
        ?flagsSeparator : string * 
        ?expectedType : JsonValueType 
(* Defaults:
        let _flagsSeparator = defaultArg flagsSeparator null
        let _expectedType = defaultArg expectedType JsonValueType.Undefined
*)
-> bool  when 'TEnum : struct, new()

Parameters

json JsonValue: The JsonValue to be converted to TEnum.
ignoreFormat Boolean: to remove underscores or hyphens, and ignore case when parsing the value; otherwise, .
value TEnum: When this method returns, the result of the conversion, if json could be converted; otherwise, the default value of TEnum. This parameter is passed uninitialized.
flagsSeparator String (Optional): Specifies the separator if the json value consists of multiple flags. This parameter is optional.
Default value: , which uses the default "," separator.
expectedType JsonValueType (Optional): The expected Type of the specified json parameter, or Undefined to allow any type. This parameter is optional.
Default value: Undefined.

Type Parameters

TEnum: The type of the enumeration. Must be an Enum type.

Return Value

Boolean
if the specified JsonValue could be converted; otherwise, .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type JsonValue. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).