RecursiveChildObjects

Parent Previous Next

RecursiveChildObjects


The RecursiveChildObjects node is used to map out the entire metadata for each object that matches the selector. RecursiveChildObjects nodes are most often used during the troubleshooting process when creating custom Structure Maps to help visually display the entire structure of an object as well as all of its properties in an unformatted manner. A RecursiveChildObjects node should contain no child nodes.


Important Note:

When using a RecursiveChildObjects node, the generated documentation will represent the structure of the extracted metadata, which may result in a large number of pages being generated that show the full metadata content.


Syntax

This RecursiveChildObjects node returns all children of the parent node and recursively maps out the entire metadata for each object within the Documentation:


<RecursiveChildObjects selector="./" />



Required Attributes

selector - Uses Path Grammar or an $Object Selector to select one or more objects that the current node applies to. The selector is always scoped to the parent node.


Optional Attributes

condition - Uses Path Grammar or an $Object Selector to dynamically show/hide nodes based on whether or not the Path Grammar or $Object Selector returns at least one object. The condition is always scoped to the parent node.


flag - Used in conjunction with the defaultTemplate.documentControl file to associate the current node's flag value with the name value as detailed within the defaultTemplate.documentControl file. During documentation, if the associated flag was set to "False", then DOC xPress will skip the current node and will not include it within the documentation.