Class JsonWriter
- Namespace
- Newtonsoft.Json
- Assembly
- Newtonsoft.Json.dll
public abstract class JsonWriter : IDisposable
- Inheritance
-
JsonWriter
- Implements
-
- Derived
-
- Inherited Members
-
- Extension Methods
-
Constructors
JsonWriter()
Properties
AutoCompleteOnClose
public bool AutoCompleteOnClose { get; set; }
Property Value
- bool
CloseOutput
public bool CloseOutput { get; set; }
Property Value
- bool
Culture
public CultureInfo Culture { get; set; }
Property Value
- CultureInfo
public DateFormatHandling DateFormatHandling { get; set; }
Property Value
- DateFormatHandling
public string? DateFormatString { get; set; }
Property Value
- string
DateTimeZoneHandling
public DateTimeZoneHandling DateTimeZoneHandling { get; set; }
Property Value
- DateTimeZoneHandling
public FloatFormatHandling FloatFormatHandling { get; set; }
Property Value
- FloatFormatHandling
public Formatting Formatting { get; set; }
Property Value
- Formatting
Path
public string Path { get; }
Property Value
- string
StringEscapeHandling
public StringEscapeHandling StringEscapeHandling { get; set; }
Property Value
- StringEscapeHandling
Top
protected int Top { get; }
Property Value
- int
WriteState
public WriteState WriteState { get; }
Property Value
- WriteState
Methods
Close()
public virtual void Close()
CloseAsync(CancellationToken)
public virtual Task CloseAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
Dispose(bool)
protected virtual void Dispose(bool disposing)
Parameters
disposing bool
Flush()
public abstract void Flush()
FlushAsync(CancellationToken)
public virtual Task FlushAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
SetWriteState(JsonToken, object)
protected void SetWriteState(JsonToken token, object value)
Parameters
token JsonTokenvalue object
SetWriteStateAsync(JsonToken, object, CancellationToken)
protected Task SetWriteStateAsync(JsonToken token, object value, CancellationToken cancellationToken)
Parameters
token JsonTokenvalue objectcancellationToken CancellationToken
Returns
- Task
public virtual void WriteComment(string? text)
Parameters
text string
public virtual Task WriteCommentAsync(string? text, CancellationToken cancellationToken = default)
Parameters
text stringcancellationToken CancellationToken
Returns
- Task
WriteEnd()
public virtual void WriteEnd()
WriteEnd(JsonToken)
protected virtual void WriteEnd(JsonToken token)
Parameters
token JsonToken
WriteEndArray()
public virtual void WriteEndArray()
WriteEndArrayAsync(CancellationToken)
public virtual Task WriteEndArrayAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteEndAsync(JsonToken, CancellationToken)
protected virtual Task WriteEndAsync(JsonToken token, CancellationToken cancellationToken)
Parameters
token JsonTokencancellationToken CancellationToken
Returns
- Task
WriteEndAsync(CancellationToken)
public virtual Task WriteEndAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteEndConstructor()
public virtual void WriteEndConstructor()
WriteEndConstructorAsync(CancellationToken)
public virtual Task WriteEndConstructorAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteEndObject()
public virtual void WriteEndObject()
WriteEndObjectAsync(CancellationToken)
public virtual Task WriteEndObjectAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteIndent()
protected virtual void WriteIndent()
WriteIndentAsync(CancellationToken)
protected virtual Task WriteIndentAsync(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteIndentSpace()
protected virtual void WriteIndentSpace()
WriteIndentSpaceAsync(CancellationToken)
protected virtual Task WriteIndentSpaceAsync(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteNull()
public virtual void WriteNull()
WriteNullAsync(CancellationToken)
public virtual Task WriteNullAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WritePropertyName(string)
public virtual void WritePropertyName(string name)
Parameters
name string
WritePropertyName(string, bool)
public virtual void WritePropertyName(string name, bool escape)
Parameters
name stringescape bool
WritePropertyNameAsync(string, bool, CancellationToken)
public virtual Task WritePropertyNameAsync(string name, bool escape, CancellationToken cancellationToken = default)
Parameters
name stringescape boolcancellationToken CancellationToken
Returns
- Task
WritePropertyNameAsync(string, CancellationToken)
public virtual Task WritePropertyNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
name stringcancellationToken CancellationToken
Returns
- Task
WriteRaw(string?)
public virtual void WriteRaw(string? json)
Parameters
json string
WriteRawAsync(string?, CancellationToken)
public virtual Task WriteRawAsync(string? json, CancellationToken cancellationToken = default)
Parameters
json stringcancellationToken CancellationToken
Returns
- Task
WriteRawValue(string?)
public virtual void WriteRawValue(string? json)
Parameters
json string
WriteRawValueAsync(string?, CancellationToken)
public virtual Task WriteRawValueAsync(string? json, CancellationToken cancellationToken = default)
Parameters
json stringcancellationToken CancellationToken
Returns
- Task
WriteStartArray()
public virtual void WriteStartArray()
WriteStartArrayAsync(CancellationToken)
public virtual Task WriteStartArrayAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteStartConstructor(string)
public virtual void WriteStartConstructor(string name)
Parameters
name string
WriteStartConstructorAsync(string, CancellationToken)
public virtual Task WriteStartConstructorAsync(string name, CancellationToken cancellationToken = default)
Parameters
name stringcancellationToken CancellationToken
Returns
- Task
WriteStartObject()
public virtual void WriteStartObject()
WriteStartObjectAsync(CancellationToken)
public virtual Task WriteStartObjectAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteToken(JsonReader)
public void WriteToken(JsonReader reader)
Parameters
reader JsonReader
WriteToken(JsonReader, bool)
public void WriteToken(JsonReader reader, bool writeChildren)
Parameters
reader JsonReaderwriteChildren bool
WriteToken(JsonToken)
public void WriteToken(JsonToken token)
Parameters
token JsonToken
WriteToken(JsonToken, object?)
public void WriteToken(JsonToken token, object? value)
Parameters
token JsonTokenvalue object
WriteTokenAsync(JsonReader, bool, CancellationToken)
public Task WriteTokenAsync(JsonReader reader, bool writeChildren, CancellationToken cancellationToken = default)
Parameters
reader JsonReaderwriteChildren boolcancellationToken CancellationToken
Returns
- Task
WriteTokenAsync(JsonReader, CancellationToken)
public Task WriteTokenAsync(JsonReader reader, CancellationToken cancellationToken = default)
Parameters
reader JsonReadercancellationToken CancellationToken
Returns
- Task
WriteTokenAsync(JsonToken, object?, CancellationToken)
public Task WriteTokenAsync(JsonToken token, object? value, CancellationToken cancellationToken = default)
Parameters
token JsonTokenvalue objectcancellationToken CancellationToken
Returns
- Task
WriteTokenAsync(JsonToken, CancellationToken)
public Task WriteTokenAsync(JsonToken token, CancellationToken cancellationToken = default)
Parameters
token JsonTokencancellationToken CancellationToken
Returns
- Task
WriteUndefined()
public virtual void WriteUndefined()
WriteUndefinedAsync(CancellationToken)
public virtual Task WriteUndefinedAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteValue(bool)
public virtual void WriteValue(bool value)
Parameters
value bool
WriteValue(byte)
public virtual void WriteValue(byte value)
Parameters
value byte
WriteValue(byte[]?)
public virtual void WriteValue(byte[]? value)
Parameters
value byte[]
WriteValue(char)
public virtual void WriteValue(char value)
Parameters
value char
WriteValue(DateTime)
public virtual void WriteValue(DateTime value)
Parameters
value DateTime
WriteValue(DateTimeOffset)
public virtual void WriteValue(DateTimeOffset value)
Parameters
value DateTimeOffset
WriteValue(decimal)
public virtual void WriteValue(decimal value)
Parameters
value decimal
WriteValue(double)
public virtual void WriteValue(double value)
Parameters
value double
WriteValue(Guid)
public virtual void WriteValue(Guid value)
Parameters
value Guid
WriteValue(short)
public virtual void WriteValue(short value)
Parameters
value short
WriteValue(int)
public virtual void WriteValue(int value)
Parameters
value int
WriteValue(long)
public virtual void WriteValue(long value)
Parameters
value long
WriteValue(bool?)
public virtual void WriteValue(bool? value)
Parameters
value bool?
WriteValue(byte?)
public virtual void WriteValue(byte? value)
Parameters
value byte?
WriteValue(char?)
public virtual void WriteValue(char? value)
Parameters
value char?
WriteValue(DateTimeOffset?)
public virtual void WriteValue(DateTimeOffset? value)
Parameters
value DateTimeOffset?
WriteValue(DateTime?)
public virtual void WriteValue(DateTime? value)
Parameters
value DateTime?
WriteValue(decimal?)
public virtual void WriteValue(decimal? value)
Parameters
value decimal?
WriteValue(double?)
public virtual void WriteValue(double? value)
Parameters
value double?
WriteValue(Guid?)
public virtual void WriteValue(Guid? value)
Parameters
value Guid?
WriteValue(short?)
public virtual void WriteValue(short? value)
Parameters
value short?
WriteValue(int?)
public virtual void WriteValue(int? value)
Parameters
value int?
WriteValue(long?)
public virtual void WriteValue(long? value)
Parameters
value long?
WriteValue(sbyte?)
[CLSCompliant(false)]
public virtual void WriteValue(sbyte? value)
Parameters
value sbyte?
WriteValue(float?)
public virtual void WriteValue(float? value)
Parameters
value float?
WriteValue(TimeSpan?)
public virtual void WriteValue(TimeSpan? value)
Parameters
value TimeSpan?
WriteValue(ushort?)
[CLSCompliant(false)]
public virtual void WriteValue(ushort? value)
Parameters
value ushort?
WriteValue(uint?)
[CLSCompliant(false)]
public virtual void WriteValue(uint? value)
Parameters
value uint?
WriteValue(ulong?)
[CLSCompliant(false)]
public virtual void WriteValue(ulong? value)
Parameters
value ulong?
WriteValue(object?)
public virtual void WriteValue(object? value)
Parameters
value object
WriteValue(sbyte)
[CLSCompliant(false)]
public virtual void WriteValue(sbyte value)
Parameters
value sbyte
WriteValue(float)
public virtual void WriteValue(float value)
Parameters
value float
WriteValue(string?)
public virtual void WriteValue(string? value)
Parameters
value string
WriteValue(TimeSpan)
public virtual void WriteValue(TimeSpan value)
Parameters
value TimeSpan
WriteValue(ushort)
[CLSCompliant(false)]
public virtual void WriteValue(ushort value)
Parameters
value ushort
WriteValue(uint)
[CLSCompliant(false)]
public virtual void WriteValue(uint value)
Parameters
value uint
WriteValue(ulong)
[CLSCompliant(false)]
public virtual void WriteValue(ulong value)
Parameters
value ulong
WriteValue(Uri?)
public virtual void WriteValue(Uri? value)
Parameters
value Uri
WriteValueAsync(bool, CancellationToken)
public virtual Task WriteValueAsync(bool value, CancellationToken cancellationToken = default)
Parameters
value boolcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(byte, CancellationToken)
public virtual Task WriteValueAsync(byte value, CancellationToken cancellationToken = default)
Parameters
value bytecancellationToken CancellationToken
Returns
- Task
WriteValueAsync(byte[]?, CancellationToken)
public virtual Task WriteValueAsync(byte[]? value, CancellationToken cancellationToken = default)
Parameters
value byte[]cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(char, CancellationToken)
public virtual Task WriteValueAsync(char value, CancellationToken cancellationToken = default)
Parameters
value charcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(DateTime, CancellationToken)
public virtual Task WriteValueAsync(DateTime value, CancellationToken cancellationToken = default)
Parameters
value DateTimecancellationToken CancellationToken
Returns
- Task
WriteValueAsync(DateTimeOffset, CancellationToken)
public virtual Task WriteValueAsync(DateTimeOffset value, CancellationToken cancellationToken = default)
Parameters
value DateTimeOffsetcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(decimal, CancellationToken)
public virtual Task WriteValueAsync(decimal value, CancellationToken cancellationToken = default)
Parameters
value decimalcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(double, CancellationToken)
public virtual Task WriteValueAsync(double value, CancellationToken cancellationToken = default)
Parameters
value doublecancellationToken CancellationToken
Returns
- Task
WriteValueAsync(Guid, CancellationToken)
public virtual Task WriteValueAsync(Guid value, CancellationToken cancellationToken = default)
Parameters
value GuidcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(short, CancellationToken)
public virtual Task WriteValueAsync(short value, CancellationToken cancellationToken = default)
Parameters
value shortcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(int, CancellationToken)
public virtual Task WriteValueAsync(int value, CancellationToken cancellationToken = default)
Parameters
value intcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(long, CancellationToken)
public virtual Task WriteValueAsync(long value, CancellationToken cancellationToken = default)
Parameters
value longcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(bool?, CancellationToken)
public virtual Task WriteValueAsync(bool? value, CancellationToken cancellationToken = default)
Parameters
value bool?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(byte?, CancellationToken)
public virtual Task WriteValueAsync(byte? value, CancellationToken cancellationToken = default)
Parameters
value byte?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(char?, CancellationToken)
public virtual Task WriteValueAsync(char? value, CancellationToken cancellationToken = default)
Parameters
value char?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(DateTimeOffset?, CancellationToken)
public virtual Task WriteValueAsync(DateTimeOffset? value, CancellationToken cancellationToken = default)
Parameters
value DateTimeOffset?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(DateTime?, CancellationToken)
public virtual Task WriteValueAsync(DateTime? value, CancellationToken cancellationToken = default)
Parameters
value DateTime?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(decimal?, CancellationToken)
public virtual Task WriteValueAsync(decimal? value, CancellationToken cancellationToken = default)
Parameters
value decimal?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(double?, CancellationToken)
public virtual Task WriteValueAsync(double? value, CancellationToken cancellationToken = default)
Parameters
value double?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(Guid?, CancellationToken)
public virtual Task WriteValueAsync(Guid? value, CancellationToken cancellationToken = default)
Parameters
value Guid?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(short?, CancellationToken)
public virtual Task WriteValueAsync(short? value, CancellationToken cancellationToken = default)
Parameters
value short?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(int?, CancellationToken)
public virtual Task WriteValueAsync(int? value, CancellationToken cancellationToken = default)
Parameters
value int?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(long?, CancellationToken)
public virtual Task WriteValueAsync(long? value, CancellationToken cancellationToken = default)
Parameters
value long?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(sbyte?, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(sbyte? value, CancellationToken cancellationToken = default)
Parameters
value sbyte?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(float?, CancellationToken)
public virtual Task WriteValueAsync(float? value, CancellationToken cancellationToken = default)
Parameters
value float?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(TimeSpan?, CancellationToken)
public virtual Task WriteValueAsync(TimeSpan? value, CancellationToken cancellationToken = default)
Parameters
value TimeSpan?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(ushort?, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(ushort? value, CancellationToken cancellationToken = default)
Parameters
value ushort?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(uint?, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(uint? value, CancellationToken cancellationToken = default)
Parameters
value uint?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(ulong?, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(ulong? value, CancellationToken cancellationToken = default)
Parameters
value ulong?cancellationToken CancellationToken
Returns
- Task
WriteValueAsync(object?, CancellationToken)
public virtual Task WriteValueAsync(object? value, CancellationToken cancellationToken = default)
Parameters
value objectcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(sbyte, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(sbyte value, CancellationToken cancellationToken = default)
Parameters
value sbytecancellationToken CancellationToken
Returns
- Task
WriteValueAsync(float, CancellationToken)
public virtual Task WriteValueAsync(float value, CancellationToken cancellationToken = default)
Parameters
value floatcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(string?, CancellationToken)
public virtual Task WriteValueAsync(string? value, CancellationToken cancellationToken = default)
Parameters
value stringcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(TimeSpan, CancellationToken)
public virtual Task WriteValueAsync(TimeSpan value, CancellationToken cancellationToken = default)
Parameters
value TimeSpancancellationToken CancellationToken
Returns
- Task
WriteValueAsync(ushort, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(ushort value, CancellationToken cancellationToken = default)
Parameters
value ushortcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(uint, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(uint value, CancellationToken cancellationToken = default)
Parameters
value uintcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(ulong, CancellationToken)
[CLSCompliant(false)]
public virtual Task WriteValueAsync(ulong value, CancellationToken cancellationToken = default)
Parameters
value ulongcancellationToken CancellationToken
Returns
- Task
WriteValueAsync(Uri?, CancellationToken)
public virtual Task WriteValueAsync(Uri? value, CancellationToken cancellationToken = default)
Parameters
value UricancellationToken CancellationToken
Returns
- Task
WriteValueDelimiter()
protected virtual void WriteValueDelimiter()
WriteValueDelimiterAsync(CancellationToken)
protected virtual Task WriteValueDelimiterAsync(CancellationToken cancellationToken)
Parameters
cancellationToken CancellationToken
Returns
- Task
WriteWhitespace(string)
public virtual void WriteWhitespace(string ws)
Parameters
ws string
WriteWhitespaceAsync(string, CancellationToken)
public virtual Task WriteWhitespaceAsync(string ws, CancellationToken cancellationToken = default)
Parameters
ws stringcancellationToken CancellationToken
Returns
- Task