TreeNode Class

The TreeNode class retrieves and represents any node in the Application Object Tree (AOT).

Syntax

class TreeNode extends Object

Run On

Called

Methods

	Method	Description
	AOTadd	Creates a subnode to the tree node in the Application Object Tree (AOT).
	AOTaddExtendedDataType	This method is not supported in Microsoft Dynamics AX. If you need to add a subnode of this type, use the instead.
	AOTaddRelation	This method is not supported in Microsoft Dynamics AX. If you need to add a subnode of this type, use the instead.
	AOTaddSubNode	Creates subnodes for extended data types and relations.
	AOTaddXref
	AOTAllowEdit
	AOTbitmapId	Returns the resource ID of the bitmap of the tree node.
	AOTchildNodeCount	Counts the number of child nodes that a given tree node has.
	AOTcompile	Compiles this node and its subnodes.
	AOTconfigure
	AOTdelete	Deletes the tree node in the development layer that you are currently working in.
	AOTDrop	Creates a copy of a specified tree node as a child to the TreeNode object.
	AOTDuplicate
	AOTedit	Opens the appropriate editor for this node.
	AOTendXref
	AOTfindChild	Finds the specified child node of this node.
	AOTfirstChild	Retrieves the first child of the tree node.
	AOTfirstChildEx
	AOTgetExecutableLineCount	Returns the number of executable lines of code for this node.
	AOTgetExecutableLines	Returns the executable lines of code for this node.
	AOTGetModel
	AOTgetProperties	Returns a string containing the properties of the tree node.
	AOTgetPropertiesExt
	AOTgetProperty
	AOTgetSource	Returns the source code of this node.
	AOTIncludeInCompare
	AOTinsert	Inserts a node among the subnodes of this node.
	AOTIsDirty
	AOTIsOld	Indicates whether this node is from a file found in the old model store.
	AOTIsPersisted	Indicates whether this node has been persisted in the model store.
	AOTIsProxyNode
	AOTiterator	Returns an object which can be used to iterate the child nodes of the tree node.
	AOTKernelHelpType
	AOTLayer	Returns the layer of the tree node.
	AOTLayers	Returns a collection of the layers the tree node is defined in.
	AOTload	Ensures that the object is loaded.
	AOTmakeXref	Compiles this node and its subtree in the AOT, updating the cross-reference system.
	AOTmessageLine	Writes text to the Application Object Tree (AOT) Message window.
	AOTMove
	AOTname	Returns the value of the name property of the node.
	AOTnewWindow	Opens a new AOT tree window with the tree node as the root.
	AOTnextSibling	Returns the next node on the same level as the tree node.
	AOTObjectNode	Indicates whether the node is an application object.
	AOToverlayBitmapId	Returns the resource ID of the overlay in the AOT associated with this node.
	AOTparent	Returns the parent node of the tree node.
	AOTprevious	Returns the previous sibling of this tree node.
	AOTrefresh	Refreshes the node with the latest changes to the .aod file.
	AOTregenerate
	AOTRename
	AOTrestore	Reloads this node from the disk, if applicable.
	AOTrun	Compiles this node and its subtree in the Application Object Tree (AOT).
	AOTsave	Saves an Application Object Tree (AOT) node.
	AOTSetModel
	AOTsetProperties
	AOTsetPropertiesExt
	AOTsetProperty
	AOTsetSource	Sets the source code of this node.
	AOTshowProperties	Opens the property sheet (if not already open) and shows the properties for this node.
	AOTtoolTip	Returns the tool tip associated with the tree node.
	AOTToString
	AOTtypeStr	Returns the internal string code for the element type used in XPO files.
	AOTUtilFileType	Retrieves the value of the UtilFileType enumeration type for the TreeNode object. The UtilFileType indicates which kind of file the application object is stored in.
	applObjectId	Returns the application object ID, if applicable.
	applObjectLayerMask	Returns a bitmask that specifies which layers contain this element.
	applObjectOldLayerMask	Returns a bitmask that specifies which layers contain this element in the baseline model store.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getNodeInLayer	Retrieves a version of the tree node from a specified layer.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hashKey
	makeCopy
	new	Initializes a new instance of the TreeNode class. (Overrides the new Method.)
	newObjectName	Returns a string that contains the name of the new element.
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Overrides the toString Method.)
	treeNodeExport	Exports this node and its subtree from the Application Object Tree (AOT).
	treeNodeName	Returns the name of the tree node.
	treeNodePath	Returns the unique path to the tree node within the Application Object Tree (AOT).
	treeNodeRelease	Releases the tree node explicitly.
	treeNodeType	Retrieves an instance of a TreeNodeType class that provides reflection information for the tree node.
	updateNodePermissions
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	utilElement	Returns a UtilElements record that is related to the node.
	utilIdElement	Returns a UtilIdElements record that is related to the node.
	validateNameCharacters
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::findNode	Returns a specified node in the Application Object Tree (AOT).
	::generateObjectName
	::getMaximumNodeNameLength
	::isNodeReferenceValid
	::isValidObjectName	Determines whether the string passed as an argument can be used as a name for a node in the Application Object Tree (AOT).
	::rootNode	Returns the root node of the AOT.

Top

Remarks

This class, and the classes that extend it, enable you to create, read, update, and delete X++ code and metadata. Make sure that the user has access to the development security key (SysDevelopment) before calling this API or APIs that are derived from this class.

The TreeNode class can be used to get a handle to any node in the AOT. The TreeNode class is a generic class in that it can be a reference to any type of node in the AOT.

In addition to providing access to some of the functions on the shortcut menu of the AOT, this class also contains methods that are used to maneuver in the tree. The TreeNodeTraverser class is also useful in navigating in the AOT.

The TreeNode::findNode and TreeNode::rootNode methods return a treeNode object from which you can maneuver to any other node.

Inheritance Hierarchy

Object Class
  TreeNode Class
    AOTTableFieldList Class
    ClassNode Class
    ControlNode Class
    Cue Class
    CueGroup Class
    CueReference Class
    DataSet Class
    DataSourceNode Class
    DocNode Class
    Form Class
    FormPart Class
    HelpDocSetNode Class
    InfoPart Class
    InfoPartField Class
    InfoPartGroup Class
    InfoPartLayout Class
    Job Class
    MemberFunction Class
    Menu Class
    MenuItem Class
    MenuReference Class
    ProjectGroupNode Class
    ProjectListNode Class
    ProjectNode Class
    Query Class
    QueryBuildDataSource Class
    QueryBuildFieldList Class
    QueryBuildLink Class
    QueryBuildRange Class
    QueryGroupByField Class
    QueryHavingFilter Class
    QueryOrderByField Class
    ReferenceNode Class
    Report Class
    ReportAutoDesignSpecs Class
    ReportControl Class
    ReportDesign Class
    ReportFieldGroup Class
    ReportSection Class
    ReportSectionGroup Class
    resourceNode Class
    SecureNode Class
    UserMenuList Class
    UserSetup Class
    VSItemNode Class
    VSProjectFolderNode Class
    VSProjectTypeNode Class
    webControlNode Class
    webListDefNode Class
    WebMenu Class
    WebMenuItem Class
    webModuleNode Class
    webPageDefNode Class
    webStaticFileNode Class

See Also

MemberFunction Class