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

Inheritance Hierarchy

Object Class
  xArgs Class
    Args Class