OboxFill

OboxFill

OboxFill(windowID, oboxID), OboxFill(, oboxID), OboxFill

parameters: Identifier of a Windows and an ObjectTree

Stack

Stack	Position	Description
Stack(In)	Top	a collection
Stack(Out)	Top	-

For each element of the collection on the stack, the corresponding line is inserted in the ObjectBox below the currently selected element. If the ObjectBox does not support structured data(NODE SetFormat does not exist or does not exist for the type of the object to be inserted) at the selected object, no changes are made to the ObjectBox.

Stack

Stack	Position	Description
Stack(In)	Top	Index path
	Top 1	a collection
Stack(Out)	Top	-

Same as above, only the index path determines the sorting between the elements that are under the selected object (parent).

Stack

Stack	Position	Description
Stack(In)	Top	one object
Stack(Out)	Top	-

The object from the stack is placed under the selected object, if a suitable NODE SetFormat statement exists for the selected object.

Stack

Stack	Position	Description
Stack(In)	Top	]
	Top 1	Object On
	top 2	Object On-1
	. . .	. . .
	Top-n	O1
	Top n-1	[
Stack(Out)		-

Every object from the stack for which the currently selected object in the ObjectBox has a matching NODE SetFormat statement is appended below this selected object.

Comments:
OboxFill belongs to the Obox... command family.

If no object has been selected (e.g. by DeselectAll), an insert is made at the top level (below root), as with FillObox.

OboxFill only changes the window object. The modification of objects, especially the check of permissions of BackRefNames and similar, is only done when saving e.g. with AdjustStructure. OboxFill itself performs the insertion without any check.

If the subordinate objects of the selected object have not yet been read in (see SetLevels), this is done automatically, so that subordinate objects are always read in completely or not at all (no "half-read" direct substructures).

If an upper limit for the number of objects that can be filled in has been defined with the SetLimit command, this limit can suppress filling if it is exceeded. In the ObjectTree this is visualised by virtual "overflow" elements.

If OboxFill is called within the system event DROP (reaction to a drag and drop action) for the drag object, the drag object will be automatically sorted at the given position in insert mode Sibling.