JsonValueExtensionsGetEnumOrDefaultTEnum(JsonValue, Boolean, String, JsonValueType) Method

Gets the specified JsonValue as TEnum if expectedType is Undefined or matches the Type property of the specified json parameter and it can be converted to TEnum; otherwise, returns the default value of TEnum.

Definition

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

C#

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

VB

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

C++

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

F#

[<ExtensionAttribute>]
static member GetEnumOrDefault : 
        json : JsonValue * 
        ignoreFormat : bool * 
        flagsSeparator : string * 
        ?expectedType : JsonValueType 
(* Defaults:
        let _expectedType = defaultArg expectedType JsonValueType.Undefined
*)
-> 'TEnum  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, .
flagsSeparator String: Specifies the separator character if the json value consists of multiple flags.
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

TEnum
A TEnum value if json could be converted; otherwise, the default value of TEnum.

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).