xMenuFunction Class

The xMenuFunction class represents an interface to other Microsoft Dynamics AX Application objects, providing an easy way to access and run any Form, Report, Job, Class, and Query.

Syntax

class xMenuFunction extends SecureNode

Run On

Called

Methods

	Method	Description
	AOTadd	Creates a subnode to the tree node in the Application Object Tree (AOT). (Inherited from TreeNode.)
	AOTaddExtendedDataType	This method is not supported in Microsoft Dynamics AX. If you need to add a subnode of this type, use the instead. (Inherited from TreeNode.)
	AOTaddRelation	This method is not supported in Microsoft Dynamics AX. If you need to add a subnode of this type, use the instead. (Inherited from TreeNode.)
	AOTaddSubNode	Creates subnodes for extended data types and relations. (Inherited from TreeNode.)
	AOTaddXref	(Inherited from TreeNode.)
	AOTAllowEdit	(Inherited from TreeNode.)
	AOTbitmapId	Returns the resource ID of the bitmap of the tree node. (Inherited from TreeNode.)
	AOTchildNodeCount	Counts the number of child nodes that a given tree node has. (Inherited from TreeNode.)
	AOTcompile	Compiles this node and its subnodes. (Inherited from TreeNode.)
	AOTconfigure	(Inherited from TreeNode.)
	AOTdelete	Deletes the tree node in the development layer that you are currently working in. (Inherited from TreeNode.)
	AOTDrop	Creates a copy of a specified tree node as a child to the TreeNode object. (Inherited from TreeNode.)
	AOTDuplicate	(Inherited from TreeNode.)
	AOTedit	Opens the appropriate editor for this node. (Inherited from TreeNode.)
	AOTendXref	(Inherited from TreeNode.)
	AOTfindChild	Finds the specified child node of this node. (Inherited from TreeNode.)
	AOTfirstChild	Retrieves the first child of the tree node. (Inherited from TreeNode.)
	AOTfirstChildEx	(Inherited from TreeNode.)
	AOTgetExecutableLineCount	Returns the number of executable lines of code for this node. (Inherited from TreeNode.)
	AOTgetExecutableLines	Returns the executable lines of code for this node. (Inherited from TreeNode.)
	AOTGetModel	(Inherited from TreeNode.)
	AOTgetProperties	Returns a string containing the properties of the tree node. (Inherited from TreeNode.)
	AOTgetPropertiesExt	(Inherited from TreeNode.)
	AOTgetProperty	(Inherited from TreeNode.)
	AOTgetSource	Returns the source code of this node. (Inherited from TreeNode.)
	AOTIncludeInCompare	(Inherited from TreeNode.)
	AOTinsert	Inserts a node among the subnodes of this node. (Inherited from TreeNode.)
	AOTIsDirty	(Inherited from TreeNode.)
	AOTIsOld	Indicates whether this node is from a file found in the old model store. (Inherited from TreeNode.)
	AOTIsPersisted	Indicates whether this node has been persisted in the model store. (Inherited from TreeNode.)
	AOTIsProxyNode	(Inherited from TreeNode.)
	AOTiterator	Returns an object which can be used to iterate the child nodes of the tree node. (Inherited from TreeNode.)
	AOTKernelHelpType	(Inherited from TreeNode.)
	AOTLayer	Returns the layer of the tree node. (Inherited from TreeNode.)
	AOTLayers	Returns a collection of the layers the tree node is defined in. (Inherited from TreeNode.)
	AOTload	Ensures that the object is loaded. (Inherited from TreeNode.)
	AOTmakeXref	Compiles this node and its subtree in the AOT, updating the cross-reference system. (Inherited from TreeNode.)
	AOTmessageLine	Writes text to the Application Object Tree (AOT) Message window. (Inherited from TreeNode.)
	AOTMove	(Inherited from TreeNode.)
	AOTname	Returns the value of the name property of the node. (Inherited from TreeNode.)
	AOTnewWindow	Opens a new AOT tree window with the tree node as the root. (Inherited from TreeNode.)
	AOTnextSibling	Returns the next node on the same level as the tree node. (Inherited from TreeNode.)
	AOTObjectNode	Indicates whether the node is an application object. (Inherited from TreeNode.)
	AOToverlayBitmapId	Returns the resource ID of the overlay in the AOT associated with this node. (Inherited from TreeNode.)
	AOTparent	Returns the parent node of the tree node. (Inherited from TreeNode.)
	AOTprevious	Returns the previous sibling of this tree node. (Inherited from TreeNode.)
	AOTrefresh	Refreshes the node with the latest changes to the .aod file. (Inherited from TreeNode.)
	AOTregenerate	(Inherited from TreeNode.)
	AOTRename	(Inherited from TreeNode.)
	AOTrestore	Reloads this node from the disk, if applicable. (Inherited from TreeNode.)
	AOTrun	Compiles this node and its subtree in the Application Object Tree (AOT). (Overrides the AOTrun Method.)
	AOTsave	Saves an Application Object Tree (AOT) node. (Inherited from TreeNode.)
	AOTSetModel	(Inherited from TreeNode.)
	AOTsetProperties	(Inherited from TreeNode.)
	AOTsetPropertiesExt	(Inherited from TreeNode.)
	AOTsetProperty	(Inherited from TreeNode.)
	AOTsetSource	Sets the source code of this node. (Inherited from TreeNode.)
	AOTshowProperties	Opens the property sheet (if not already open) and shows the properties for this node. (Inherited from TreeNode.)
	AOTtoolTip	Returns the tool tip associated with the tree node. (Inherited from TreeNode.)
	AOTToString	(Inherited from TreeNode.)
	AOTtypeStr	Returns the internal string code for the element type used in XPO files. (Inherited from TreeNode.)
	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. (Inherited from TreeNode.)
	applObjectId	Returns the application object ID, if applicable. (Inherited from TreeNode.)
	applObjectLayerMask	Returns a bitmask that specifies which layers contain this element. (Inherited from TreeNode.)
	applObjectOldLayerMask	Returns a bitmask that specifies which layers contain this element in the baseline model store. (Inherited from TreeNode.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	changedBy	Gets or sets the name of the user who last changed the application object.
	changedDate	Gets or sets the date when an application object was last changed.
	changedTime	Gets or sets the time when an application object was last changed.
	checkAccessRights	(Overrides the checkAccessRights Method.)
	configurationKey	Gets or sets the configuration key that is assigned to the control. (Inherited from SecureNode.)
	copyCallerQuery
	correctPermissions
	countryConfigurationkey	(Inherited from SecureNode.)
	countryRegionCodes
	create	Creates and returns a reference to an Microsoft Dynamics AX application object.
	createdBy	Gets or sets the name of the user who created the application object.
	createPermissions
	creationDate	Gets or sets the date an application object was created.
	creationTime
	deletePermissions
	disabledImage	Gets or sets the disabled image of the button.
	disabledImageLocation
	disabledResource	Gets or sets the resource ID of the image to use as the disabled button image.
	enumParameter	Gets or sets the enumParameter property that is passed to the object that is run by the MenuFunction class.
	enumTypeParameter	Gets or sets the enumTypeParameter property for the MenuFunction class.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	extendedDataSecurity	(Inherited from SecureNode.)
	formViewOption
	getNodeInLayer	Retrieves a version of the tree node from a specified layer. (Inherited from TreeNode.)
	getRootQuery
	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	(Inherited from TreeNode.)
	hasRunPermissions	Checks if the xMenuFunction object has execute permissions and run() may be called successfully.
	helpText	Gets or sets the help text to display at the bottom of the screen when a field or control is pointed to.
	imageLocation
	isWeb	(Inherited from SecureNode.)
	label	Gets or sets the label for a control.
	linkedPermissionObject
	linkedPermissionObjectChild
	linkedPermissionType
	maintainUserLicense
	makeCopy	(Inherited from TreeNode.)
	multiSelect
	name	Gets or sets the name that is used in code to identify a form, report, table, query, or another Microsoft Dynamics AX application object.
	neededAccessLevel	Gets or sets the neededAccessLevel property for the MenuFunction class. (Inherited from SecureNode.)
	needsRecord
	new	Creates a new xMenuFunction object by passing xMenuFunction's name and MenuItemType to the xMenuFunction constructor. (Overrides the new Method.)
	newObjectName	Returns a string that contains the name of the new element. (Inherited from TreeNode.)
	normalImage
	normalResource
	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.)
	object	Gets or sets the object that is run by the MenuFunction class.
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	objectType
	openMode
	origin
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parameters	Gets or sets the list of parameters that are passed to objects taht are run by the MenuFunction class.
	query
	readPermissions
	reportDesign
	run	Runs the xMenuFunction object.
	runOn
	securityKey	(Inherited from SecureNode.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from TreeNode.)
	treeNodeExport	Exports this node and its subtree from the Application Object Tree (AOT). (Inherited from TreeNode.)
	treeNodeName	Returns the name of the tree node. (Inherited from TreeNode.)
	treeNodePath	Returns the unique path to the tree node within the Application Object Tree (AOT). (Inherited from TreeNode.)
	treeNodeRelease	Releases the tree node explicitly. (Inherited from TreeNode.)
	treeNodeType	Retrieves an instance of a TreeNodeType class that provides reflection information for the tree node. (Inherited from TreeNode.)
	type
	updateNodePermissions	(Inherited from TreeNode.)
	updatePermissions
	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. (Inherited from TreeNode.)
	utilIdElement	Returns a UtilIdElements record that is related to the node. (Inherited from TreeNode.)
	validateNameCharacters	(Inherited from TreeNode.)
	viewUserLicense
	wait	Pauses a process. (Inherited from Object.)
	web
	webAccess
	webConfigurationkey	(Inherited from SecureNode.)
	webMenuItemName
	webPage
	webSecureTransaction
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::runCalled
	::runClient
	::runServer

Top

Remarks

You refer to an Application object using a xMenuFunction object and its methods and properties. For example, you can:

• Use the Run Method to run the object referenced in the property

• Create a xMenuFunction object and make a reference to the object it runs (or references to). This enables you to manipulate the arguments passed to the object before running it

Note: This system class represents MenuItem nodes in the AOT.

This class enables 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.

Inheritance Hierarchy

Object Class
  TreeNode Class
    SecureNode Class
      xMenuFunction Class
        MenuFunction Class