Class JsonProperty

Namespace

Newtonsoft.Json.Serialization

Assembly

Newtonsoft.Json.dll

Maps a JSON property to a .NET member or constructor parameter.

public class JsonProperty

Inheritance

object

JsonProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

JsonProperty()

public JsonProperty()

Properties

Converter

Gets or sets the JsonConverter for the property. If set this converter takes presidence over the contract converter for the property type.

public JsonConverter Converter { get; set; }

Property Value

JsonConverter

The converter.

DeclaringType

Gets or sets the type that declared this property.

public Type DeclaringType { get; set; }

Property Value

Type

The type that declared this property.

DefaultValue

Gets the default value.

public object DefaultValue { get; set; }

Property Value

object

The default value.

DefaultValueHandling

Gets the property default value handling.

public DefaultValueHandling? DefaultValueHandling { get; set; }

Property Value

DefaultValueHandling?

The default value handling.

GetIsSpecified

Gets or sets a predicate used to determine whether the property should be serialized.

public Predicate<object> GetIsSpecified { get; set; }

Property Value

Predicate<object>

A predicate used to determine whether the property should be serialized.

Ignored

Gets a value indicating whether this JsonProperty is ignored.

public bool Ignored { get; set; }

Property Value

bool

true if ignored; otherwise, false.

IsReference

Gets a value indicating whether this property preserves object references.

public bool? IsReference { get; set; }

Property Value

bool?

true if this instance is reference; otherwise, false.

MemberConverter

Gets the member converter.

public JsonConverter MemberConverter { get; set; }

Property Value

JsonConverter

The member converter.

NullValueHandling

Gets the property null value handling.

public NullValueHandling? NullValueHandling { get; set; }

Property Value

NullValueHandling?

The null value handling.

ObjectCreationHandling

Gets the property object creation handling.

public ObjectCreationHandling? ObjectCreationHandling { get; set; }

Property Value

ObjectCreationHandling?

The object creation handling.

Order

Gets or sets the order of serialization and deserialization of a member.

public int? Order { get; set; }

Property Value

int?

The numeric order of serialization or deserialization.

PropertyName

Gets or sets the name of the property.

public string PropertyName { get; set; }

Property Value

string

The name of the property.

PropertyType

Gets or sets the type of the property.

public Type PropertyType { get; set; }

Property Value

Type

The type of the property.

Readable

Gets a value indicating whether this JsonProperty is readable.

public bool Readable { get; set; }

Property Value

bool

true if readable; otherwise, false.

ReferenceLoopHandling

Gets the property reference loop handling.

public ReferenceLoopHandling? ReferenceLoopHandling { get; set; }

Property Value

ReferenceLoopHandling?

The reference loop handling.

Required

Gets a value indicating whether this JsonProperty is required.

public Required Required { get; set; }

Property Value

Required

A value indicating whether this JsonProperty is required.

SetIsSpecified

Gets or sets an action used to set whether the property has been deserialized.

public Action<object, object> SetIsSpecified { get; set; }

Property Value

Action<object, object>

An action used to set whether the property has been deserialized.

ShouldSerialize

Gets or sets a predicate used to determine whether the property should be serialize.

public Predicate<object> ShouldSerialize { get; set; }

Property Value

Predicate<object>

A predicate used to determine whether the property should be serialize.

TypeNameHandling

Gets or sets the type name handling.

public TypeNameHandling? TypeNameHandling { get; set; }

Property Value

TypeNameHandling?

The type name handling.

UnderlyingName

Gets or sets the name of the underlying member or parameter.

public string UnderlyingName { get; set; }

Property Value

string

The name of the underlying member or parameter.

ValueProvider

Gets the IValueProvider that will get and set the JsonProperty during serialization.

public IValueProvider ValueProvider { get; set; }

Property Value

IValueProvider

The IValueProvider that will get and set the JsonProperty during serialization.

Writable

Gets a value indicating whether this JsonProperty is writable.

public bool Writable { get; set; }

Property Value

bool

true if writable; otherwise, false.

Methods

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.