PRIM_JSON.Document (PRIM_JSON.Document)

JSON node class that represents the root of a JSON document tree mapped from JSON content, and gives us the primary access to the document's data

Ancestors - PRIM_JSON.Node (PRIM_JSON.Node) Object (PRIM_OBJT)

Details

No detailed help is available for this feature

Properties

NameDescription
ChildKeyed property to access a PRIM_JSON.Member node as a child of a PRIM_JSON.Object node using the name of member Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ChildAtKeyed property to access a child node using an index. Provides access to children of a PRIM_JSON.Array node and the value node of a PRIM_JSON.Member node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ChildCountNumber of nodes that are children of the current node. For PRIM_JSON.Member nodes, it is the count of children of the node's Value node. Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
FirstChildReturns a reference to the first child node, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
HasChildNodesReturns true if the node has child nodes Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsArrayReturns true if the node resolves to a JSON value node that is a JSON Array node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsBooleanReturns true if the node resolves to a JSON value node that can provide a boolean value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsDateTimeReturns true if the node resolves to a JSON value node that can provide a datetime value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsDecimalReturns true if the node resolves to a JSON value node that can provide a decimal value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsInt32Returns true if the node resolves to a JSON value node that can provide a 32-bit integer value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsInt64Returns true if the node resolves to a JSON value node that can provide a 64-bit integer value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsNullReturns true if the node resolves to a JSON value node that is a JSON Null node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsObjectReturns true if the node resolves to a JSON value node that is a JSON Object node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
IsStringReturns true if the node resolves to a JSON value node that can provide a unicode string Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ItemReturns a reference to the child node that has a name that matches the key parameter, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ItemAtReturns a reference to the child node that has the supplied index, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ItemCountNumber of child nodes Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
LastChildReturns a reference to this node's last child, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
NameName identifies the component Inherited from Object (PRIM_OBJT)
NextSiblingReturns a reference to this node's next sibling, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
NodeNameReturns the name assigned to this node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
NodeTypeReturns the type of this node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
NodeValueReturns this node's value as a unicode string Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
OwnerDocumentReturns a reference to this node's factory's document, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ParentThe component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)
ParentDocumentReturns a reference to this node's parent document, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
ParentNodeReturns a reference to this node's parent, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
PreviousSiblingReturns a reference to this node's previous sibling, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
RootNodeReference to JSON node assigned as the document root

Events

NameDescription
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from PRIM_JSON.Document (PRIM_JSON.Document)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from PRIM_JSON.Document (PRIM_JSON.Document)

Methods

NameDescription
AsArrayAttempts to resolve current node as a PRIM_JSON.Array otherwise reports a runtime error. Document nodes resolve the root node and member nodes resolve the Value node. Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
AsBooleanRetrieves the value of the current JSON node as a boolean Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
AsDateTimeRetrieves the value of the current JSON node as a date/time Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
AsDecimalRetrieves the value of the current JSON node as a decimal Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
AsInt32Retrieves the value of the current JSON node as a 32-bit integer Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
AsInt64Retrieves the value of the current JSON node as a 64-bit integer Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
AsObjectAttempts to resolve current node as a PRIM_JSON.Object otherwise reports a runtime error. Document nodes resolve the root node and member nodes resolve the Value node. Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
AsStringRetrieves the value of the resolved JSON value node as a unicode string Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
CloneMakes a copy of the current JSON node and recursively clones all the node's children Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
CloneNodeMakes a copy of the current JSON node optionally recursively cloning all the node's children Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result, Deep
CreateArrayCreates a new JSON Array node
Result
CreateBooleanCreates a new JSON Boolean node
Result, Value
CreateDateTimeCreates a new JSON datetime node
Result, Value
CreateDecimalCreates a new JSON Decimal node
Result, Value
CreateFloat64Creates a new JSON Float64 node
Result, Value
CreateInt32Creates a new JSON Int32 node
Result, Value
CreateInt64Creates a new JSON Int64 node
Result, Value
CreateIteratorCreates an iterator component that enables iteration through the node's children Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
Result
CreateNullCreates a new JSON Null node
Result
CreateNumberCreates a new JSON Number node
Result, Value
CreateObjectCreates a new JSON Object node
Result
CreateRootArrayCreates a new JSON Array node and assigns the node as the document root
Result
CreateRootObjectCreates a new JSON Object node and assigns the node as the document root
Result
CreateStringCreates a new JSON String node
Result, Value
LoadFromFileUtilizes a JSON Reader initialized with the contents of specified file to create and populate an appropriate JSON node that then replaces this document's root node
TextReader
LoadFromStringUtilizes a JSON Reader initialized with specified input string to create and populate an appropriate JSON node that then replaces this document's root node
InputString
RemoveAllMethod for removing all children nodes of this node by setting each child node's parent to null Inherited from PRIM_JSON.Node (PRIM_JSON.Node)
SaveToFileUtilizes a JSON Writer initialized with the contents of specified file to write the current document's content as JSON
TextWriter
SaveToStringUtilizes a JSON Writer to create and initialize a unicode string by writing the current document's content as JSON
Result

See also

All Component Classes

Technical Reference