Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

JsonIgnoreCondition Enum

Definition

Namespace:
System.Text.Json.Serialization
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v11.0.0-preview.5.26302.115
Source:
JsonIgnoreCondition.cs
Source:
JsonIgnoreCondition.cs
Source:
JsonIgnoreCondition.cs
Source:
ThrowHelper.Node.cs

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.

Controls how the JsonIgnoreAttribute ignores properties on serialization and deserialization.

public enum class JsonIgnoreCondition
public enum JsonIgnoreCondition
type JsonIgnoreCondition = 
Public Enum JsonIgnoreCondition
Inheritance
JsonIgnoreCondition

Fields

Name Value Description
Never 0

Property is always serialized and deserialized, regardless of IgnoreNullValues configuration.

Always 1

Property is always ignored.

WhenWritingDefault 2

Property is ignored only if it equals the default value for its type.

WhenWritingNull 3

Property is ignored if its value is null. This is applied only to reference-type properties and fields.

WhenWriting 4

Property is ignored during serialization

WhenReading 5

Property is ignored during deserialization

Applies to


Feedback

Was this page helpful?