JsonIncludeAttribute Class

Definition

Namespace:

System.Text.Json.Serialization

Assembly:

System.Text.Json.dll

Source:

JsonIncludeAttribute.cs

Indicates that the member should be included for serialization and deserialization.

public ref class JsonIncludeAttribute sealed : System::Text::Json::Serialization::JsonAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class JsonIncludeAttribute : System.Text.Json.Serialization.JsonAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)>]
type JsonIncludeAttribute = class
    inherit JsonAttribute

Public NotInheritable Class JsonIncludeAttribute
Inherits JsonAttribute

Inheritance

Object

Attribute

JsonAttribute

JsonIncludeAttribute

Attributes

AttributeUsageAttribute

Remarks

When applied to a property, this attribute indicates that non-public getters and setters can be used for serialization and deserialization.

Note

Even with this attribute, the serialization source generator is still limited to non-public members that are accessible to the generated code. Accessible non-public members include those that are:

• internal when in the same assembly as the generated context.
• protected, protected internal, or private protected when the generated context is in a class that derives from the type.
• private if the type is nested in the same class as the generated context.

In .NET 6 and .NET 7, non-public properties aren't supported.

Constructors

JsonIncludeAttribute()

Initializes a new instance of JsonIncludeAttribute.

Properties

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)