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

Name

Description

Child

Keyed 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)

ChildAt

Keyed 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)

ChildCount

Number 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)

ComponentClassName

ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)

ComponentMembers

ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)

ComponentPatternName

ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)

ComponentTag

Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)

ComponentType

ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)

ComponentTypeName

ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)

FirstChild

Returns a reference to the first child node, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

HasChildNodes

Returns true if the node has child nodes Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

IsArray

Returns true if the node resolves to a JSON value node that is a JSON Array node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

IsBoolean

Returns true if the node resolves to a JSON value node that can provide a boolean value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

IsDateTime

Returns true if the node resolves to a JSON value node that can provide a datetime value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

IsDecimal

Returns true if the node resolves to a JSON value node that can provide a decimal value Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

IsInt32

Returns 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)

IsInt64

Returns 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)

IsNull

Returns true if the node resolves to a JSON value node that is a JSON Null node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

IsObject

Returns true if the node resolves to a JSON value node that is a JSON Object node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

IsString

Returns true if the node resolves to a JSON value node that can provide a unicode string Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Item

Returns 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)

ItemAt

Returns a reference to the child node that has the supplied index, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

ItemCount

Number of child nodes Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

LastChild

Returns a reference to this node's last child, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Name

Name identifies the component Inherited from Object (PRIM_OBJT)

NextSibling

Returns a reference to this node's next sibling, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

NodeName

Returns the name assigned to this node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

NodeType

Returns the type of this node Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

NodeValue

Returns this node's value as a unicode string Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Owner

Owner owns this component Inherited from Object (PRIM_OBJT)

OwnerDocument

Returns a reference to this node's factory's document, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Parent

The 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)

ParentDocument

Returns a reference to this node's parent document, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

ParentNode

Returns a reference to this node's parent, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

PreviousSibling

Returns a reference to this node's previous sibling, otherwise *NULL Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

RootNode

Reference to JSON node assigned as the document root

Events

Name

Description

CreateInstance

CreateInstance is signalled when an instance of a component is created [Inherited from PRIM_JSON.Document (PRIM_JSON.Document)

DestroyInstance

DestroyInstance is signalled when an instance of a component is about to be destroyed [Inherited from PRIM_JSON.Document (PRIM_JSON.Document)

Methods

Name

Description

AsArray

Attempts 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

AsBoolean

Retrieves the value of the current JSON node as a boolean Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

AsDateTime

Retrieves the value of the current JSON node as a date/time Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

AsDecimal

Retrieves the value of the current JSON node as a decimal Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

AsInt32

Retrieves the value of the current JSON node as a 32-bit integer Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

AsInt64

Retrieves the value of the current JSON node as a 64-bit integer Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

AsObject

Attempts 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

AsString

Retrieves the value of the resolved JSON value node as a unicode string Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

Clone

Makes a copy of the current JSON node and recursively clones all the node's children Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

CloneNode

Makes 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

CreateArray

Creates a new JSON Array node

Result

CreateBoolean

Creates a new JSON Boolean node

Result, Value

CreateDateTime

Creates a new JSON datetime node

Result, Value

CreateDecimal

Creates a new JSON Decimal node

Result, Value

CreateFloat64

Creates a new JSON Float64 node

Result, Value

CreateInt32

Creates a new JSON Int32 node

Result, Value

CreateInt64

Creates a new JSON Int64 node

Result, Value

CreateIterator

Creates an iterator component that enables iteration through the node's children Inherited from PRIM_JSON.Node (PRIM_JSON.Node)

Result

CreateNull

Creates a new JSON Null node

Result

CreateNumber

Creates a new JSON Number node

Result, Value

CreateObject

Creates a new JSON Object node

Result

CreateRootArray

Creates a new JSON Array node and assigns the node as the document root

Result

CreateRootObject

Creates a new JSON Object node and assigns the node as the document root

Result

CreateString

Creates a new JSON String node

Result, Value

LoadFromFile

Utilizes 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

LoadFromString

Utilizes 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

RemoveAll

Method 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)

SaveToFile

Utilizes a JSON Writer initialized with the contents of specified file to write the current document's content as JSON

TextWriter

SaveToString

Utilizes 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

  • No labels