Class JsonWriter

Namespace

Newtonsoft.Json

Assembly

Newtonsoft.Json.dll

Represents a writer that provides a fast, non-cached, forward-only way of generating Json data.

public abstract class JsonWriter : IDisposable

Inheritance

object

JsonWriter

Implements

IDisposable

Derived

BsonWriter

JsonTextWriter

JTokenWriter

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

JsonWriter()

Creates an instance of the JsonWriter class.

protected JsonWriter()

Properties

CloseOutput

Gets or sets a value indicating whether the underlying stream or TextReader should be closed when the writer is closed.

public bool CloseOutput { get; set; }

Property Value

bool

true to close the underlying stream or TextReader when the writer is closed; otherwise false. The default is true.

Formatting

Indicates how the output is formatted.

public Formatting Formatting { get; set; }

Property Value

Formatting

Top

Gets the top.

protected int Top { get; }

Property Value

int

The top.

WriteState

Gets the state of the writer.

public WriteState WriteState { get; }

Property Value

WriteState

Methods

Close()

Closes this stream and the underlying stream.

public virtual void Close()

Flush()

Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.

public abstract void Flush()

WriteComment(string)

Writes out a comment

/.../

containing the specified text.

public virtual void WriteComment(string text)

Parameters

text string

Text to place inside the comment.

WriteEnd()

Writes the end of the current Json object or array.

public virtual void WriteEnd()

WriteEnd(JsonToken)

Writes the specified end token.

protected virtual void WriteEnd(JsonToken token)

Parameters

token JsonToken

The end token to write.

WriteEndArray()

Writes the end of an array.

public virtual void WriteEndArray()

WriteEndConstructor()

Writes the end constructor.

public virtual void WriteEndConstructor()

WriteEndObject()

Writes the end of a Json object.

public virtual void WriteEndObject()

WriteIndent()

Writes indent characters.

protected virtual void WriteIndent()

WriteIndentSpace()

Writes an indent space.

protected virtual void WriteIndentSpace()

WriteNull()

Writes a null value.

public virtual void WriteNull()

WritePropertyName(string)

Writes the property name of a name/value pair on a Json object.

public virtual void WritePropertyName(string name)

Parameters

name string

The name of the property.

WriteRaw(string)

Writes raw JSON without changing the writer's state.

public virtual void WriteRaw(string json)

Parameters

json string

The raw JSON to write.

WriteRawValue(string)

Writes raw JSON where a value is expected and updates the writer's state.

public virtual void WriteRawValue(string json)

Parameters

json string

The raw JSON to write.

WriteStartArray()

Writes the beginning of a Json array.

public virtual void WriteStartArray()

WriteStartConstructor(string)

Writes the start of a constructor with the given name.

public virtual void WriteStartConstructor(string name)

Parameters

name string

The name of the constructor.

WriteStartObject()

Writes the beginning of a Json object.

public virtual void WriteStartObject()

WriteToken(JsonReader)

Writes the current JsonReader token.

public void WriteToken(JsonReader reader)

Parameters

reader JsonReader

The JsonReader to read the token from.

WriteUndefined()

Writes an undefined value.

public virtual void WriteUndefined()

WriteValue(bool)

Writes a bool value.

public virtual void WriteValue(bool value)

Parameters

value bool

The bool value to write.

WriteValue(byte)

Writes a byte value.

public virtual void WriteValue(byte value)

Parameters

value byte

The byte value to write.

WriteValue(byte[])

Writes a Byte[] value.

public virtual void WriteValue(byte[] value)

Parameters

value byte[]

The Byte[] value to write.

WriteValue(char)

Writes a char value.

public virtual void WriteValue(char value)

Parameters

value char

The char value to write.

WriteValue(DateTime)

Writes a DateTime value.

public virtual void WriteValue(DateTime value)

Parameters

value DateTime

The DateTime value to write.

WriteValue(DateTimeOffset)

Writes a DateTimeOffset value.

public virtual void WriteValue(DateTimeOffset value)

Parameters

value DateTimeOffset

The DateTimeOffset value to write.

WriteValue(decimal)

Writes a decimal value.

public virtual void WriteValue(decimal value)

Parameters

value decimal

The decimal value to write.

WriteValue(double)

Writes a double value.

public virtual void WriteValue(double value)

Parameters

value double

The double value to write.

WriteValue(Guid)

Writes a Guid value.

public virtual void WriteValue(Guid value)

Parameters

value Guid

The Guid value to write.

WriteValue(short)

Writes a short value.

public virtual void WriteValue(short value)

Parameters

value short

The short value to write.

WriteValue(int)

Writes a int value.

public virtual void WriteValue(int value)

Parameters

value int

The int value to write.

WriteValue(long)

Writes a long value.

public virtual void WriteValue(long value)

Parameters

value long

The long value to write.

WriteValue(bool?)

Writes a Nullable<T> value.

public virtual void WriteValue(bool? value)

Parameters

value bool?

The Nullable<T> value to write.

WriteValue(byte?)

Writes a Nullable<T> value.

public virtual void WriteValue(byte? value)

Parameters

value byte?

The Nullable<T> value to write.

WriteValue(char?)

Writes a Nullable<T> value.

public virtual void WriteValue(char? value)

Parameters

value char?

The Nullable<T> value to write.

WriteValue(DateTimeOffset?)

Writes a Nullable<T> value.

public virtual void WriteValue(DateTimeOffset? value)

Parameters

value DateTimeOffset?

The Nullable<T> value to write.

WriteValue(DateTime?)

Writes a Nullable<T> value.

public virtual void WriteValue(DateTime? value)

Parameters

value DateTime?

The Nullable<T> value to write.

WriteValue(decimal?)

Writes a Nullable<T> value.

public virtual void WriteValue(decimal? value)

Parameters

value decimal?

The Nullable<T> value to write.

WriteValue(double?)

Writes a Nullable<T> value.

public virtual void WriteValue(double? value)

Parameters

value double?

The Nullable<T> value to write.

WriteValue(Guid?)

Writes a Nullable<T> value.

public virtual void WriteValue(Guid? value)

Parameters

value Guid?

The Nullable<T> value to write.

WriteValue(short?)

Writes a Nullable<T> value.

public virtual void WriteValue(short? value)

Parameters

value short?

The Nullable<T> value to write.

WriteValue(int?)

Writes a Nullable<T> value.

public virtual void WriteValue(int? value)

Parameters

value int?

The Nullable<T> value to write.

WriteValue(long?)

Writes a Nullable<T> value.

public virtual void WriteValue(long? value)

Parameters

value long?

The Nullable<T> value to write.

WriteValue(sbyte?)

Writes a Nullable<T> value.

[CLSCompliant(false)]
public virtual void WriteValue(sbyte? value)

Parameters

value sbyte?

The Nullable<T> value to write.

WriteValue(float?)

Writes a Nullable<T> value.

public virtual void WriteValue(float? value)

Parameters

value float?

The Nullable<T> value to write.

WriteValue(TimeSpan?)

Writes a Nullable<T> value.

public virtual void WriteValue(TimeSpan? value)

Parameters

value TimeSpan?

The Nullable<T> value to write.

WriteValue(ushort?)

Writes a Nullable<T> value.

[CLSCompliant(false)]
public virtual void WriteValue(ushort? value)

Parameters

value ushort?

The Nullable<T> value to write.

WriteValue(uint?)

Writes a Nullable<T> value.

[CLSCompliant(false)]
public virtual void WriteValue(uint? value)

Parameters

value uint?

The Nullable<T> value to write.

WriteValue(ulong?)

Writes a Nullable<T> value.

[CLSCompliant(false)]
public virtual void WriteValue(ulong? value)

Parameters

value ulong?

The Nullable<T> value to write.

WriteValue(object)

Writes a object value. An error will raised if the value cannot be written as a single JSON token.

public virtual void WriteValue(object value)

Parameters

value object

The object value to write.

WriteValue(sbyte)

Writes a sbyte value.

[CLSCompliant(false)]
public virtual void WriteValue(sbyte value)

Parameters

value sbyte

The sbyte value to write.

WriteValue(float)

Writes a float value.

public virtual void WriteValue(float value)

Parameters

value float

The float value to write.

WriteValue(string)

Writes a string value.

public virtual void WriteValue(string value)

Parameters

value string

The string value to write.

WriteValue(TimeSpan)

Writes a TimeSpan value.

public virtual void WriteValue(TimeSpan value)

Parameters

value TimeSpan

The TimeSpan value to write.

WriteValue(ushort)

Writes a ushort value.

[CLSCompliant(false)]
public virtual void WriteValue(ushort value)

Parameters

value ushort

The ushort value to write.

WriteValue(uint)

Writes a uint value.

[CLSCompliant(false)]
public virtual void WriteValue(uint value)

Parameters

value uint

The uint value to write.

WriteValue(ulong)

Writes a ulong value.

[CLSCompliant(false)]
public virtual void WriteValue(ulong value)

Parameters

value ulong

The ulong value to write.

WriteValue(Uri)

Writes a System.Uri value.

public virtual void WriteValue(Uri value)

Parameters

value Uri

The System.Uri value to write.

WriteValueDelimiter()

Writes the JSON value delimiter.

protected virtual void WriteValueDelimiter()

WriteWhitespace(string)

Writes out the given white space.

public virtual void WriteWhitespace(string ws)

Parameters

ws string

The string of white space characters.