xArgs Class

Definition

Namespace:

Dynamics.AX.Application

Assembly:

Microsoft.Dynamics.AX.Xpp.Support.dll

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

Microsoft.Dynamics.AX.KernelInterop.ProxyBase

XppObjectBase

xArgs

Attributes

KernelClassAttribute

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)

xArgs(Object, XppObjectBase)

Fields

__k_xArgsId
kernelClass	(Inherited from XppObjectBase)

Methods

__shouldCallNew(Type)
addXppProxyReference(Type, Object)	(Inherited from XppObjectBase)
allowUseOfPreloadedForm()	Determines if the form launched for this instance may come from the pre-loaded form pool.
allowUseOfPreloadedForm(Boolean)
applyRecordAsDynalink()
applyRecordAsDynalink(Boolean)
arrIdx()
arrIdx(Int32)
Call(String, Object[], Type[], Object[])	(Inherited from XppObjectBase)
caller()	Gets or sets the instance of the object that created this instance of the xArgs class.
caller(XppObjectBase)
callerDispatcher()
callerFormControl()
callerFormControl(FormControl)
callerId()
callerName()
callerType()
cancelTimeOut(Int32)	(Inherited from XppObjectBase)
clientId()
clientId(String)
copyCallerQuery()
copyCallerQuery(CopyCallerQuery)
createKernelClass(Object[], Type[], Object[])	(Inherited from XppObjectBase)
dataset()	Gets the table ID of the table in which the caller object is working.
designName()	Gets or sets a string that indicates a design on a report or form.
designName(String)
equal(XppObjectBase)	(Inherited from XppObjectBase)
extType()
extType(Int32)
extType(Int32, Int32)
finalize()	Removes the current instance of the xArgs class from memory.
formViewOption()
formViewOption(FormViewOption)
GetIntPtr()	(Inherited from XppObjectBase)
GetKernelInstanceUniqueId()	(Inherited from XppObjectBase)
getRequestContextQuery()
getTimeOutTimerHandle()	(Inherited from XppObjectBase)
getXppProxyReference(Type)	(Inherited from XppObjectBase)
handle()
initialQuery()
initialQuery(InitialQueryParameter)
IsManagedValid()	(Inherited from XppObjectBase)
kernelhandle()
KernelInstanceDisposed()	(Inherited from XppObjectBase)
lookupField()	Gets or sets the field ID in a table to use to look up a specified record.
lookupField(Int32)
lookupRecord()	Finds a record in the specified table.
lookupRecord(Common)
lookupTable()
lookupTable(Int32)
lookupValue()	Gets or sets a string to use with the LookupField method to find a value in a field of a table.
lookupValue(String)
MakeReflectionCall(String, Object[])	(Inherited from XppObjectBase)
managedContentItemName()
managedContentItemName(String)
menuItemName()	Gets or sets the name of the menu item to use to start the application object.
menuItemName(String)
menuItemType()	Gets or sets the type of the menu item to use to start the called application object.
menuItemType(MenuItemType)
multiSelectionContext()
name()	Gets or sets the name that is used in code to identify a form, report, table, query, or another MSDAX application object.
name(String)
newmethod()	Constructs an instance of this class, which is used to pass information to high-level classes such as the FormRun or ReportRun class.
newmethod(Object)
newmethod(Object, XppObjectBase)
notify()	(Inherited from XppObjectBase)
notifyAll()	(Inherited from XppObjectBase)
object()	Gets and sets the application name of the object for which to open a new instance.
object(XppObjectBase)
objectOnServer()	Obsolete. (Inherited from XppObjectBase)
onCallerChanged(XppObjectBase)
openMode()
openMode(OpenMode)
parentWnd()
parentWnd(Int64)
parm()	Gets or sets a string that specifies miscellaneous information for the called object.
parm(String)
parmEnum()	Gets or sets the enumeration value of the enumeration type that is specified in the parmEnumType method.
parmEnum(Int32)
parmEnumType()	Gets or sets the ID value of any enumeration type.
parmEnumType(Int32)
parmObject()	Gets or sets the instance of any object to pass to the called object.
parmObject(XppObjectBase)
partHostViewConfiguration()
partHostViewConfiguration(String)
record()	Gets or sets the record from the table on which the caller object is working.
record(Common)
refField()
refField(Int32)
requestContextQuery()
requestContextQuery(String)
selectField()
selectField(Int32)
setTimeOut(String, Int32)	Obsolete. (Inherited from XppObjectBase)
setTimeOut(String, Int32, Boolean)	Obsolete. (Inherited from XppObjectBase)
setupArgs(String, Int32, Object)
setupArgs(String, Int32, Object, String)
setupArgs(String, Int32, Object, String, Int32)
ToString()	Retrieves a string representation of an instance of the xArgs.
usageCount()	(Inherited from XppObjectBase)
VerifyKernelClass()	(Inherited from XppObjectBase)
wait()	(Inherited from XppObjectBase)
Xml()	(Inherited from XppObjectBase)
Xml(Int32)	(Inherited from XppObjectBase)