Component: XML JSON Parser (Runtime Tools): Difference between revisions

Latest revision as of 14:23, 13 July 2026

Author	MatrixTSL
Version	1.0
Category	Runtime Tools

XML JSON Parser component

A component designed to simplify the collection of data from XML and JSON sources. Parses the raw data and creates a dynamic representation of the data that is easy to navigate and interrogate. Also allows the objects to be manually created or edited and then re-exported as XML or JSON format.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_XMLParser.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_XMLParser.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

AddObject

	AddObject
Adds a tag at the selected location. Use the GetRootHandle and runtime API Tree functions . Returns the handle of the new object.
- HANDLE	ParentObject
The Object Handle to store the new tag inside
- STRING	Tag
Name of the object
- STRING	Data
data for the object (optional)
- HANDLE	Return

BuildJSONString

	BuildJSONString
Generate a JSON string based on the current objects inside the component.
- STRING	Return

BuildXMLString

	BuildXMLString
Generate a XML string based on the current objects inside the component.
- STRING	Return

ClearObjects

	ClearObjects
Deletes all object data ready for fresh input
- VOID	Return

DeleteObject

	DeleteObject
Deletes a selected tag object.
- HANDLE	Object
Handle to the object
- BOOL	Return

FindNextObject

	FindNextObject
Finds the next instance of an object following a GetObject* call. Returns the first matching path from the last search. Returns 0 if the path was not found.
- STRING	SubObjPath
e.g. "item.title"
- HANDLE	Return

FindNextObjectString

	FindNextObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the last search
- STRING	SubObjPath
e.g. "item.title"
- STRING	Return

FindObject

	FindObject
Finds the first instance of an object. Returns the first matching path from the root. Returns 0 if the path was not found.
- STRING	ObjPath
e.g. "rss.channel.title"
- HANDLE	Return

FindObjectString

	FindObjectString
Searches for and then collects the data string from the specified path. Returns the first matching path from the root.
- STRING	ObjPath
e.g. "rss.channel.title"
- STRING	Return

GetObjectString

	GetObjectString
Collects the data string from the specified object.
- HANDLE	Object
Handle to the object
- STRING	Return

GetObjectTag

	GetObjectTag
Collects the tag string from the specified object.
- HANDLE	Object
Handle to the object
- STRING	Return

GetRootHandle

	GetRootHandle
Allows for user to step through the objects manually using the inbuilt runtime api calls.
- HANDLE	Return

ParseJSONDataString

	ParseJSONDataString
Parses JSON formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the JSON
- STRING	Data
JSON Data string, can be a chunk of a file at a time
- UINT	Length
Number of Bytes to process
- VOID	Return

ParseXMLDataString

	ParseXMLDataString
Parses XML formatted data in a piecemeal format as and when file data is available. Creates objects to store the contents of the XML.
- STRING	Data
XML Data string, can be a chunk of a file at a time
- UINT	Length
Number of bytes to process
- VOID	Return

SetObjectString

	SetObjectString
Sets the data string of an existing object.
- HANDLE	Object
Handle to the object
- STRING	Data

- VOID	Return

SetObjectTag

	SetObjectTag
Sets the tag name of an existing object.
- HANDLE	Object
Handle to the object
- STRING	Tag

- VOID	Return

Property reference

	Properties

@@ Line 65: / Line 65: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddObject'''
+| width="90%" class="mtx-class-macrohead" | '''AddObject'''
 |-
 | colspan="2" | Adds a tag at the selected location.  Use the GetRootHandle and runtime API Tree functions . Returns the handle of the new object.&nbsp;
@@ Line 94: / Line 94: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BuildJSONString'''
+| width="90%" class="mtx-class-macrohead" | '''BuildJSONString'''
 |-
 | colspan="2" | Generate a JSON string based on the current objects inside the component.&nbsp;
@@ Line 108: / Line 108: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BuildXMLString'''
+| width="90%" class="mtx-class-macrohead" | '''BuildXMLString'''
 |-
 | colspan="2" | Generate a XML string based on the current objects inside the component.&nbsp;
@@ Line 122: / Line 122: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearObjects'''
+| width="90%" class="mtx-class-macrohead" | '''ClearObjects'''
 |-
 | colspan="2" | Deletes all object data ready for fresh input&nbsp;
@@ Line 136: / Line 136: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DeleteObject'''
+| width="90%" class="mtx-class-macrohead" | '''DeleteObject'''
 |-
 | colspan="2" | Deletes a selected tag object.&nbsp;
@@ Line 155: / Line 155: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FindNextObject'''
+| width="90%" class="mtx-class-macrohead" | '''FindNextObject'''
 |-
 | colspan="2" | Finds the next instance of an object following a GetObject* call. Returns the first matching path from the last search. Returns 0 if the path was not found.&nbsp;
@@ Line 174: / Line 174: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FindNextObjectString'''
+| width="90%" class="mtx-class-macrohead" | '''FindNextObjectString'''
 |-
 | colspan="2" | Searches for and then collects the data string from the specified path. Returns the first matching path from the last search&nbsp;
@@ Line 193: / Line 193: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FindObject'''
+| width="90%" class="mtx-class-macrohead" | '''FindObject'''
 |-
 | colspan="2" | Finds the first instance of an object. Returns the first matching path from the root. Returns 0 if the path was not found.&nbsp;
@@ Line 212: / Line 212: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FindObjectString'''
+| width="90%" class="mtx-class-macrohead" | '''FindObjectString'''
 |-
 | colspan="2" | Searches for and then collects the data string from the specified path. Returns the first matching path from the root.&nbsp;
@@ Line 231: / Line 231: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetObjectString'''
+| width="90%" class="mtx-class-macrohead" | '''GetObjectString'''
 |-
 | colspan="2" | Collects the data string from the specified object.&nbsp;
@@ Line 250: / Line 250: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetObjectTag'''
+| width="90%" class="mtx-class-macrohead" | '''GetObjectTag'''
 |-
 | colspan="2" | Collects the tag string from the specified object.&nbsp;
@@ Line 269: / Line 269: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRootHandle'''
+| width="90%" class="mtx-class-macrohead" | '''GetRootHandle'''
 |-
 | colspan="2" | Allows for user to step through the objects manually using the inbuilt runtime api calls.&nbsp;
@@ Line 283: / Line 283: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ParseJSONDataString'''
+| width="90%" class="mtx-class-macrohead" | '''ParseJSONDataString'''
 |-
 | colspan="2" | Parses JSON formatted data in a piecemeal format as and when file data is available.  Creates objects to store the contents of the JSON &nbsp;
@@ Line 307: / Line 307: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ParseXMLDataString'''
+| width="90%" class="mtx-class-macrohead" | '''ParseXMLDataString'''
 |-
 | colspan="2" | Parses XML formatted data in a piecemeal format as and when file data is available.  Creates objects to store the contents of the XML.&nbsp;
@@ Line 331: / Line 331: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetObjectString'''
+| width="90%" class="mtx-class-macrohead" | '''SetObjectString'''
 |-
 | colspan="2" | Sets the data string of an existing object.&nbsp;
@@ Line 355: / Line 355: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetObjectTag'''
+| width="90%" class="mtx-class-macrohead" | '''SetObjectTag'''
 |-
 | colspan="2" | Sets the tag name of an existing object.&nbsp;
@@ Line 380: / Line 380: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |}

SteveT (talk | contribs)