Object

Parent Previous Next

Object


An Object is used within the Structure to create a single child page within the documentation for the first object that matches the selector.


Syntax

This Object node returns the child of the parent node with the name "Columns" to be included within the Documentation:


<Object selector="Columns" >

</Object>



Required Attributes

selector - Uses Path Grammar or an $Object Selector to select the first 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 the node 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.


templateKey - Used to explicitly override any rule and matches the object that match the selector with the specified templateKey.


Optional Child Nodes

ChildObjects - Used to create child page(s) within the documentation for each object that matches the selector.  


ChildObjectsSubStructure - Used to explicitly search for another Structure Map that matches the object type for each object that matches the selector.  


Object - Used to create a single child page within the documentation for each the first object that matches the selector.


RecursiveChildObjects - Used to recursively create the entire metadata tree for each object that matches the selector. This child node is most often used during the creation of a Structure Map to help display the entire structure of a set of objects.