Click or drag to resize
Json.NET

JObject Class

 
Represents a JSON object.
Inheritance Hierarchy

Namespace:  Newtonsoft.Json.Linq
Assembly:  Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db
Syntax
C#
Copy
public class JObject : JContainer, IDictionary<string, JToken>, 
	ICollection<KeyValuePair<string, JToken>>, IEnumerable<KeyValuePair<string, JToken>>, 
	IEnumerable, INotifyPropertyChanged, ICustomTypeDescriptor, INotifyPropertyChanging

The JObject type exposes the following members.

Constructors
  NameDescription
Public methodJObject
Initializes a new instance of the JObject class.
Public methodJObject(Object)
Initializes a new instance of the JObject class with the specified content.
Public methodJObject(Object)
Initializes a new instance of the JObject class with the specified content.
Public methodJObject(JObject)
Initializes a new instance of the JObject class from another JObject object.
Top
Properties
  NameDescription
Protected propertyChildrenTokens
Gets the container's children tokens.
(Overrides JContainerChildrenTokens.)
Public propertyCount
Gets the count of child JSON tokens.
(Inherited from JContainer.)
Public propertyFirst
Get the first child token of this token.
(Inherited from JContainer.)
Public propertyHasValues
Gets a value indicating whether this token has child tokens.
(Inherited from JContainer.)
Public propertyItemObject
Gets the JToken with the specified key.
(Overrides JTokenItemObject.)
Public propertyItemString
Gets or sets the JToken with the specified property name.
Public propertyLast
Get the last child token of this token.
(Inherited from JContainer.)
Public propertyNext
Gets the next sibling token of this node.
(Inherited from JToken.)
Public propertyParent
Gets or sets the parent.
(Inherited from JToken.)
Public propertyPath
Gets the path of the JSON token.
(Inherited from JToken.)
Public propertyPrevious
Gets the previous sibling token of this node.
(Inherited from JToken.)
Public propertyRoot
Gets the root JToken of this JToken.
(Inherited from JToken.)
Public propertyType
Gets the node type for this JToken.
(Overrides JTokenType.)
Top
Methods
  NameDescription
Public methodAdd(Object)
Adds the specified content as children of this JToken.
(Inherited from JContainer.)
Public methodAdd(String, JToken)
Adds the specified property name.
Public methodAddAfterSelf
Adds the specified content immediately after this token.
(Inherited from JToken.)
Public methodAddAnnotation
Adds an object to the annotation list of this JToken.
(Inherited from JToken.)
Public methodAddBeforeSelf
Adds the specified content immediately before this token.
(Inherited from JToken.)
Public methodAddFirst
Adds the specified content as the first children of this JToken.
(Inherited from JContainer.)
Public methodAfterSelf
Returns a collection of the sibling tokens after this token, in document order.
(Inherited from JToken.)
Public methodAncestors
Returns a collection of the ancestor tokens of this token.
(Inherited from JToken.)
Public methodAncestorsAndSelf
Returns a collection of tokens that contain this token, and the ancestors of this token.
(Inherited from JToken.)
Public methodAnnotation(Type)
Gets the first annotation object of the specified type from this JToken.
(Inherited from JToken.)
Public methodAnnotationT
Get the first annotation object of the specified type from this JToken.
(Inherited from JToken.)
Public methodAnnotations(Type)
Gets a collection of annotations of the specified type for this JToken.
(Inherited from JToken.)
Public methodAnnotationsT
Gets a collection of annotations of the specified type for this JToken.
(Inherited from JToken.)
Public methodBeforeSelf
Returns a collection of the sibling tokens before this token, in document order.
(Inherited from JToken.)
Public methodChildren
Returns a collection of the child tokens of this token, in document order.
(Inherited from JContainer.)
Public methodContainsKey
Determines whether the JSON object has the specified property name.
Public methodCreateReader
Creates a JsonReader for this token.
(Inherited from JToken.)
Public methodCreateWriter
Creates a JsonWriter that can be used to add tokens to the JToken.
(Inherited from JContainer.)
Public methodDeepClone
Creates a new instance of the JToken. All child tokens are recursively cloned.
(Inherited from JToken.)
Public methodDescendants
Returns a collection of the descendant tokens for this token in document order.
(Inherited from JContainer.)
Public methodDescendantsAndSelf
Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order.
(Inherited from JContainer.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberFromObject(Object)
Creates a JObject from an object.
Public methodStatic memberFromObject(Object, JsonSerializer)
Creates a JObject from an object.
Public methodGetEnumerator
Returns an enumerator that can be used to iterate through the collection.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetMetaObject
Returns the DynamicMetaObject responsible for binding operations performed on this object.
(Overrides JTokenGetMetaObject(Expression).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue(String)
Gets the JToken with the specified property name.
Public methodGetValue(String, StringComparison)
Gets the JToken with the specified property name. The exact property name will be searched for first and if no matching property is found then the StringComparison will be used to match a property.
Public methodStatic memberLoad(JsonReader)
Loads a JObject from a JsonReader.
Public methodStatic memberLoad(JsonReader, JsonLoadSettings)
Loads a JObject from a JsonReader.
Public methodStatic memberLoadAsync(JsonReader, CancellationToken)
Asynchronously loads a JObject from a JsonReader.
Public methodStatic memberLoadAsync(JsonReader, JsonLoadSettings, CancellationToken)
Asynchronously loads a JObject from a JsonReader.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMerge(Object)
Merge the specified content into this JToken.
(Inherited from JContainer.)
Public methodMerge(Object, JsonMergeSettings)
Merge the specified content into this JToken using JsonMergeSettings.
(Inherited from JContainer.)
Protected methodOnAddingNew
Raises the AddingNew event.
(Inherited from JContainer.)
Protected methodOnCollectionChanged
Raises the CollectionChanged event.
(Inherited from JContainer.)
Protected methodOnListChanged
Raises the ListChanged event.
(Inherited from JContainer.)
Protected methodOnPropertyChanged
Raises the PropertyChanged event with the provided arguments.
Protected methodOnPropertyChanging
Raises the PropertyChanging event with the provided arguments.
Public methodStatic memberCode exampleParse(String)
Load a JObject from a string that contains JSON.
Public methodStatic memberCode exampleParse(String, JsonLoadSettings)
Load a JObject from a string that contains JSON.
Public methodProperties
Gets an IEnumerableT of JProperty of this object's properties.
Public methodProperty(String)
Gets a JProperty with the specified name.
Public methodProperty(String, StringComparison)
Gets the JProperty with the specified name. The exact name will be searched for first and if no matching property is found then the StringComparison will be used to match a property.
Public methodPropertyValues
Gets a JEnumerableT of JToken of this object's property values.
Public methodRemove
Removes this token from its parent.
(Inherited from JToken.)
Public methodRemove(String)
Removes the property with the specified name.
Public methodRemoveAll
Removes the child nodes from this token.
(Inherited from JContainer.)
Public methodRemoveAnnotations(Type)
Removes the annotations of the specified type from this JToken.
(Inherited from JToken.)
Public methodRemoveAnnotationsT
Removes the annotations of the specified type from this JToken.
(Inherited from JToken.)
Public methodReplace
Replaces this token with the specified token.
(Inherited from JToken.)
Public methodReplaceAll
Replaces the child nodes of this token with the specified content.
(Inherited from JContainer.)
Public methodSelectToken(String)
Selects a JToken using a JPath expression. Selects the token that matches the object path.
(Inherited from JToken.)
Public methodSelectToken(String, Boolean)
Selects a JToken using a JPath expression. Selects the token that matches the object path.
(Inherited from JToken.)
Public methodSelectTokens(String)
Selects a collection of elements using a JPath expression.
(Inherited from JToken.)
Public methodSelectTokens(String, Boolean)
Selects a collection of elements using a JPath expression.
(Inherited from JToken.)
Public methodToObject(Type)
Creates an instance of the specified .NET type from the JToken.
(Inherited from JToken.)
Public methodToObject(Type, JsonSerializer)
Creates an instance of the specified .NET type from the JToken using the specified JsonSerializer.
(Inherited from JToken.)
Public methodToObjectT
Creates an instance of the specified .NET type from the JToken.
(Inherited from JToken.)
Public methodToObjectT(JsonSerializer)
Creates an instance of the specified .NET type from the JToken using the specified JsonSerializer.
(Inherited from JToken.)
Public methodToString
Returns the indented JSON for this token.
(Inherited from JToken.)
Public methodToString(Formatting, JsonConverter)
Returns the JSON for this token using the given formatting and converters.
(Inherited from JToken.)
Public methodTryGetValue(String, JToken)
Tries to get the JToken with the specified property name.
Public methodTryGetValue(String, StringComparison, JToken)
Tries to get the JToken with the specified property name. The exact property name will be searched for first and if no matching property is found then the StringComparison will be used to match a property.
Public methodValueT
Gets the JToken with the specified key converted to the specified type.
(Inherited from JToken.)
Public methodValuesT
Returns a collection of the child values of this token, in document order.
(Inherited from JContainer.)
Public methodWriteTo
Writes this token to a JsonWriter.
(Overrides JTokenWriteTo(JsonWriter, JsonConverter).)
Public methodWriteToAsync(JsonWriter, JsonConverter)
Writes this token to a JsonWriter asynchronously.
(Inherited from JToken.)
Public methodWriteToAsync(JsonWriter, CancellationToken, JsonConverter)
Writes this token to a JsonWriter asynchronously.
(Overrides JTokenWriteToAsync(JsonWriter, CancellationToken, JsonConverter).)
Top
Events
  NameDescription
Public eventAddingNew
Occurs before an item is added to the collection.
(Inherited from JContainer.)
Public eventCollectionChanged
Occurs when the items list of the collection has changed, or the collection is reset.
(Inherited from JContainer.)
Public eventListChanged
Occurs when the list changes or an item in the list changes.
(Inherited from JContainer.)
Public eventPropertyChanged
Occurs when a property value changes.
Public eventPropertyChanging
Occurs when a property value is changing.
Top
Extension Methods
  NameDescription
Public Extension MethodIsValid(JsonSchema)Overloaded.

Determines whether the JToken is valid.

Caution note Caution
JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details.
(Defined by Extensions.)
Public Extension MethodIsValid(JsonSchema, IListString)Overloaded.

Determines whether the JToken is valid.

Caution note Caution
JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details.
(Defined by Extensions.)
Public Extension MethodValidate(JsonSchema)Overloaded.

Validates the specified JToken.

Caution note Caution
JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details.
(Defined by Extensions.)
Public Extension MethodValidate(JsonSchema, ValidationEventHandler)Overloaded.

Validates the specified JToken.

Caution note Caution
JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details.
(Defined by Extensions.)
Top
Examples
Parsing a JSON Object from Text
Copy
string json = @"{
  CPU: 'Intel',
  Drives: [
    'DVD read/writer',
    '500 gigabyte hard drive'
  ]
}";

JObject o = JObject.Parse(json);
See Also