JsonSerializer.SerializeToElement Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-preview.3.24172.9

Overloads

SerializeToElement(Object, JsonTypeInfo)	Converts the provided value into a JsonElement.
SerializeToElement(Object, Type, JsonSerializerOptions)	Converts the provided value into a JsonDocument.
SerializeToElement(Object, Type, JsonSerializerContext)	Converts the provided value into a JsonDocument.
SerializeToElement<TValue>(TValue, JsonTypeInfo<TValue>)	Converts the provided value into a JsonDocument.
SerializeToElement<TValue>(TValue, JsonSerializerOptions)	Converts the provided value into a JsonDocument.

SerializeToElement(Object, JsonTypeInfo)

Source:

JsonSerializer.Write.Element.cs

Converts the provided value into a JsonElement.

public:
 static System::Text::Json::JsonElement SerializeToElement(System::Object ^ value, System::Text::Json::Serialization::Metadata::JsonTypeInfo ^ jsonTypeInfo);

public static System.Text.Json.JsonElement SerializeToElement (object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo);

static member SerializeToElement : obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo -> System.Text.Json.JsonElement

Public Function SerializeToElement (value As Object, jsonTypeInfo As JsonTypeInfo) As JsonElement

Parameters

value

Object

The value to convert.

jsonTypeInfo

JsonTypeInfo

Metadata about the type to convert.

Returns

JsonElement

A JsonElement representation of the value.

Exceptions

ArgumentNullException

jsonTypeInfo is null.

InvalidCastException

value does not match the type of jsonTypeInfo.

SerializeToElement(Object, Type, JsonSerializerOptions)

Source:

JsonSerializer.Write.Element.cs

Converts the provided value into a JsonDocument.

public static System.Text.Json.JsonElement SerializeToElement (object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default);

static member SerializeToElement : obj * Type * System.Text.Json.JsonSerializerOptions -> System.Text.Json.JsonElement

Public Function SerializeToElement (value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing) As JsonElement

Parameters

value

Object

The value to convert.

inputType

Type

The type of the value to convert.

options

JsonSerializerOptions

Options to control the conversion behavior.

Returns

JsonElement

A JsonDocument representation of the value.

Exceptions

ArgumentException

inputType is not compatible with value.

ArgumentNullException

inputType is null.

NotSupportedException

There is no compatible JsonConverter for inputType or its serializable members.

SerializeToElement(Object, Type, JsonSerializerContext)

Source:

JsonSerializer.Write.Element.cs

Converts the provided value into a JsonDocument.

public:
 static System::Text::Json::JsonElement SerializeToElement(System::Object ^ value, Type ^ inputType, System::Text::Json::Serialization::JsonSerializerContext ^ context);

public static System.Text.Json.JsonElement SerializeToElement (object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context);

static member SerializeToElement : obj * Type * System.Text.Json.Serialization.JsonSerializerContext -> System.Text.Json.JsonElement

Public Function SerializeToElement (value As Object, inputType As Type, context As JsonSerializerContext) As JsonElement

Parameters

value

Object

The value to convert.

inputType

Type

The type of the value to convert.

context

JsonSerializerContext

A metadata provider for serializable types.

Returns

JsonElement

A JsonDocument representation of the value.

Exceptions

NotSupportedException

There is no compatible JsonConverter for inputType or its serializable members.

InvalidOperationException

The GetTypeInfo(Type) method of the provided context returns null for the type to convert.

ArgumentNullException

inputType or context is null.

SerializeToElement<TValue>(TValue, JsonTypeInfo<TValue>)

Source:

JsonSerializer.Write.Element.cs

Converts the provided value into a JsonDocument.

public:
generic <typename TValue>
 static System::Text::Json::JsonElement SerializeToElement(TValue value, System::Text::Json::Serialization::Metadata::JsonTypeInfo<TValue> ^ jsonTypeInfo);

public static System.Text.Json.JsonElement SerializeToElement<TValue> (TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo);

static member SerializeToElement : 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> -> System.Text.Json.JsonElement

Public Function SerializeToElement(Of TValue) (value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue)) As JsonElement

Type Parameters

TValue

The type of the value to serialize.

Parameters

value

TValue

The value to convert.

jsonTypeInfo

JsonTypeInfo<TValue>

Metadata about the type to convert.

Returns

JsonElement

A JsonDocument representation of the value.

Exceptions

NotSupportedException

There is no compatible JsonConverter for TValue or its serializable members.

ArgumentNullException

jsonTypeInfo is null.

SerializeToElement<TValue>(TValue, JsonSerializerOptions)

Source:

JsonSerializer.Write.Element.cs

Converts the provided value into a JsonDocument.

public static System.Text.Json.JsonElement SerializeToElement<TValue> (TValue value, System.Text.Json.JsonSerializerOptions? options = default);

static member SerializeToElement : 'Value * System.Text.Json.JsonSerializerOptions -> System.Text.Json.JsonElement

Public Function SerializeToElement(Of TValue) (value As TValue, Optional options As JsonSerializerOptions = Nothing) As JsonElement

Type Parameters

TValue

The type of the value to serialize.

Parameters

value

TValue

The value to convert.

options

JsonSerializerOptions

Options to control the conversion behavior.

Returns

JsonElement

A JsonDocument representation of the JSON value.

Exceptions

NotSupportedException

There is no compatible JsonConverter for TValue or its serializable members.