Table of Contents

Class JToken

Namespace
Newtonsoft.Json.Linq
Assembly
Newtonsoft.Json.dll
public abstract class JToken : IJEnumerable<JToken>, IEnumerable<JToken>, IEnumerable, IJsonLineInfo, ICloneable, IDynamicMetaObjectProvider
Inheritance
JToken
Implements
Derived
Inherited Members
Extension Methods

Properties

EqualityComparer

public static JTokenEqualityComparer EqualityComparer { get; }

Property Value

JTokenEqualityComparer

First

public virtual JToken? First { get; }

Property Value

JToken

HasValues

public abstract bool HasValues { get; }

Property Value

bool

this[object]

public virtual JToken? this[object key] { get; set; }

Parameters

key object

Property Value

JToken

Last

public virtual JToken? Last { get; }

Property Value

JToken

Next

public JToken? Next { get; }

Property Value

JToken

Parent

public JContainer? Parent { get; }

Property Value

JContainer

Path

public string Path { get; }

Property Value

string

Previous

public JToken? Previous { get; }

Property Value

JToken

Root

public JToken Root { get; }

Property Value

JToken

Type

public abstract JTokenType Type { get; }

Property Value

JTokenType

Methods

AddAfterSelf(object?)

public void AddAfterSelf(object? content)

Parameters

content object

AddAnnotation(object)

public void AddAnnotation(object annotation)

Parameters

annotation object

AddBeforeSelf(object?)

public void AddBeforeSelf(object? content)

Parameters

content object

AfterSelf()

public IEnumerable<JToken> AfterSelf()

Returns

IEnumerable<JToken>

Ancestors()

public IEnumerable<JToken> Ancestors()

Returns

IEnumerable<JToken>

AncestorsAndSelf()

public IEnumerable<JToken> AncestorsAndSelf()

Returns

IEnumerable<JToken>

Annotation(Type)

public object? Annotation(Type type)

Parameters

type Type

Returns

object

Annotation<T>()

public T? Annotation<T>() where T : class

Returns

T

Type Parameters

T

Annotations(Type)

public IEnumerable<object> Annotations(Type type)

Parameters

type Type

Returns

IEnumerable<object>

Annotations<T>()

public IEnumerable<T> Annotations<T>() where T : class

Returns

IEnumerable<T>

Type Parameters

T

BeforeSelf()

public IEnumerable<JToken> BeforeSelf()

Returns

IEnumerable<JToken>

Children()

public virtual JEnumerable<JToken> Children()

Returns

JEnumerable<JToken>

Children<T>()

public JEnumerable<T> Children<T>() where T : JToken

Returns

JEnumerable<T>

Type Parameters

T

CreateReader()

public JsonReader CreateReader()

Returns

JsonReader

DeepClone()

public JToken DeepClone()

Returns

JToken

DeepEquals(JToken?, JToken?)

public static bool DeepEquals(JToken? t1, JToken? t2)

Parameters

t1 JToken
t2 JToken

Returns

bool

FromObject(object)

public static JToken FromObject(object o)

Parameters

o object

Returns

JToken

FromObject(object, JsonSerializer)

public static JToken FromObject(object o, JsonSerializer jsonSerializer)

Parameters

o object
jsonSerializer JsonSerializer

Returns

JToken

GetMetaObject(Expression)

protected virtual DynamicMetaObject GetMetaObject(Expression parameter)

Parameters

parameter Expression

Returns

DynamicMetaObject

Load(JsonReader)

public static JToken Load(JsonReader reader)

Parameters

reader JsonReader

Returns

JToken

Load(JsonReader, JsonLoadSettings?)

public static JToken Load(JsonReader reader, JsonLoadSettings? settings)

Parameters

reader JsonReader
settings JsonLoadSettings

Returns

JToken

LoadAsync(JsonReader, JsonLoadSettings?, CancellationToken)

public static Task<JToken> LoadAsync(JsonReader reader, JsonLoadSettings? settings, CancellationToken cancellationToken = default)

Parameters

reader JsonReader
settings JsonLoadSettings
cancellationToken CancellationToken

Returns

Task<JToken>

LoadAsync(JsonReader, CancellationToken)

public static Task<JToken> LoadAsync(JsonReader reader, CancellationToken cancellationToken = default)

Parameters

reader JsonReader
cancellationToken CancellationToken

Returns

Task<JToken>

Parse(string)

public static JToken Parse(string json)

Parameters

json string

Returns

JToken

Parse(string, JsonLoadSettings?)

public static JToken Parse(string json, JsonLoadSettings? settings)

Parameters

json string
settings JsonLoadSettings

Returns

JToken

ReadFrom(JsonReader)

public static JToken ReadFrom(JsonReader reader)

Parameters

reader JsonReader

Returns

JToken

ReadFrom(JsonReader, JsonLoadSettings?)

public static JToken ReadFrom(JsonReader reader, JsonLoadSettings? settings)

Parameters

reader JsonReader
settings JsonLoadSettings

Returns

JToken

ReadFromAsync(JsonReader, JsonLoadSettings?, CancellationToken)

public static Task<JToken> ReadFromAsync(JsonReader reader, JsonLoadSettings? settings, CancellationToken cancellationToken = default)

Parameters

reader JsonReader
settings JsonLoadSettings
cancellationToken CancellationToken

Returns

Task<JToken>

ReadFromAsync(JsonReader, CancellationToken)

public static Task<JToken> ReadFromAsync(JsonReader reader, CancellationToken cancellationToken = default)

Parameters

reader JsonReader
cancellationToken CancellationToken

Returns

Task<JToken>

Remove()

public void Remove()

RemoveAnnotations(Type)

public void RemoveAnnotations(Type type)

Parameters

type Type

RemoveAnnotations<T>()

public void RemoveAnnotations<T>() where T : class

Type Parameters

T

Replace(JToken)

public void Replace(JToken value)

Parameters

value JToken

SelectToken(string)

public JToken? SelectToken(string path)

Parameters

path string

Returns

JToken

SelectToken(string, JsonSelectSettings?)

public JToken? SelectToken(string path, JsonSelectSettings? settings)

Parameters

path string
settings JsonSelectSettings

Returns

JToken

SelectToken(string, bool)

public JToken? SelectToken(string path, bool errorWhenNoMatch)

Parameters

path string
errorWhenNoMatch bool

Returns

JToken

SelectTokens(string)

public IEnumerable<JToken> SelectTokens(string path)

Parameters

path string

Returns

IEnumerable<JToken>

SelectTokens(string, JsonSelectSettings?)

public IEnumerable<JToken> SelectTokens(string path, JsonSelectSettings? settings)

Parameters

path string
settings JsonSelectSettings

Returns

IEnumerable<JToken>

SelectTokens(string, bool)

public IEnumerable<JToken> SelectTokens(string path, bool errorWhenNoMatch)

Parameters

path string
errorWhenNoMatch bool

Returns

IEnumerable<JToken>

ToObject(Type)

public object? ToObject(Type objectType)

Parameters

objectType Type

Returns

object

ToObject(Type, JsonSerializer)

public object? ToObject(Type objectType, JsonSerializer jsonSerializer)

Parameters

objectType Type
jsonSerializer JsonSerializer

Returns

object

ToObject<T>()

public T? ToObject<T>()

Returns

T

Type Parameters

T

ToObject<T>(JsonSerializer)

public T? ToObject<T>(JsonSerializer jsonSerializer)

Parameters

jsonSerializer JsonSerializer

Returns

T

Type Parameters

T

ToString()

public override string ToString()

Returns

string

ToString(Formatting, params JsonConverter[])

public string ToString(Formatting formatting, params JsonConverter[] converters)

Parameters

formatting Formatting
converters JsonConverter[]

Returns

string

Value<T>(object)

public virtual T? Value<T>(object key)

Parameters

key object

Returns

T

Type Parameters

T

Values<T>()

public virtual IEnumerable<T?> Values<T>()

Returns

IEnumerable<T>

Type Parameters

T

WriteTo(JsonWriter, params JsonConverter[])

public abstract void WriteTo(JsonWriter writer, params JsonConverter[] converters)

Parameters

writer JsonWriter
converters JsonConverter[]

WriteToAsync(JsonWriter, params JsonConverter[])

public Task WriteToAsync(JsonWriter writer, params JsonConverter[] converters)

Parameters

writer JsonWriter
converters JsonConverter[]

Returns

Task

WriteToAsync(JsonWriter, CancellationToken, params JsonConverter[])

public virtual Task WriteToAsync(JsonWriter writer, CancellationToken cancellationToken, params JsonConverter[] converters)

Parameters

writer JsonWriter
cancellationToken CancellationToken
converters JsonConverter[]

Returns

Task

Operators

explicit operator bool(JToken)

public static explicit operator bool(JToken value)

Parameters

value JToken

Returns

bool

explicit operator byte(JToken)

public static explicit operator byte(JToken value)

Parameters

value JToken

Returns

byte

explicit operator byte[]?(JToken?)

public static explicit operator byte[]?(JToken? value)

Parameters

value JToken

Returns

byte[]

explicit operator char(JToken)

[CLSCompliant(false)]
public static explicit operator char(JToken value)

Parameters

value JToken

Returns

char

explicit operator DateTime(JToken)

public static explicit operator DateTime(JToken value)

Parameters

value JToken

Returns

DateTime

explicit operator DateTimeOffset(JToken)

public static explicit operator DateTimeOffset(JToken value)

Parameters

value JToken

Returns

DateTimeOffset

explicit operator decimal(JToken)

public static explicit operator decimal(JToken value)

Parameters

value JToken

Returns

decimal

explicit operator double(JToken)

public static explicit operator double(JToken value)

Parameters

value JToken

Returns

double

explicit operator Guid(JToken)

public static explicit operator Guid(JToken value)

Parameters

value JToken

Returns

Guid

explicit operator short(JToken)

public static explicit operator short(JToken value)

Parameters

value JToken

Returns

short

explicit operator int(JToken)

public static explicit operator int(JToken value)

Parameters

value JToken

Returns

int

explicit operator long(JToken)

public static explicit operator long(JToken value)

Parameters

value JToken

Returns

long

explicit operator bool?(JToken?)

public static explicit operator bool?(JToken? value)

Parameters

value JToken

Returns

bool?

explicit operator byte?(JToken?)

public static explicit operator byte?(JToken? value)

Parameters

value JToken

Returns

byte?

explicit operator char?(JToken?)

public static explicit operator char?(JToken? value)

Parameters

value JToken

Returns

char?

explicit operator DateTimeOffset?(JToken?)

public static explicit operator DateTimeOffset?(JToken? value)

Parameters

value JToken

Returns

DateTimeOffset?

explicit operator DateTime?(JToken?)

public static explicit operator DateTime?(JToken? value)

Parameters

value JToken

Returns

DateTime?

explicit operator decimal?(JToken?)

public static explicit operator decimal?(JToken? value)

Parameters

value JToken

Returns

decimal?

explicit operator double?(JToken?)

public static explicit operator double?(JToken? value)

Parameters

value JToken

Returns

double?

explicit operator Guid?(JToken?)

public static explicit operator Guid?(JToken? value)

Parameters

value JToken

Returns

Guid?

explicit operator short?(JToken?)

public static explicit operator short?(JToken? value)

Parameters

value JToken

Returns

short?

explicit operator int?(JToken?)

public static explicit operator int?(JToken? value)

Parameters

value JToken

Returns

int?

explicit operator long?(JToken?)

public static explicit operator long?(JToken? value)

Parameters

value JToken

Returns

long?

explicit operator sbyte?(JToken?)

[CLSCompliant(false)]
public static explicit operator sbyte?(JToken? value)

Parameters

value JToken

Returns

sbyte?

explicit operator float?(JToken?)

public static explicit operator float?(JToken? value)

Parameters

value JToken

Returns

float?

explicit operator TimeSpan?(JToken?)

public static explicit operator TimeSpan?(JToken? value)

Parameters

value JToken

Returns

TimeSpan?

explicit operator ushort?(JToken?)

[CLSCompliant(false)]
public static explicit operator ushort?(JToken? value)

Parameters

value JToken

Returns

ushort?

explicit operator uint?(JToken?)

[CLSCompliant(false)]
public static explicit operator uint?(JToken? value)

Parameters

value JToken

Returns

uint?

explicit operator ulong?(JToken?)

[CLSCompliant(false)]
public static explicit operator ulong?(JToken? value)

Parameters

value JToken

Returns

ulong?

explicit operator sbyte(JToken)

[CLSCompliant(false)]
public static explicit operator sbyte(JToken value)

Parameters

value JToken

Returns

sbyte

explicit operator float(JToken)

public static explicit operator float(JToken value)

Parameters

value JToken

Returns

float

explicit operator string?(JToken?)

public static explicit operator string?(JToken? value)

Parameters

value JToken

Returns

string

explicit operator TimeSpan(JToken)

public static explicit operator TimeSpan(JToken value)

Parameters

value JToken

Returns

TimeSpan

explicit operator ushort(JToken)

[CLSCompliant(false)]
public static explicit operator ushort(JToken value)

Parameters

value JToken

Returns

ushort

explicit operator uint(JToken)

[CLSCompliant(false)]
public static explicit operator uint(JToken value)

Parameters

value JToken

Returns

uint

explicit operator ulong(JToken)

[CLSCompliant(false)]
public static explicit operator ulong(JToken value)

Parameters

value JToken

Returns

ulong

explicit operator Uri?(JToken?)

public static explicit operator Uri?(JToken? value)

Parameters

value JToken

Returns

Uri

implicit operator JToken(bool)

public static implicit operator JToken(bool value)

Parameters

value bool

Returns

JToken

implicit operator JToken(byte)

public static implicit operator JToken(byte value)

Parameters

value byte

Returns

JToken

implicit operator JToken(byte[])

public static implicit operator JToken(byte[] value)

Parameters

value byte[]

Returns

JToken

implicit operator JToken(DateTime)

public static implicit operator JToken(DateTime value)

Parameters

value DateTime

Returns

JToken

implicit operator JToken(DateTimeOffset)

public static implicit operator JToken(DateTimeOffset value)

Parameters

value DateTimeOffset

Returns

JToken

implicit operator JToken(decimal)

public static implicit operator JToken(decimal value)

Parameters

value decimal

Returns

JToken

implicit operator JToken(double)

public static implicit operator JToken(double value)

Parameters

value double

Returns

JToken

implicit operator JToken(Guid)

public static implicit operator JToken(Guid value)

Parameters

value Guid

Returns

JToken

implicit operator JToken(short)

[CLSCompliant(false)]
public static implicit operator JToken(short value)

Parameters

value short

Returns

JToken

implicit operator JToken(int)

public static implicit operator JToken(int value)

Parameters

value int

Returns

JToken

implicit operator JToken(long)

public static implicit operator JToken(long value)

Parameters

value long

Returns

JToken

implicit operator JToken(bool?)

public static implicit operator JToken(bool? value)

Parameters

value bool?

Returns

JToken

implicit operator JToken(byte?)

public static implicit operator JToken(byte? value)

Parameters

value byte?

Returns

JToken

implicit operator JToken(DateTimeOffset?)

public static implicit operator JToken(DateTimeOffset? value)

Parameters

value DateTimeOffset?

Returns

JToken

implicit operator JToken(DateTime?)

public static implicit operator JToken(DateTime? value)

Parameters

value DateTime?

Returns

JToken

implicit operator JToken(decimal?)

public static implicit operator JToken(decimal? value)

Parameters

value decimal?

Returns

JToken

implicit operator JToken(double?)

public static implicit operator JToken(double? value)

Parameters

value double?

Returns

JToken

implicit operator JToken(Guid?)

public static implicit operator JToken(Guid? value)

Parameters

value Guid?

Returns

JToken

implicit operator JToken(short?)

[CLSCompliant(false)]
public static implicit operator JToken(short? value)

Parameters

value short?

Returns

JToken

implicit operator JToken(int?)

public static implicit operator JToken(int? value)

Parameters

value int?

Returns

JToken

implicit operator JToken(long?)

public static implicit operator JToken(long? value)

Parameters

value long?

Returns

JToken

implicit operator JToken(sbyte?)

[CLSCompliant(false)]
public static implicit operator JToken(sbyte? value)

Parameters

value sbyte?

Returns

JToken

implicit operator JToken(float?)

public static implicit operator JToken(float? value)

Parameters

value float?

Returns

JToken

implicit operator JToken(TimeSpan?)

public static implicit operator JToken(TimeSpan? value)

Parameters

value TimeSpan?

Returns

JToken

implicit operator JToken(ushort?)

[CLSCompliant(false)]
public static implicit operator JToken(ushort? value)

Parameters

value ushort?

Returns

JToken

implicit operator JToken(uint?)

[CLSCompliant(false)]
public static implicit operator JToken(uint? value)

Parameters

value uint?

Returns

JToken

implicit operator JToken(ulong?)

[CLSCompliant(false)]
public static implicit operator JToken(ulong? value)

Parameters

value ulong?

Returns

JToken

implicit operator JToken(sbyte)

[CLSCompliant(false)]
public static implicit operator JToken(sbyte value)

Parameters

value sbyte

Returns

JToken

implicit operator JToken(float)

public static implicit operator JToken(float value)

Parameters

value float

Returns

JToken

implicit operator JToken(string?)

public static implicit operator JToken(string? value)

Parameters

value string

Returns

JToken

implicit operator JToken(TimeSpan)

public static implicit operator JToken(TimeSpan value)

Parameters

value TimeSpan

Returns

JToken

implicit operator JToken(ushort)

[CLSCompliant(false)]
public static implicit operator JToken(ushort value)

Parameters

value ushort

Returns

JToken

implicit operator JToken(uint)

[CLSCompliant(false)]
public static implicit operator JToken(uint value)

Parameters

value uint

Returns

JToken

implicit operator JToken(ulong)

[CLSCompliant(false)]
public static implicit operator JToken(ulong value)

Parameters

value ulong

Returns

JToken

implicit operator JToken(Uri?)

public static implicit operator JToken(Uri? value)

Parameters

value Uri

Returns

JToken