TcHmiJsonSerializer Class

Provides methods to serialize instances of any type from the TcHmiSrv.Core namespace to JSON Strings and back.

Inheritance Hierarchy

SystemObject
  JsonSerializer
    TcHmiSrv.Core.Tools.Json.NewtonsoftTcHmiJsonSerializer

Namespace: TcHmiSrv.Core.Tools.Json.Newtonsoft
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

public class TcHmiJsonSerializer : JsonSerializer

The TcHmiJsonSerializer type exposes the following members.

Constructors

 

Name

Description

TcHmiJsonSerializer Class 1:

TcHmiJsonSerializer

Initializes a new instance of the TcHmiJsonSerializer class

Properties

 

Name

Description

TcHmiJsonSerializer Class 2:

TcHmiJsonSerializer Class 3:

AdvancedJsonConverters

Gets a JsonConverterCollection that contains the default JsonConverter s with advanced conversions enabled.

TcHmiJsonSerializer Class 4:

Binder

Gets or sets the SerializationBinder used by the serializer when resolving type names.
(Inherited from JsonSerializer)
Obsolete

TcHmiJsonSerializer Class 5:

CheckAdditionalContent

Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. The default value is false.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 6:

ConstructorHandling

Gets or sets how constructors are used during deserialization. The default value is Default.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 7:

Context

Gets or sets the StreamingContext used by the serializer when invoking serialization callback methods.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 8:

ContractResolver

Gets or sets the contract resolver used by the serializer when serializing .NET objects to JSON and vice versa.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 9:

Converters

Gets a collection JsonConverter that will be used during serialization.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 10:

Culture

Gets or sets the culture used when reading JSON. The default value is InvariantCulture.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 11:

DateFormatHandling

Gets or sets how dates are written to JSON text. The default value is IsoDateFormat.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 12:

DateFormatString

Gets or sets how DateTime and DateTimeOffset values are formatted when writing JSON text, and the expected date format when reading JSON text. The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK".
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 13:

DateParseHandling

Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. The default value is DateTime.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 14:

DateTimeZoneHandling

Gets or sets how DateTime time zones are handled during serialization and deserialization. The default value is RoundtripKind.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 15:

TcHmiJsonSerializer Class 16:

DefaultAdvancedJsonConverters

Gets a JsonConverterCollection that contains the default JsonConverter s with advanced conversions enabled.
Obsolete

TcHmiJsonSerializer Class 17:

TcHmiJsonSerializer Class 18:

DefaultJsonConverters

Gets a JsonConverterCollection that contains the default JsonConverter s.

TcHmiJsonSerializer Class 19:

TcHmiJsonSerializer Class 20:

DefaultSettings

Gets the default JsonSerializerSettings .

TcHmiJsonSerializer Class 21:

TcHmiJsonSerializer Class 22:

DefaultSettingsWithAdvancedConverters

Gets the default JsonSerializerSettings with the AdvancedJsonConverters.

TcHmiJsonSerializer Class 23:

TcHmiJsonSerializer Class 24:

DefaultSettingsWithConverters

Gets the default JsonSerializerSettings with the DefaultJsonConverters.
Obsolete

TcHmiJsonSerializer Class 25:

TcHmiJsonSerializer Class 26:

DefaultSettingsWithDefaultConverters

Gets the default JsonSerializerSettings with the DefaultJsonConverters.

TcHmiJsonSerializer Class 27:

DefaultValueHandling

Gets or sets how default values are handled during serialization and deserialization. The default value is Include.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 28:

DurationFormatHandling

Gets or sets how durations are read from and written to JSON text.
The default value is IsoDurationFormat.

TcHmiJsonSerializer Class 29:

DurationFormatString

Gets or sets how TimeSpan values are formatted when writing JSON text and the expected duration format when reading JSON text.
This only takes effect if DurationFormatHandling equals MicrosoftDurationFormat.
The default value is Empty.

TcHmiJsonSerializer Class 30:

DurationParseHandling

Gets or sets how duration formatted Strings are parsed when reading JSON.
The default value is TimeSpan.

TcHmiJsonSerializer Class 31:

EqualityComparer

Gets or sets the equality comparer used by the serializer when comparing references.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 32:

FloatFormatHandling

Gets or sets how special floating point numbers, e.g. NaN, PositiveInfinity and NegativeInfinity, are written as JSON text. The default value is String.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 33:

FloatParseHandling

Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. The default value is Double.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 34:

Formatting

Indicates how JSON text output is formatted. The default value is None.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 35:

Int64ParseHandling

Gets or sets how values of type Int64 and UInt64 are parsed when writing JSON.
The default value is NumericString

TcHmiJsonSerializer Class 36:

MaxDepth

Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a JsonReaderException. A null value means there is no maximum. The default value is 64.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 37:

MetadataPropertyHandling

Gets or sets how metadata properties are used during deserialization. The default value is Default.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 38:

MissingMemberHandling

Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. The default value is Ignore.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 39:

NullValueHandling

Gets or sets how null values are handled during serialization and deserialization. The default value is Include.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 40:

ObjectCreationHandling

Gets or sets how objects are created during deserialization. The default value is Auto.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 41:

PreserveReferencesHandling

Gets or sets how object references are preserved by the serializer. The default value is None.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 42:

ReferenceLoopHandling

Gets or sets how reference loops (e.g. a class referencing itself) is handled. The default value is Error.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 43:

ReferenceResolver

Gets or sets the IReferenceResolver used by the serializer when resolving references.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 44:

SerializationBinder

Gets or sets the ISerializationBinder used by the serializer when resolving type names.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 45:

StringEscapeHandling

Gets or sets how strings are escaped when writing JSON text. The default value is Default.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 46:

TraceWriter

Gets or sets the ITraceWriter used by the serializer when writing trace messages.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 47:

TypeNameAssemblyFormat

Gets or sets how a type name assembly is written and resolved by the serializer. The default value is Simple.
(Inherited from JsonSerializer)
Obsolete

TcHmiJsonSerializer Class 48:

TypeNameAssemblyFormatHandling

Gets or sets how a type name assembly is written and resolved by the serializer. The default value is Simple.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 49:

TypeNameHandling

Gets or sets how type name writing and reading is handled by the serializer. The default value is None.
(Inherited from JsonSerializer)

Methods

 

Name

Description

TcHmiJsonSerializer Class 50:

TcHmiJsonSerializer Class 51:

Create

Creates a new TcHmiJsonSerializer instance. The TcHmiJsonSerializer will not use default settings from DefaultSettings.

TcHmiJsonSerializer Class 52:

TcHmiJsonSerializer Class 53:

Create(JsonSerializerSettings)

Creates a new TcHmiJsonSerializer instance using the specified JsonSerializerSettings . The TcHmiJsonSerializer will not use default settings from DefaultSettings.

TcHmiJsonSerializer Class 54:

TcHmiJsonSerializer Class 55:

CreateDefault

Creates a new TcHmiJsonSerializer instance. The TcHmiJsonSerializer will use default settings from DefaultSettings.

TcHmiJsonSerializer Class 56:

TcHmiJsonSerializer Class 57:

CreateDefault(JsonSerializerSettings)

Creates a new TcHmiJsonSerializer instance using the specified JsonSerializerSettings . The TcHmiJsonSerializer will use default settings from DefaultSettings as well as the specified JsonSerializerSettings .

TcHmiJsonSerializer Class 58:

TcHmiJsonSerializer Class 59:

Deserialize(JsonReader, Type)

Deserializes the JSON String contained by the specified JsonReader to an equivalent instance of the specified Type.

TcHmiJsonSerializer Class 60:

TcHmiJsonSerializer Class 61:

Deserialize(String, Type)

Deserializes the specified JSON String to an equivalent instance of the specified Type.

TcHmiJsonSerializer Class 62:

Deserialize(TextReader, Type)

Deserializes the JSON structure contained by the specified TextReader into an instance of the specified type.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 63:

TcHmiJsonSerializer Class 64:

Deserialize(JsonReader, Type, JsonSerializerSettings)

Deserializes the JSON String contained by the specified JsonReader to an equivalent instance of the specified Type.

TcHmiJsonSerializer Class 65:

TcHmiJsonSerializer Class 66:

Deserialize(JsonReader, Type, Boolean)

Deserializes the JSON String contained by the specified JsonReader to an equivalent instance of the specified Type.

TcHmiJsonSerializer Class 67:

TcHmiJsonSerializer Class 68:

Deserialize(String, Type, JsonSerializerSettings)

Deserializes the specified JSON String to an equivalent instance of the specified Type.

TcHmiJsonSerializer Class 69:

TcHmiJsonSerializer Class 70:

Deserialize(String, Type, Boolean)

Deserializes the specified JSON String to an equivalent instance of the specified Type.

TcHmiJsonSerializer Class 71:

TcHmiJsonSerializer Class 72:

DeserializeT(JsonReader)

Deserializes the JSON String contained by the specified JsonReader to an equivalent instance of the specified type.

TcHmiJsonSerializer Class 73:

TcHmiJsonSerializer Class 74:

DeserializeT(String)

Deserializes the specified JSON String to an equivalent instance of the specified type.

TcHmiJsonSerializer Class 75:

TcHmiJsonSerializer Class 76:

DeserializeT(JsonConverterT, String)

Deserializes the specified JSON String to an equivalent instance of the specified type using the specified JsonConverter{T} .

TcHmiJsonSerializer Class 77:

TcHmiJsonSerializer Class 78:

DeserializeT(JsonReader, JsonSerializerSettings)

Deserializes the JSON String contained by the specified JsonReader to an equivalent instance of the specified type.

TcHmiJsonSerializer Class 79:

TcHmiJsonSerializer Class 80:

DeserializeT(JsonReader, Boolean)

Deserializes the JSON String contained by the specified JsonReader to an equivalent instance of the specified type.

TcHmiJsonSerializer Class 81:

TcHmiJsonSerializer Class 82:

DeserializeT(String, JsonSerializerSettings)

Deserializes the specified JSON String to an equivalent instance of the specified type.

TcHmiJsonSerializer Class 83:

TcHmiJsonSerializer Class 84:

DeserializeT(String, Boolean)

Deserializes the specified JSON String to an equivalent instance of the specified type.

TcHmiJsonSerializer Class 85:

TcHmiJsonSerializer Class 86:

DeserializeT(JsonConverterT, String, JsonSerializer)

Deserializes the specified JSON String to an equivalent instance of the specified type using the specified JsonConverter{T} .

TcHmiJsonSerializer Class 87:

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

TcHmiJsonSerializer Class 88:

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)

TcHmiJsonSerializer Class 89:

GetHashCode

Serves as the default hash function.
(Inherited from Object)

TcHmiJsonSerializer Class 90:

GetType

Gets the Type of the current instance.
(Inherited from Object)

TcHmiJsonSerializer Class 91:

MemberwiseClone

Creates a shallow copy of the current Object.
(Inherited from Object)

TcHmiJsonSerializer Class 92:

Populate(JsonReader, Object)

Populates the JSON values onto the target object.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 93:

Populate(TextReader, Object)

Populates the JSON values onto the target object.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 94:

TcHmiJsonSerializer Class 95:

Serialize(Object)

Serializes the specified Object to an equivalent JSON String.

TcHmiJsonSerializer Class 96:

Serialize(JsonWriter, Object)

Serializes the specified Object and writes the JSON structure using the specified JsonWriter.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 97:

TcHmiJsonSerializer Class 98:

Serialize(Object, JsonSerializerSettings)

Serializes the specified Object to an equivalent JSON String using the specified JsonSerializerSettings .

TcHmiJsonSerializer Class 99:

TcHmiJsonSerializer Class 100:

Serialize(Object, Boolean)

Serializes the specified Object to an equivalent JSON String.

TcHmiJsonSerializer Class 101:

Serialize(TextWriter, Object)

Serializes the specified Object and writes the JSON structure using the specified TextWriter.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 102:

TcHmiJsonSerializer Class 103:

Serialize(Int32, Object, JsonSerializerSettings)

Serializes the specified Object to an equivalent JSON String using the specified capacity and JsonSerializerSettings .

TcHmiJsonSerializer Class 104:

Serialize(JsonWriter, Object, Type)

Serializes the specified Object and writes the JSON structure using the specified JsonWriter.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 105:

TcHmiJsonSerializer Class 106:

Serialize(JsonWriter, Object, JsonSerializerSettings)

Serializes the specified Object to an equivalent JSON String using the specified JsonWriter , Type and JsonSerializerSettings .

TcHmiJsonSerializer Class 107:

TcHmiJsonSerializer Class 108:

Serialize(JsonWriter, Object, Boolean)

Serializes the specified Object to an equivalent JSON String using the specified JsonWriter , Type and JsonSerializerSettings .

TcHmiJsonSerializer Class 109:

TcHmiJsonSerializer Class 110:

Serialize(Object, Boolean, Boolean)

Serializes the specified Object to an equivalent JSON String.

TcHmiJsonSerializer Class 111:

TcHmiJsonSerializer Class 112:

Serialize(Object, Type, JsonSerializerSettings)

Serializes the specified Object to an equivalent JSON String using the specified Type and JsonSerializerSettings .

TcHmiJsonSerializer Class 113:

Serialize(TextWriter, Object, Type)

Serializes the specified Object and writes the JSON structure using the specified TextWriter.
(Inherited from JsonSerializer)

TcHmiJsonSerializer Class 114:

TcHmiJsonSerializer Class 115:

Serialize(Int32, Object, Type, JsonSerializerSettings)

Serializes the specified Object to an equivalent JSON String using the specified capacity, Type and JsonSerializerSettings .

TcHmiJsonSerializer Class 116:

TcHmiJsonSerializer Class 117:

Serialize(JsonWriter, Object, Boolean, Boolean)

Serializes the specified Object to an equivalent JSON String using the specified JsonWriter , Type and JsonSerializerSettings .

TcHmiJsonSerializer Class 118:

TcHmiJsonSerializer Class 119:

Serialize(JsonWriter, Object, Type, JsonSerializerSettings)

Serializes the specified Object to an equivalent JSON String using the specified JsonWriter , Type and JsonSerializerSettings .

TcHmiJsonSerializer Class 120:

TcHmiJsonSerializer Class 121:

SerializeT(JsonConverterT, T)

Serializes the specified value to an equivalent JSON String using the specified JsonConverter{T} .

TcHmiJsonSerializer Class 122:

TcHmiJsonSerializer Class 123:

SerializeT(JsonConverterT, T, JsonSerializer)

Serializes the specified value to an equivalent JSON String using the specified JsonConverter{T} .

TcHmiJsonSerializer Class 124:

TcHmiJsonSerializer Class 125:

SerializeT(JsonConverterT, T, Boolean)

Serializes the specified value to an equivalent JSON String using the specified JsonConverter{T} .

TcHmiJsonSerializer Class 126:

TcHmiJsonSerializer Class 127:

SerializeT(Int32, JsonConverterT, T, JsonSerializer)

Serializes the specified value to an equivalent JSON String using the specified JsonConverter{T} .

TcHmiJsonSerializer Class 128:

ToString

Returns a string that represents the current object.
(Inherited from Object)

Events

 

Name

Description

TcHmiJsonSerializer Class 129:

Error

Occurs when the JsonSerializer errors during serialization and deserialization.
(Inherited from JsonSerializer)

Fields

 

Name

Description

TcHmiJsonSerializer Class 130:

TcHmiJsonSerializer Class 131:

DefaultCapacity

Contains the default capacity of StringBuilders that are used to create a JSON String.

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core.Tools.Json.Newtonsoft Namespace

Copyright © Beckhoff Automation GmbH & Co. KG

Further Information