Note

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

Access to this page requires authorization. You can try .

JsonIgnoreAttribute Class

Definition

Namespace:
System.Text.Json.Serialization
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v11.0.0-preview.5.26302.115
Source:
JsonIgnoreAttribute.cs
Source:
JsonIgnoreAttribute.cs
Source:
JsonIgnoreAttribute.cs
Source:
JsonIgnoreAttribute.cs
Source:
JsonIgnoreAttribute.cs
Source:
JsonIgnoreAttribute.cs
Source:
JsonIgnoreAttribute.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.

Prevents a property from being serialized or deserialized.

public ref class JsonIgnoreAttribute sealed : System::Text::Json::Serialization::JsonAttribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class JsonIgnoreAttribute : System.Text.Json.Serialization.JsonAttribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Property | System.AttributeTargets.Struct, AllowMultiple=false)]
public sealed class JsonIgnoreAttribute : System.Text.Json.Serialization.JsonAttribute
[System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class JsonIgnoreAttribute : System.Text.Json.Serialization.JsonAttribute
[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)>]
type JsonIgnoreAttribute = class
 inherit JsonAttribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Property | System.AttributeTargets.Struct, AllowMultiple=false)>]
type JsonIgnoreAttribute = class
 inherit JsonAttribute
[<System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)>]
type JsonIgnoreAttribute = class
 inherit JsonAttribute
Public NotInheritable Class JsonIgnoreAttribute
Inherits JsonAttribute
Inheritance
JsonIgnoreAttribute
Attributes

Remarks

For more information, see How to ignore properties with System.Text.Json.

Constructors

Name Description
JsonIgnoreAttribute()

Initializes a new instance of JsonIgnoreAttribute.

Properties

Name Description
Condition

Gets or sets the condition that must be met before a property will be ignored.
TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Name Description
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)

Applies to

Feedback

Was this page helpful?