Share via


xArgs Class

The xArgs class is used to pass arguments such as a name, a caller, and parameters between application objects.

Syntax

class xArgs extends Object

Run On

Called

Methods

  Method Description
Gg991874.pubmethod(en-us,AX.60).gif allowUseOfPreloadedForm Determines if the form launched for this instance may come from the pre-loaded form pool.
Gg991874.pubmethod(en-us,AX.60).gif arrIdx
Gg991874.pubmethod(en-us,AX.60).gif caller Gets or sets the instance of the object that created this instance of the xArgs class.
Gg991874.pubmethod(en-us,AX.60).gif callerFormControl
Gg991874.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif copyCallerQuery
Gg991874.pubmethod(en-us,AX.60).gif dataset Gets the table ID of the table in which the caller object is working.
Gg991874.pubmethod(en-us,AX.60).gif designName Gets or sets a string that indicates a design on a report or form.
Gg991874.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif extType
Gg991874.pubmethod(en-us,AX.60).gif finalize Removes the current instance of the xArgs class from memory.
Gg991874.pubmethod(en-us,AX.60).gif formViewOption
Gg991874.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif initialQuery
Gg991874.pubmethod(en-us,AX.60).gif lookupField Gets or sets the field ID in a table to use to look up a specified record.
Gg991874.pubmethod(en-us,AX.60).gif lookupRecord Finds a record in the specified table.
Gg991874.pubmethod(en-us,AX.60).gif lookupTable
Gg991874.pubmethod(en-us,AX.60).gif lookupValue Gets or sets a string to use with the LookupField method to find a value in a field of a table.
Gg991874.pubmethod(en-us,AX.60).gif managedContentItemName
Gg991874.pubmethod(en-us,AX.60).gif menuItemName Gets or sets the name of the menu item to use to start the application object.
Gg991874.pubmethod(en-us,AX.60).gif menuItemType Gets or sets the type of the menu item to use to start the called application object.
Gg991874.pubmethod(en-us,AX.60).gif multiSelectionContext
Gg991874.pubmethod(en-us,AX.60).gif name Gets or sets the name used in code to identify a form, report, rable, query, or another MSDAX application object.
Gg991874.pubmethod(en-us,AX.60).gif new Initializes a new instance of the Object class. (Overrides the new Method.)
Gg991874.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif object Gets and sets the application name of the object for which to open a new instance.
Gg991874.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif openMode
Gg991874.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif parentWnd
Gg991874.pubmethod(en-us,AX.60).gif parm Gets or sets the parameter.
Gg991874.pubmethod(en-us,AX.60).gif parmEnum Gets or sets the enumeration value of the enumeration type that is specified in the parmEnumType method.
Gg991874.pubmethod(en-us,AX.60).gif parmEnumType Gets or sets the EnumType parameter.
Gg991874.pubmethod(en-us,AX.60).gif parmObject Gets or sets the Object parameter.
Gg991874.pubmethod(en-us,AX.60).gif record Gets or sets the record from the table on which the caller object is working.
Gg991874.pubmethod(en-us,AX.60).gif refField
Gg991874.pubmethod(en-us,AX.60).gif selectField
Gg991874.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif setupArgs
Gg991874.pubmethod(en-us,AX.60).gif toString Retrieves a string representation of an instance of the xArgs. (Overrides the toString Method.)
Gg991874.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg991874.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)

Top

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 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.

Inheritance Hierarchy

Object Class
  xArgs Class
    Args Class