xMenuFunction Class

Definition

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

public ref class xMenuFunction : Dynamics::AX::Application::SecureNode
[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class xMenuFunction : Dynamics.AX.Application.SecureNode
[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type xMenuFunction = class
    inherit SecureNode
Public Class xMenuFunction
Inherits SecureNode
Inheritance
Microsoft.Dynamics.AX.KernelInterop.ProxyBase
xMenuFunction
Attributes

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.

Constructors

xMenuFunction()
xMenuFunction(IntPtr)
xMenuFunction(String, MenuItemType)

Fields

__k_xMenuFunctionId
kernelClass (Inherited from XppObjectBase)

Methods

__shouldCallNew(Type)
addXppProxyReference(Type, Object) (Inherited from XppObjectBase)
AOTadd(String) (Inherited from TreeNode)
AOTaddExtendedDataType(String, Types) (Inherited from TreeNode)
AOTaddRelation() (Inherited from TreeNode)
AOTaddSubNode(Int32) (Inherited from TreeNode)
AOTaddXref(String, xRefKind, Int32, Int32) (Inherited from TreeNode)
AOTaddXref(String, xRefKind, Int32, Int32, XRefReference) (Inherited from TreeNode)
AOTaddXref(String, xRefKind, Int32, Int32, XRefReference, Int32) (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() (Inherited from TreeNode)
AOTcompile(Int32) (Inherited from TreeNode)
AOTcompile(Int32, Boolean) (Inherited from TreeNode)
AOTcompile(Int32, Boolean, Boolean) (Inherited from TreeNode)
AOTconfigure() (Inherited from TreeNode)
AOTdelete() (Inherited from TreeNode)
AOTDrop(TreeNode)

Creates a copy of a specified tree node as a child to the TreeNode object.

(Inherited from TreeNode)
AOTDrop(TreeNode, TreeNode) (Inherited from TreeNode)
AOTDuplicate() (Inherited from TreeNode)
AOTedit()

Opens the appropriate editor for this node.

(Inherited from TreeNode)
AOTedit(Int32) (Inherited from TreeNode)
AOTedit(Int32, Int32) (Inherited from TreeNode)
AOTendXref() (Inherited from TreeNode)
AOTfindChild(String)

Finds the specified child node of this node.

(Inherited from TreeNode)
AOTfindChild(String, Int32) (Inherited from TreeNode)
AOTfirstChild()

Retrieves the first child of the tree node.

(Inherited from TreeNode)
AOTfirstChildEx() (Inherited from TreeNode)
AOTfirstChildEx(Boolean) (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)
AOTgetProperties(Boolean) (Inherited from TreeNode)
AOTgetProperties(Boolean, Boolean) (Inherited from TreeNode)
AOTgetProperties(Boolean, Boolean, Boolean) (Inherited from TreeNode)
AOTgetPropertiesExt() (Inherited from TreeNode)
AOTgetPropertiesExt(String) (Inherited from TreeNode)
AOTgetProperty(String) (Inherited from TreeNode)
AOTgetSource()

Returns the source code of this node.

(Inherited from TreeNode)
AOTIncludeInCompare() (Inherited from TreeNode)
AOTinsert(TreeNode)

Inserts a node among the subnodes of this node.

(Inherited from TreeNode)
AOTinsert(TreeNode, TreeNode) (Inherited from TreeNode)
AOTinsert(TreeNode, TreeNode, Boolean) (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)
AOTLayers(Boolean) (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)
AOTmakeXref(Int32) (Inherited from TreeNode)
AOTmakeXref(Int32, Boolean) (Inherited from TreeNode)
AOTmessageLine(String, Int32)

Writes text to the Application Object Tree (AOT) Message window.

(Inherited from TreeNode)
AOTMove(TreeNode) (Inherited from TreeNode)
AOTMove(TreeNode, TreeNode) (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(String) (Inherited from TreeNode)
AOTrestore()

Reloads this node from the disk, if applicable.

(Inherited from TreeNode)
AOTrestore(Boolean) (Inherited from TreeNode)
AOTrun()

Compiles this node and its subtree in the Application Object Tree (AOT).

AOTrun(xArgs)
AOTsave() (Inherited from TreeNode)
AOTSetModel(Int32) (Inherited from TreeNode)
AOTsetProperties(String) (Inherited from TreeNode)
AOTsetPropertiesExt(Struct) (Inherited from TreeNode)
AOTsetProperty(String, Object) (Inherited from TreeNode)
AOTsetSource(String) (Inherited from TreeNode)
AOTsetSource(String, Boolean) (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)
Call(String, Object[], Type[], Object[]) (Inherited from XppObjectBase)
cancelTimeOut(Int32) (Inherited from XppObjectBase)
changedBy()

Gets or sets the name of the user who last changed the application object.

changedBy(String)
changedDate()

Gets or sets the date when an application object was last changed.

changedDate(Date)
changedTime()

Gets or sets the time when an application object was last changed.

changedTime(String)
checkAccessRights()
configurationKey()

Gets or sets the configuration key that is assigned to the control.

(Inherited from SecureNode)
configurationKey(Int32) (Inherited from SecureNode)
copyCallerQuery()
copyCallerQuery(Int32)
correctPermissions()
correctPermissions(Int32)
countryConfigurationkey() (Inherited from SecureNode)
countryConfigurationkey(Int32) (Inherited from SecureNode)
countryRegionCodes()
countryRegionCodes(String)
create()

Creates and returns a reference to an Finance and Operations application object.

create(xArgs)
createdBy()

Gets or sets the name of the user who created the application object.

createdBy(String)
createKernelClass(Object[], Type[], Object[]) (Inherited from XppObjectBase)
createPermissions()
createPermissions(Int32)
creationDate()

Gets or sets the date an application object was created.

creationDate(Date)
creationTime()
creationTime(String)
deletePermissions()
deletePermissions(Int32)
disabledImage()

Gets or sets the disabled image of the button.

disabledImage(String)
disabledImageLocation()
disabledImageLocation(Int32)
disabledResource()

Gets or sets the resource ID of the image to use as the disabled button image.

disabledResource(Int32)
enumParameter()

Gets or sets the enumParameter property that is passed to the object that is run by the MenuFunction class.

enumParameter(Int32)
enumTypeParameter()

Gets or sets the enumTypeParameter property for the MenuFunction class.

enumTypeParameter(Int32)
equal(XppObjectBase) (Inherited from XppObjectBase)
extendedDataSecurity() (Inherited from SecureNode)
extendedDataSecurity(Boolean) (Inherited from SecureNode)
featureClass() (Inherited from SecureNode)
featureClass(String) (Inherited from SecureNode)
finalize() (Inherited from XppObjectBase)
formViewOption()
formViewOption(Int32)
GetIntPtr() (Inherited from XppObjectBase)
GetKernelInstanceUniqueId() (Inherited from XppObjectBase)
getNodeInLayer(UtilEntryLevel)

Retrieves a version of the tree node from a specified layer.

(Inherited from TreeNode)
getNodeInLayer(UtilEntryLevel, Boolean) (Inherited from TreeNode)
getRootQuery()
getTimeOutTimerHandle() (Inherited from XppObjectBase)
getXppProxyReference(Type) (Inherited from XppObjectBase)
handle()
hashKey() (Inherited from TreeNode)
hasRunPermissions()

Checks if the xMenuFunction object has execute permissions and run() may be called successfully.

hasRunPermissions(xArgs)
helpText()

Gets or sets the help text to display at the bottom of the screen when a field or control is pointed to.

helpText(String)
imageLocation()
imageLocation(Int32)
IsManagedValid() (Inherited from XppObjectBase)
isWeb() (Inherited from SecureNode)
kernelhandle()
KernelInstanceDisposed() (Inherited from XppObjectBase)
label()

Gets or sets the label for a control.

label(String)
linkedPermissionObject()
linkedPermissionObject(String)
linkedPermissionObjectChild()
linkedPermissionObjectChild(String)
linkedPermissionType()
linkedPermissionType(Int32)
maintainUserLicense()
maintainUserLicense(Int32)
makeCopy() (Inherited from TreeNode)
MakeReflectionCall(String, Object[]) (Inherited from XppObjectBase)
multiSelect()
multiSelect(Boolean)
name()

Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.

name(String)
neededAccessLevel()

Gets or sets the neededAccessLevel property for the MenuFunction class.

(Inherited from SecureNode)
neededAccessLevel(Int32) (Inherited from SecureNode)
needsRecord()
needsRecord(Int32)
newmethod()

Initializes a new instance of the TreeNode class.

(Inherited from TreeNode)
newmethod(String, MenuItemType)

Creates a new xMenuFunction object by passing xMenuFunction's name and MenuItemType to the xMenuFunction constructor.

newObjectName()

Returns a string that contains the name of the new element.

(Inherited from TreeNode)
newObjectName(String) (Inherited from TreeNode)
normalImage()
normalImage(String)
normalResource()
normalResource(Int32)
notify() (Inherited from XppObjectBase)
notifyAll() (Inherited from XppObjectBase)
object()

Gets or sets the object that is run by the MenuFunction class.

object(String)
objectOnServer()
Obsolete.
(Inherited from XppObjectBase)
objectType()
objectType(Int32)
openMode()
openMode(Int32)
origin()
origin(Guid)
parameters()

Gets or sets the list of parameters that are passed to objects that are run by the MenuFunction class.

parameters(String)
query()
query(String)
readPermissions()
readPermissions(Int32)
reportDesign()
reportDesign(String)
run()

Runs the xMenuFunction object.

run(xArgs)
runCalled(String, MenuItemType)
runCalled(String, MenuItemType, Boolean)
runCalled(String, MenuItemType, Boolean, xArgs)
runClient(String, MenuItemType)
runClient(String, MenuItemType, Boolean)
runClient(String, MenuItemType, Boolean, xArgs)
runOn()
runOn(Int32)
runServer(String, MenuItemType)
runServer(String, MenuItemType, Boolean)
runServer(String, MenuItemType, Boolean, xArgs)
securityKey() (Inherited from SecureNode)
securityKey(Int32) (Inherited from SecureNode)
setTimeOut(String, Int32)
Obsolete.
(Inherited from XppObjectBase)
setTimeOut(String, Int32, Boolean)
Obsolete.
(Inherited from XppObjectBase)
ToString()

Returns a string that represents the current object.

(Inherited from TreeNode)
treeNodeExport(String)

Exports this node and its subtree from the Application Object Tree (AOT).

(Inherited from TreeNode)
treeNodeExport(String, Int32) (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(Boolean) (Inherited from TreeNode)
updatePermissions()
updatePermissions(Int32)
usageCount() (Inherited from XppObjectBase)
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(String) (Inherited from TreeNode)
VerifyKernelClass() (Inherited from XppObjectBase)
viewUserLicense()
viewUserLicense(Int32)
wait() (Inherited from XppObjectBase)
web()
web(String)
webAccess()
webAccess(Int32)
webConfigurationkey() (Inherited from SecureNode)
webConfigurationkey(Int32) (Inherited from SecureNode)
webMenuItemName()
webMenuItemName(String)
webPage()
webPage(String)
webSecureTransaction()
webSecureTransaction(Boolean)
Xml() (Inherited from XppObjectBase)
Xml(Int32) (Inherited from XppObjectBase)

Applies to