xArgs Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The xArgs class is used to pass arguments such as a name, a caller, and parameters between application objects.
public ref class xArgs : Microsoft::Dynamics::Ax::Xpp::XppObjectBase
[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class xArgs : Microsoft.Dynamics.Ax.Xpp.XppObjectBase
[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type xArgs = class
inherit XppObjectBase
Public Class xArgs
Inherits XppObjectBase
- Inheritance
- Attributes
Remarks
Forms, reports and queries all use this class as their first argument in the constructor. The preferred way to use this class is to construct an xArgs object, supply a name-string, and then pass the xArgs object to the forms constructor or a ClassFactory method. If you want to refer to the xArgs object passed to one of these classes, it can be reached using args method of that class. There are four methods that can be used to pass extra information to the new class:
- The parm - to pass strings
- The parmEnum and parmEnumType methods - to pass enumeration values
- The parmObject method - to pass an object of any type
The instance of the xArgs class that is sent from the caller can be created automatically by the kernel or explicitly by the caller. When the caller uses a menu item to call an object, an instance of the xArgs class is created by the kernel code. The menu item name will be set to the name of the menu item used. If the menu item has values for the Parameters, EnumParameter, or EnumTypeParameter properties set, the kernel will set the values of the corresponding Parm, ParmEnum, or ParmEnumType properties for this instance of the xArgs class.
Constructors
xArgs() | |
xArgs(IntPtr) | |
xArgs(Object, XppObjectBase) | |
xArgs(Object) |
Fields
__k_xArgsId | |
kernelClass | (Inherited from XppObjectBase) |