Note

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

Access to this page requires authorization. You can try .

JsonPropertyNameAttribute Class

Definition

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

Specifies the property name that is present in the JSON when serializing and deserializing.

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

Remarks

The specified property name overrides any naming policy specified by JsonNamingPolicy.

For more information, see Customize individual property names.

Constructors

Name Description
JsonPropertyNameAttribute(String)

Initializes a new instance of JsonPropertyNameAttribute with the specified property name.

Properties

Name Description
Name

Gets the name of the property.
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?