JsonSerializer.SerializeToElement Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
| SerializeToElement(Object, Type, JsonSerializerContext) |
Converts the provided value into a JsonElement. |
| SerializeToElement(Object, JsonTypeInfo) |
Converts the provided value into a JsonElement. |
| SerializeToElement(Object, Type, JsonSerializerOptions) |
Converts the provided value into a JsonElement. |
| SerializeToElement<TValue>(TValue, JsonSerializerOptions) |
Converts the provided value into a JsonElement. |
| SerializeToElement<TValue>(TValue, JsonTypeInfo<TValue>) |
Converts the provided value into a JsonElement. |
Converts the provided value into a JsonElement.
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.JsonElementPublic Function SerializeToElement (value As Object, inputType As Type, context As JsonSerializerContext) As JsonElementParameters
- value
- Object
The value to convert.
- inputType
- Type
The type of the value to convert.
- context
- JsonSerializerContext
A metadata provider for serializable types.
Returns
A JsonElement representation of the value.
Exceptions
There is no compatible JsonConverter for inputType or its serializable members.
The GetTypeInfo(Type) method of the provided context returns null for the type to convert.
inputType or context is null.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | 6, 7, 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10 |
| .NET Standard | 2.0 (package-provided) |
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.JsonElementPublic Function SerializeToElement (value As Object, jsonTypeInfo As JsonTypeInfo) As JsonElementParameters
- value
- Object
The value to convert.
- jsonTypeInfo
- JsonTypeInfo
Metadata about the type to convert.
Returns
A JsonElement representation of the value.
Exceptions
jsonTypeInfo is null.
value does not match the type of jsonTypeInfo.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10 |
| .NET Standard | 2.0 (package-provided) |
Converts the provided value into a JsonElement.
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.JsonElementPublic Function SerializeToElement (value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing) As JsonElementParameters
- value
- Object
The value to convert.
- inputType
- Type
The type of the value to convert.
- options
- JsonSerializerOptions
Options to control the conversion behavior.
Returns
A JsonElement representation of the value.
Exceptions
inputType is not compatible with value.
inputType is null.
There is no compatible JsonConverter for inputType or its serializable members.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | 6, 7, 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10 |
| .NET Standard | 2.0 (package-provided) |
Converts the provided value into a JsonElement.
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.JsonElementPublic Function SerializeToElement(Of TValue) (value As TValue, Optional options As JsonSerializerOptions = Nothing) As JsonElementType 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
A JsonElement representation of the JSON value.
Exceptions
There is no compatible JsonConverter for TValue or its serializable members.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | 6, 7, 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10 |
| .NET Standard | 2.0 (package-provided) |
Converts the provided value into a JsonElement.
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.JsonElementPublic Function SerializeToElement(Of TValue) (value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue)) As JsonElementType 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
A JsonElement representation of the value.
Exceptions
There is no compatible JsonConverter for TValue or its serializable members.
jsonTypeInfo is null.
Applies to
.NET 10 and other versions
| Product | Versions |
|---|---|
| .NET | 6, 7, 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10 |
| .NET Standard | 2.0 (package-provided) |
.NET feedback
.NET is an open source project. Select a link to provide feedback: