JsonValueExtensionsGetDateTimeOrDefault(JsonValue, JsonDateTimeFormat, NullableDateTimeKind, JsonValueType) Method

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

Definition

Namespace: KGySoft.Json
Assembly: KGySoft.Json (in KGySoft.Json.dll) Version: 3.0.0
C#
public static DateTime GetDateTimeOrDefault(
	this JsonValue json,
	JsonDateTimeFormat format,
	DateTimeKind? desiredKind,
	JsonValueType expectedType = JsonValueType.Undefined
)

Parameters

json  JsonValue
The JsonValue to be converted to DateTime.
format  JsonDateTimeFormat
A JsonDateTimeFormat value that specifies the format of the date-time value in the JsonValue.
desiredKind  NullableDateTimeKind
The desired value of the Kind property of the returned DateTime instance, or to preserve the one that could be retrieved from the JsonValue. Converting between Utc and Local affects the actual time value, while changing to or from Unspecified just changes the Kind property without converting the value.
expectedType  JsonValueType  (Optional)
The expected Type of the specified json parameter, or Undefined to allow any type. This parameter is optional.
Default value: Undefined.

Return Value

DateTime
A DateTime value if json could be converted; otherwise, DateTime.MinValue, which is the default value of DateTime.

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

See Also