Programmer Guide/Macro Library/BXMLDoc - Revision history

Jw: /* "Set" functions */

2019-10-01T08:41:44Z

"Set" functions

← Older revision		Revision as of 10:41, 1 October 2019
Line 210:		Line 210:

	=="Set" functions==		=="Set" functions==
	* This group of functions was originally developed, to deal with elements of type '''Set''' with the special unique id attribute '''ID'''. This implementation was modified, because the attribute '''ID''' is now used as a unique identifier for elements of any type.		* This group of functions was originally developed to deal with elements of type '''Set''' with the special unique id attribute '''ID'''. This implementation was modified, because the attribute '''ID''' is now used as a unique identifier for elements of any type.

	===ListSetElements===		===ListSetElements===

Jw: /* FormatIRef */

2019-10-01T08:41:14Z

FormatIRef

← Older revision		Revision as of 10:41, 1 October 2019
Line 196:		Line 196:
	:;<var>pos</var>: The XML element position or <code>*</code> for the current element.		:;<var>pos</var>: The XML element position or <code>*</code> for the current element.
	;Result: A reference (IRef) to the selected element or an empty string.		;Result: A reference (IRef) to the selected element or an empty string.
	;Generates the internal XML reference string for the specified element at position <var>pos</var>. This string can only be created if all elements in the path except the root element have an ID attribute.		;Description:Generates the internal XML reference string for the specified element at position <var>pos</var>. This string can only be created if all elements in the path except the root element have an ID attribute.
	;see also: commands [[Programmer_Guide/Command_Reference/IREF\|IREF]] and [[Programmer_Guide/Command_Reference/POSITION\|POSITION]]		;see also: commands [[Programmer_Guide/Command_Reference/IREF\|IREF]] and [[Programmer_Guide/Command_Reference/POSITION\|POSITION]]

Jw: /* SelectIRef */

2019-06-24T06:36:54Z

SelectIRef

← Older revision		Revision as of 08:36, 24 June 2019
Line 190:		Line 190:

	====SelectIRef====		====SelectIRef====
	~~;<code><var>bxmldoc<~~/~~var>~~ SelectIRef ~~[ <var>pos</var>=* ; <var>in</var>=0 ]</code>:~~		{{/SelectIRef}}
	~~:;<var>pos</var>: An (unique internal) element reference, a xml-position or the character <code>*</code> for the current element.~~
	~~:;<var>in</var>: Go into the selected element (<code>1</code>) or not (<code>0</code>).~~
	~~;Result: 0 for success or an errorcode~~
	;Description: Selects the element referred to by <var>pos</var>. A reference a file item position string, an internal XML reference or the value * (= current element) can be used. If the element is selected successful and <var>in</var> equals <code>1</code> the child element level of the element is selected. You can create an IRef for an element with the member function <code>FormatIRef</code>.
	~~;see also: commands [[Programmer_Guide/Command_Reference/IREF\|IREF]] and [[Programmer_Guide/Command_Reference/POSITION\|POSITION]]~~

	====FormatIRef====		====FormatIRef====

Toni at 13:19, 2 March 2018

2018-03-02T13:19:29Z

← Older revision		Revision as of 15:19, 2 March 2018
Line 3:		Line 3:
	:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]		:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]

			This class implements a general xml-document. It is mainly used to implement the common part of the two main {{STx}} documents: the project <code>BDataSet</code> and the workspace <code>BSTXIni</code>.

	==Construction==		==Construction==

Toni: /* "Set" functions */

2018-03-02T13:16:31Z

"Set" functions

← Older revision		Revision as of 15:16, 2 March 2018
Line 216:		Line 216:
	* This group of functions was originally developed, to deal with elements of type '''Set''' with the special unique id attribute '''ID'''. This implementation was modified, because the attribute '''ID''' is now used as a unique identifier for elements of any type.		* This group of functions was originally developed, to deal with elements of type '''Set''' with the special unique id attribute '''ID'''. This implementation was modified, because the attribute '''ID''' is now used as a unique identifier for elements of any type.

	===ListSetElements====		===ListSetElements===
	<code><var>bxmldoc</var> ListSetElements [ <var>table</var>=* ; <var>iref</var>=* ]</code>		<code><var>bxmldoc</var> ListSetElements [ <var>table</var>=* ; <var>iref</var>=* ]</code>
	:;<var>table</var>: simple table-item to store result; if <code>*</code> is used a new table is created		:;<var>table</var>: simple table-item to store result; if <code>*</code> is used a new table is created
Line 223:		Line 223:
	;Description: Lists all element id's on the current level (<var>iref</var>=*) or inside the specified set-element. If a table-item is passed, it is emptied before the id list is stored, otherwise a new table is created.		;Description: Lists all element id's on the current level (<var>iref</var>=*) or inside the specified set-element. If a table-item is passed, it is emptied before the id list is stored, otherwise a new table is created.

	====FindSetElement====		===FindSetElement===
	<code><var>bxmldoc</var> FindSetElement [ <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>		<code><var>bxmldoc</var> FindSetElement [ <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>
	:;<var>tag</var>: element tag; use <code>*</code> for all elements		:;<var>tag</var>: element tag; use <code>*</code> for all elements
Line 231:		Line 231:
	;Description: Find the (first element) with the specified <var>tag</var> (* = search all element tags) and <var>id</var>. For the matching of tag and id a case-sensitive comparison is used! If no <var>iref</var> is specified, the current level is searched from the beginning, otherwise the search is performed inside the specified set.		;Description: Find the (first element) with the specified <var>tag</var> (* = search all element tags) and <var>id</var>. For the matching of tag and id a case-sensitive comparison is used! If no <var>iref</var> is specified, the current level is searched from the beginning, otherwise the search is performed inside the specified set.

	====AddSetElement====		===AddSetElement===
	<code><var>bxmldoc</var> AddSetElement [ <var>tag</var> ; <var>id</var> ; <var>iref</var>=* ]</code>		<code><var>bxmldoc</var> AddSetElement [ <var>tag</var> ; <var>id</var> ; <var>iref</var>=* ]</code>
	:;<var>tag</var>: element tag		:;<var>tag</var>: element tag
Line 239:		Line 239:
	;Description: Create a new element with specified tag and id in the set selected by <var>iref</var>. If the specified set does not exist, it will be created. If a set must be created, for each set element the tag <code>SET</code> is used by default, but it is possible to specify another tag in the argument <code>ref</code> with the format: <code>/setid/.../settag:setid/.../</code>. If the element is created, the new element is selected, otherwise the position is not changed. If the element exists already, it is selected but not changed.		;Description: Create a new element with specified tag and id in the set selected by <var>iref</var>. If the specified set does not exist, it will be created. If a set must be created, for each set element the tag <code>SET</code> is used by default, but it is possible to specify another tag in the argument <code>ref</code> with the format: <code>/setid/.../settag:setid/.../</code>. If the element is created, the new element is selected, otherwise the position is not changed. If the element exists already, it is selected but not changed.

	====LoadSetElement====		===LoadSetElement===
	<code><var>bxmldoc</var> LoadSetElement [ <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>		<code><var>bxmldoc</var> LoadSetElement [ <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>
	;Result: The loaded data object (table-item, value returned from <code>LoadData</code>) or an empty string.		;Result: The loaded data object (table-item, value returned from <code>LoadData</code>) or an empty string.
	:Description: This function uses the call <code><var>bxmldoc</var> FindSetElement <var>tag</var>;<var>id</var>;<var>iref</var></code> to select the element and the call <code><var>bxmldoc</var> LoadData</var></code> to load the content of the selected element. If element selection or loading data failes (error), the file position is not changed, otherwise (success) the loaded element is selected.		:Description: This function uses the call <code><var>bxmldoc</var> FindSetElement <var>tag</var>;<var>id</var>;<var>iref</var></code> to select the element and the call <code><var>bxmldoc</var> LoadData</var></code> to load the content of the selected element. If element selection or loading data failes (error), the file position is not changed, otherwise (success) the loaded element is selected.

	====SaveSetElement====		===SaveSetElement===
	<code><var>bxmldoc</var> SaveSetElement [ <var>item</var> ; <var>del</var>=0 ; <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>		<code><var>bxmldoc</var> SaveSetElement [ <var>item</var> ; <var>del</var>=0 ; <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>
	;Result: 0 if the data item was saved successful and 1 otherwise		;Result: 0 if the data item was saved successful and 1 otherwise
	:Description: This function uses the call <code><var>bxmldoc</var> AddSetElement <var>tag</var>;<var>id</var>;<var>iref</var></code> to select or create the element and the call <code><var>bxmldoc</var> SaveData</var></code> to save the item into the element. If element selection or save operation failes (error), the file position is not changed, otherwise (success) the created/updated element is selected.		:Description: This function uses the call <code><var>bxmldoc</var> AddSetElement <var>tag</var>;<var>id</var>;<var>iref</var></code> to select or create the element and the call <code><var>bxmldoc</var> SaveData</var></code> to save the item into the element. If element selection or save operation failes (error), the file position is not changed, otherwise (success) the created/updated element is selected.

	====DeleteSetElement====		===DeleteSetElement===
	<code><var>bxmldoc</var> DeleteSetElement [ <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>		<code><var>bxmldoc</var> DeleteSetElement [ <var>tag</var>=* ; <var>id</var>=* ; <var>iref</var>=* ]</code>
	;Result: 0 if the element was deleted and 1 otherwise		;Result: 0 if the element was deleted and 1 otherwise

Toni at 13:15, 2 March 2018

2018-03-02T13:15:46Z

← Older revision		Revision as of 15:15, 2 March 2018
Line 3:		Line 3:
	:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]		:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]


	~~{\|class="einrahmen"~~
	~~\|[[#Construction\|Construction]]~~
	\|
	\|-
	~~\|[[#Access control\|Access Control]]~~
	~~\|[[#Attach\|Attach]], [[#Detach\|Detach]]~~
	\|-
	~~\|[[#Query attributes\|Query attributes]]~~
	~~\|[[#GetFileItem\|GetFileItem]], [[#GetDocType\|GetDocType]], [[#GetPath\|GetPath]]~~
	\|-
	~~\|[[#File handling\|File handling]]~~
	~~\|[[#Load\|Load]], [[#Save\|Save]], [[#Close\|Close]]~~
	\|-
	~~\|[[#Global items\|Global items]]~~
	~~\|[[#AddGlobalItem\|GetDocType]], [[#AttachGlobalItem\|AttachGlobalItem]], [[#DetachGlobalItem\|DetachGlobalItem]], [[#DeleteGlobalItem\|DetachGlobalItem]]~~
	\|-
	~~\|[[#Element manipulation\|Element manipulation]]~~
	~~\|[[#AddElement\|AddElement]], [[#SetElement\|AddElement]], [[#GetElement\|AddElement]], [[#DeleteElement\|AddElement]]~~
	\|-
	~~\|[[#Data manipulation\|Data manipulation]]~~
	~~\|[[#GetDataType\|GetDataType]], [[#CreateXTable\|CreateXTable]], [[#LoadData\|LoadData]], [[#SaveData\|SaveData]]~~
	\|-
	~~\|[[#IRef functions\|IRef functions]]~~
	~~\|[[#SelectIRef\|SelectIRef]], [[#FormatIRef\|FormatIRef]], [[#UniqueID\|UniqueID]]~~
	\|-
	~~\|[[#"Set" functions\|"Set" functions]]~~
	\|[[#ListSetElement\|ListSetElement]], [[#FindSetElement\|FindSetElement]], [[#AddSetElement\|AddSetElement]], [[#LoadSetElement\|LoadSetElement]], [[#SaveSetElement\|SaveSetElement]], [[#DeleteSetElement\|DeleteSetElement]]
	\|-
	~~\|[[#Misc\|Misc. functions]]~~
	\|[[#SavePos\|SavePos]], [[#ResetPos\|ResetPos]], [[#ExtractSubDoc\|ExtractSubDoc]], [[#ResetSubDoc\|ResetSubDoc]], [[#DialogSelectElement\|DialogSelectElement]], [[#Table2VarSpace\|Table2VarSpace]], [[#VarSpace2Table\|VarSpace2Table]], [[#AFun\|AFun]]
	\|}

	==Construction==		==Construction==

Toni at 13:15, 2 March 2018

2018-03-02T13:15:07Z

← Older revision		Revision as of 15:15, 2 March 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}} - General XML Document}}~~__NOTOC__~~		{{DISPLAYTITLE:{{SUBPAGENAME}} - General XML Document}}
	:'''File''': BXMLDOC.STX, linked to library STX.LIB		:'''File''': BXMLDOC.STX, linked to library STX.LIB
	:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]		:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]

Toni at 13:14, 2 March 2018

2018-03-02T13:14:36Z

← Older revision		Revision as of 15:14, 2 March 2018
Line 5:		Line 5:

	{\|class="einrahmen"		{\|class="einrahmen"
	\|[[#Construction]]		\|[[#Construction\|Construction]]
	\|		\|
	\|-		\|-

Toni at 13:13, 2 March 2018

2018-03-02T13:13:59Z

← Older revision		Revision as of 15:13, 2 March 2018
Line 11:		Line 11:
	\|[[#Attach\|Attach]], [[#Detach\|Detach]]		\|[[#Attach\|Attach]], [[#Detach\|Detach]]
	\|-		\|-
	\|[[#Query attributes]]		\|[[#Query attributes\|Query attributes]]
	\|[[#GetFileItem\|GetFileItem]], [[#GetDocType\|GetDocType]], [[#GetPath\|GetPath]]		\|[[#GetFileItem\|GetFileItem]], [[#GetDocType\|GetDocType]], [[#GetPath\|GetPath]]
	\|-		\|-
	\|[[#File handling]]		\|[[#File handling\|File handling]]
	\|[[#Load\|Load]], [[#Save\|Save]], [[#Close\|Close]]		\|[[#Load\|Load]], [[#Save\|Save]], [[#Close\|Close]]
	\|-		\|-
	\|[[#Global items]]		\|[[#Global items\|Global items]]
	\|[[#AddGlobalItem\|GetDocType]], [[#AttachGlobalItem\|AttachGlobalItem]], [[#DetachGlobalItem\|DetachGlobalItem]], [[#DeleteGlobalItem\|DetachGlobalItem]]		\|[[#AddGlobalItem\|GetDocType]], [[#AttachGlobalItem\|AttachGlobalItem]], [[#DetachGlobalItem\|DetachGlobalItem]], [[#DeleteGlobalItem\|DetachGlobalItem]]
	\|-		\|-
	\|[[#Element manipulation]]		\|[[#Element manipulation\|Element manipulation]]
	\|[[#AddElement\|AddElement]], [[#SetElement\|AddElement]], [[#GetElement\|AddElement]], [[#DeleteElement\|AddElement]]		\|[[#AddElement\|AddElement]], [[#SetElement\|AddElement]], [[#GetElement\|AddElement]], [[#DeleteElement\|AddElement]]
	\|-		\|-
	\|[[#Data manipulation]]		\|[[#Data manipulation\|Data manipulation]]
	\|[[#GetDataType\|GetDataType]], [[#CreateXTable\|CreateXTable]], [[#LoadData\|LoadData]], [[#SaveData\|SaveData]]		\|[[#GetDataType\|GetDataType]], [[#CreateXTable\|CreateXTable]], [[#LoadData\|LoadData]], [[#SaveData\|SaveData]]
	\|-		\|-
	\|[[#IRef functions]]		\|[[#IRef functions\|IRef functions]]
	\|[[#SelectIRef\|SelectIRef]], [[#FormatIRef\|FormatIRef]], [[#UniqueID\|UniqueID]]		\|[[#SelectIRef\|SelectIRef]], [[#FormatIRef\|FormatIRef]], [[#UniqueID\|UniqueID]]
	\|-		\|-
	\|[[#"Set" functions]]		\|[[#"Set" functions\|"Set" functions]]
	\|[[#ListSetElement\|ListSetElement]], [[#FindSetElement\|FindSetElement]], [[#AddSetElement\|AddSetElement]], [[#LoadSetElement\|LoadSetElement]], [[#SaveSetElement\|SaveSetElement]], [[#DeleteSetElement\|DeleteSetElement]]		\|[[#ListSetElement\|ListSetElement]], [[#FindSetElement\|FindSetElement]], [[#AddSetElement\|AddSetElement]], [[#LoadSetElement\|LoadSetElement]], [[#SaveSetElement\|SaveSetElement]], [[#DeleteSetElement\|DeleteSetElement]]
	\|-		\|-
	\|[[#Misc]]		\|[[#Misc\|Misc. functions]]
	\|[[#SavePos\|SavePos]], [[#ResetPos\|ResetPos]], [[#ExtractSubDoc\|ExtractSubDoc]], [[#ResetSubDoc\|ResetSubDoc]], [[#DialogSelectElement\|DialogSelectElement]], [[#Table2VarSpace\|Table2VarSpace]], [[#VarSpace2Table\|VarSpace2Table]], [[#AFun\|AFun]]		\|[[#SavePos\|SavePos]], [[#ResetPos\|ResetPos]], [[#ExtractSubDoc\|ExtractSubDoc]], [[#ResetSubDoc\|ResetSubDoc]], [[#DialogSelectElement\|DialogSelectElement]], [[#Table2VarSpace\|Table2VarSpace]], [[#VarSpace2Table\|VarSpace2Table]], [[#AFun\|AFun]]
	\|}		\|}

Toni at 13:12, 2 March 2018

2018-03-02T13:12:35Z

← Older revision		Revision as of 15:12, 2 March 2018
Line 8:		Line 8:
	\|		\|
	\|-		\|-
	\|[[#Access control]]		\|[[#Access control\|Access Control]]
	\|[[#Attach\|Attach]], [[#Detach\|Detach]]		\|[[#Attach\|Attach]], [[#Detach\|Detach]]
	\|-		\|-

← Older revision		Revision as of 15:15, 2 March 2018
Line 3:		Line 3:
	:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]		:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]], '''Derived classes''': [[Programmer Guide/Macro Library/BSTXIni\|BSTXIni]], [[Programmer Guide/Macro Library/BDataSet\|BDataSet]]


	~~{\|class="einrahmen"~~
	~~\|[[#Construction\|Construction]]~~
	\|
	\|-
	~~\|[[#Access control\|Access Control]]~~
	~~\|[[#Attach\|Attach]], [[#Detach\|Detach]]~~
	\|-
	~~\|[[#Query attributes\|Query attributes]]~~
	~~\|[[#GetFileItem\|GetFileItem]], [[#GetDocType\|GetDocType]], [[#GetPath\|GetPath]]~~
	\|-
	~~\|[[#File handling\|File handling]]~~
	~~\|[[#Load\|Load]], [[#Save\|Save]], [[#Close\|Close]]~~
	\|-
	~~\|[[#Global items\|Global items]]~~
	~~\|[[#AddGlobalItem\|GetDocType]], [[#AttachGlobalItem\|AttachGlobalItem]], [[#DetachGlobalItem\|DetachGlobalItem]], [[#DeleteGlobalItem\|DetachGlobalItem]]~~
	\|-
	~~\|[[#Element manipulation\|Element manipulation]]~~
	~~\|[[#AddElement\|AddElement]], [[#SetElement\|AddElement]], [[#GetElement\|AddElement]], [[#DeleteElement\|AddElement]]~~
	\|-
	~~\|[[#Data manipulation\|Data manipulation]]~~
	~~\|[[#GetDataType\|GetDataType]], [[#CreateXTable\|CreateXTable]], [[#LoadData\|LoadData]], [[#SaveData\|SaveData]]~~
	\|-
	~~\|[[#IRef functions\|IRef functions]]~~
	~~\|[[#SelectIRef\|SelectIRef]], [[#FormatIRef\|FormatIRef]], [[#UniqueID\|UniqueID]]~~
	\|-
	~~\|[[#"Set" functions\|"Set" functions]]~~
	\|[[#ListSetElement\|ListSetElement]], [[#FindSetElement\|FindSetElement]], [[#AddSetElement\|AddSetElement]], [[#LoadSetElement\|LoadSetElement]], [[#SaveSetElement\|SaveSetElement]], [[#DeleteSetElement\|DeleteSetElement]]
	\|-
	~~\|[[#Misc\|Misc. functions]]~~
	\|[[#SavePos\|SavePos]], [[#ResetPos\|ResetPos]], [[#ExtractSubDoc\|ExtractSubDoc]], [[#ResetSubDoc\|ResetSubDoc]], [[#DialogSelectElement\|DialogSelectElement]], [[#Table2VarSpace\|Table2VarSpace]], [[#VarSpace2Table\|VarSpace2Table]], [[#AFun\|AFun]]
	\|}

	==Construction==		==Construction==