Class JArray

Represents a JSON array.

Inheritance
System.Object
JToken
JContainer
JArray
Implements
System.ICloneable
System.Dynamic.IDynamicMetaObjectProvider
System.ComponentModel.ITypedList
System.ComponentModel.IBindingList
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.Collections.Generic.IList<JToken>
System.Collections.Generic.ICollection<JToken>
System.Collections.Generic.IEnumerable<JToken>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Bayat.Json.Linq
Assembly: Bayat.Json.Runtime.dll
Syntax
public class JArray : JContainer, IJEnumerable<JToken>, IJsonLineInfo, ICloneable, IDynamicMetaObjectProvider, ITypedList, IBindingList, IList, ICollection, INotifyCollectionChanged, IList<JToken>, ICollection<JToken>, IEnumerable<JToken>, IEnumerable
Examples

Constructors

| Improve this Doc View Source

JArray()

Initializes a new instance of the JArray class.

Declaration
public JArray()
| Improve this Doc View Source

JArray(JArray)

Initializes a new instance of the JArray class from another JArray object.

Declaration
public JArray(JArray other)
Parameters
Type Name Description
JArray other

A JArray object to copy from.
| Improve this Doc View Source

JArray(Object)

Initializes a new instance of the JArray class with the specified content.

Declaration
public JArray(object content)
Parameters
Type Name Description
System.Object content

The contents of the array.
| Improve this Doc View Source

JArray(Object[])

Initializes a new instance of the JArray class with the specified content.

Declaration
public JArray(params object[] content)
Parameters
Type Name Description
System.Object[] content

The contents of the array.

Properties

| Improve this Doc View Source

ChildrenTokens

Gets the container's children tokens.

Declaration
protected override IList<JToken> ChildrenTokens { get; }
Property Value
Type Description
System.Collections.Generic.IList<JToken>

The container's children tokens.
Overrides
| Improve this Doc View Source

IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection<T> is read-only.

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
System.Boolean

true if the System.Collections.Generic.ICollection<T> is read-only; otherwise, false.
| Improve this Doc View Source

Item[Int32]

Gets or sets the JToken at the specified index.

Declaration
public JToken this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type Description
JToken
| Improve this Doc View Source

Item[Object]

Gets the JToken with the specified key.

Declaration
public override JToken this[object key] { get; set; }
Parameters
Type Name Description
System.Object key
Property Value
Type Description
JToken

The JToken with the specified key.
Overrides
| Improve this Doc View Source

Type

Gets the node type for this JToken.

Declaration
public override JTokenType Type { get; }
Property Value
Type Description
JTokenType

The type.
Overrides

Methods

| Improve this Doc View Source

Add(JToken)

Adds an item to the System.Collections.Generic.ICollection<T>.

Declaration
public void Add(JToken item)
Parameters
Type Name Description
JToken item

The object to add to the System.Collections.Generic.ICollection<T>.
Exceptions
Type Condition
System.NotSupportedException

The System.Collections.Generic.ICollection<T> is read-only.
| Improve this Doc View Source

Clear()

Removes all items from the System.Collections.Generic.ICollection<T>.

Declaration
public void Clear()
Exceptions
Type Condition
System.NotSupportedException

The System.Collections.Generic.ICollection<T> is read-only.
| Improve this Doc View Source

CloneToken()

Declaration
public override JToken CloneToken()
Returns
Type Description
JToken
Overrides
| Improve this Doc View Source

Contains(JToken)

Determines whether the System.Collections.Generic.ICollection<T> contains a specific value.

Declaration
public bool Contains(JToken item)
Parameters
Type Name Description
JToken item

The object to locate in the System.Collections.Generic.ICollection<T>.
Returns
Type Description
System.Boolean

true if item is found in the System.Collections.Generic.ICollection<T>; otherwise, false.
| Improve this Doc View Source

CopyTo(JToken[], Int32)

Copies to.

Declaration
public void CopyTo(JToken[] array, int arrayIndex)
Parameters
Type Name Description
JToken[] array

The array.
System.Int32 arrayIndex

Index of the array.
| Improve this Doc View Source

DeepEquals(JToken)

Declaration
public override bool DeepEquals(JToken node)
Parameters
Type Name Description
JToken node
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

FromObject(Object)

Creates a JArray from an object.

Declaration
public static JArray FromObject(object o)
Parameters
Type Name Description
System.Object o

The object that will be used to create JArray.
Returns
Type Description
JArray

A JArray with the values of the specified object
| Improve this Doc View Source

FromObject(Object, JsonSerializer)

Creates a JArray from an object.

Declaration
public static JArray FromObject(object o, JsonSerializer jsonSerializer)
Parameters
Type Name Description
System.Object o

The object that will be used to create JArray.
JsonSerializer jsonSerializer

The JsonSerializer that will be used to read the object.
Returns
Type Description
JArray

A JArray with the values of the specified object
| Improve this Doc View Source

GetDeepHashCode()

Declaration
public override int GetDeepHashCode()
Returns
Type Description
System.Int32
Overrides
| Improve this Doc View Source

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public IEnumerator<JToken> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<JToken>

A System.Collections.Generic.IEnumerator<T> that can be used to iterate through the collection.
| Improve this Doc View Source

IndexOf(JToken)

Determines the index of a specific item in the System.Collections.Generic.IList<T>.

Declaration
public int IndexOf(JToken item)
Parameters
Type Name Description
JToken item

The object to locate in the System.Collections.Generic.IList<T>.
Returns
Type Description
System.Int32

The index of item if found in the list; otherwise, -1.
| Improve this Doc View Source

IndexOfItem(JToken)

Declaration
public override int IndexOfItem(JToken item)
Parameters
Type Name Description
JToken item
Returns
Type Description
System.Int32
Overrides
| Improve this Doc View Source

Insert(Int32, JToken)

Inserts an item to the System.Collections.Generic.IList<T> at the specified index.

Declaration
public void Insert(int index, JToken item)
Parameters
Type Name Description
System.Int32 index

The zero-based index at which item should be inserted.
JToken item

The object to insert into the System.Collections.Generic.IList<T>.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

index is not a valid index in the System.Collections.Generic.IList<T>.
System.NotSupportedException

The System.Collections.Generic.IList<T> is read-only.
| Improve this Doc View Source

Load(JsonReader)

Loads an JArray from a JsonReader.

Declaration
public static JArray Load(JsonReader reader)
Parameters
Type Name Description
JsonReader reader

A JsonReader that will be read for the content of the JArray.
Returns
Type Description
JArray

A JArray that contains the JSON that was read from the specified JsonReader.
| Improve this Doc View Source

Load(JsonReader, JsonLoadSettings)

Loads an JArray from a JsonReader.

Declaration
public static JArray Load(JsonReader reader, JsonLoadSettings settings)
Parameters
Type Name Description
JsonReader reader

A JsonReader that will be read for the content of the JArray.
JsonLoadSettings settings

The JsonLoadSettings used to load the JSON. If this is null, default load settings will be used.
Returns
Type Description
JArray

A JArray that contains the JSON that was read from the specified JsonReader.
| Improve this Doc View Source

MergeItem(Object, JsonMergeSettings)

Declaration
public override void MergeItem(object content, JsonMergeSettings settings)
Parameters
Type Name Description
System.Object content
JsonMergeSettings settings
Overrides
| Improve this Doc View Source

Parse(String)

Load a JArray from a string that contains JSON.

Declaration
public static JArray Parse(string json)
Parameters
Type Name Description
System.String json

A System.String that contains JSON.
Returns
Type Description
JArray

A JArray populated from the string that contains JSON.
Examples
| Improve this Doc View Source

Parse(String, JsonLoadSettings)

Load a JArray from a string that contains JSON.

Declaration
public static JArray Parse(string json, JsonLoadSettings settings)
Parameters
Type Name Description
System.String json

A System.String that contains JSON.
JsonLoadSettings settings

The JsonLoadSettings used to load the JSON. If this is null, default load settings will be used.
Returns
Type Description
JArray

A JArray populated from the string that contains JSON.
Examples
| Improve this Doc View Source

Remove(JToken)

Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection<T>.

Declaration
public bool Remove(JToken item)
Parameters
Type Name Description
JToken item

The object to remove from the System.Collections.Generic.ICollection<T>.
Returns
Type Description
System.Boolean

true if item was successfully removed from the System.Collections.Generic.ICollection<T>; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection<T>.
Exceptions
Type Condition
System.NotSupportedException

The System.Collections.Generic.ICollection<T> is read-only.
| Improve this Doc View Source

RemoveAt(Int32)

Removes the System.Collections.Generic.IList<T> item at the specified index.

Declaration
public void RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

The zero-based index of the item to remove.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

index is not a valid index in the System.Collections.Generic.IList<T>.
System.NotSupportedException

The System.Collections.Generic.IList<T> is read-only.
| Improve this Doc View Source

WriteTo(JsonWriter, JsonConverter[])

Writes this token to a JsonWriter.

Declaration
public override void WriteTo(JsonWriter writer, params JsonConverter[] converters)
Parameters
Type Name Description
JsonWriter writer

A JsonWriter into which this method will write.
JsonConverter[] converters

A collection of JsonConverter which will be used when writing the token.
Overrides

Implements

System.ICloneable
System.Dynamic.IDynamicMetaObjectProvider
System.ComponentModel.ITypedList
System.ComponentModel.IBindingList
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods