xRefUpdate Class [AX 2012]

Syntax

class xRefUpdate extends SysUtilElementsTraverse

Run On

Called

Methods

	Method	Description
	aosClientMode
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canGoBatch	Returns true. (Overrides the canGoBatch Method.)
	canSwapBetweenCS	Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)
	caption	Returns the description from the current class by calling the static description method on the class if there is one. (Inherited from RunBase.)
	checkCloseDialog	Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.)
	cleanupDialog	Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.)
	dialog	Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Overrides the dialog Method.)
	dialogClear	Clears the contents of the dialog box. (Inherited from RunBase.)
	dialogInit	Initializes the dialog box. (Inherited from RunBase.)
	dialogInternal	(Inherited from RunBase.)
	dialogMake	Obtains the dialog from a RunBase class. (Inherited from RunBase.)
	dialogPost	Makes it possible to add controls after the main dialog method has been run because this method is called after the dialog method is called. (Inherited from RunBase.)
	dialogPostInit	Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.)
	dialogPostRun	Called after the Dialog.run Method class. (Inherited from RunBase.)
	dialogReInit	Reinitializes the dialog box. (Inherited from RunBase.)
	dialogSelectCtrl	When using the dialog class for dialog, this method is called whenever a control is selected. (Inherited from RunBase.)
	dialogTask	When using the Dialog Class class for dialog, this method is called from the task method in the dialog form. (Inherited from RunBase.)
	dialogUpdate	Updates the dialog, for example after reinitializing the query. (Inherited from RunBase.)
	dialogUpdateQuery	Updates the query in the dialog box. (Inherited from RunBase.)
	do	(Overrides the do Method.)
	doProjectNode
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getFromDialog	Assigns the dialog box values to the internal variables. (Overrides the getFromDialog Method.)
	getLast	Gets the last choice that is stored in the last value table. (Inherited from RunBase.)
	getRunBase	(Inherited from RunBase.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	inGetSaveLast	Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.)
	init	Gives RunBase the same profile as, for example, a FormRun class. This method is not used in the standard application. (Inherited from RunBase.)
	initParmDefault	Initializes the internal variables. (Overrides the initParmDefault Method.)
	isFullTree	Gets the class member variable fullTree that indicates whether the whole tree is used to generate the cross-reference information.
	isSelective	Gets the class member variable named selective that controls whether the cross-reference information applies to only a subset of AOT nodes.
	isSwappingPrompt	Checks if the program is currently swapping from server to client. (Inherited from RunBase.)
	isUpdateTableRelation	Gets the state that controls whether the cross-reference generation should include updates to table relations.
	isXrefTablesTruncated
	lastValueDataAreaId	(Inherited from RunBase.)
	lastValueDesignName	(Inherited from RunBase.)
	lastValueElementName	(Inherited from RunBase.)
	lastValueType	(Inherited from RunBase.)
	lastValueUserId	(Inherited from RunBase.)
	mustLoadSaveQuery	Determines whether the last query must be loaded and saved when you leave the form. Called from the SysQueryForm. (Inherited from RunBase.)
	name	Returns the name of the RunBase class. (Inherited from RunBase.)
	new	Initializes a new instance of the xRefUpdate 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.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pack	Serializes the current instance of the xRefUpdate class. (Overrides the pack Method.)
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmuseRunBaseQueryDialog	Gets or sets the useRunBaseQueryDialog parameter. (Inherited from SysUtilElementsTraverse.)
	prepareForRun	Allows subclasses to process the dialog box immediately before the dialog box.Run method. (Inherited from RunBase.)
	progressHide	Hides the Progress form. (Inherited from RunBase.)
	progressInit	Initializes the Progress object in RunBase. (Inherited from RunBase.)
	progressKill	Kills the Progress object in RunBase. (Inherited from RunBase.)
	progressSetText
	prompt	(Inherited from RunBase.)
	promptPack	Wraps a call to the RunBase.pack Method method when packing in the RunBase.promptPrim Method method. (Inherited from RunBase.)
	promptUnpack	Unpacks what the promptPack method has packed. (Inherited from RunBase.)
	putToDialog	Enables setting the fields that were just added in the RunBase.dialog Method method. This method is called from the RunBase.promptPrim Method method directly following the RunBase.dialogMake Method method. (Inherited from RunBase.)
	queryRun	Retrieves the instance of the QueryRun class, which is used by the queryPrompt method. (Inherited from SysUtilElementsTraverse.)
	reset	Resets the class to its default state. (Inherited from RunBase.)
	run	Contains the code that does the actual job of the class. (Overrides the run Method.)
	runBase	Returns the RunBase itself. (Inherited from RunBase.)
	runBaseDialogModifyType_RU	(Inherited from RunBase.)
	runInit	Gets the last choice that is stored in the last value table, before run in batch (Overrides the runInit Method.)
	runsImpersonated	Determines whether the batch task is run on the server or a client.
	runSysContextMenu
	saveLast	Saves the last choice by using the RunBase.pack Method method. (Inherited from RunBase.)
	setFullTree	Sets the class member variable fullTree to indicate whether the whole tree is used to generate the cross-reference information.
	setSelective	Sets the class member variable named selective to determine whether the cross-reference information applies to only a subset of AOT nodes.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setUpdateTableRelation	Sets the state to control whether the cross-reference generation should include updates to table relations.
	setXrefTablesTruncated	Sets the state to control whether the cross-reference generation should truncate all the tables where the cross-reference information is stored before generation starts.
	showClearButton	Determines whether to add a Clear button to the dialog box. If you change the return value to true it will add the button. (Inherited from RunBase.)
	showDefaultButton	Determines whether a Default button is to be added to the dialog box. If you change the return value to true, it will add the button. (Inherited from RunBase.)
	showDialog	(Inherited from RunBase.)
	showIndexFields	If this method returns true, it will look for the first enabled index when you are adding query range fields to the dialog and if a data source does not have any ranges specified. It will also show the visible fields from that index. (Inherited from RunBase.)
	showQuerySelectButton	(Inherited from RunBase.)
	showQueryValues	Determines whether to add a Select button to the dialog box. (Inherited from SysUtilElementsTraverse.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the packedClass parameter value to an instance of the xRefUpdate class. (Overrides the unpack Method.)
	updateAll
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	utilElementsToBexRefedInsert
	validate	Validates the state of the internal variables. (Inherited from RunBase.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	xRefUtilElementsPostponed
	::CreateXref
	::description	Gets the description of the class.
	::doProjectNodeXref	Generates cross-reference information for all the concepts that are grouped in a specific project.
	::main	Provides an entry point for the xRefUpdate class when it is called from a menu item.
	::setIcon	Microsoft internal use only.
	::startxRef	Starts the cross-reference generation process.
	::truncateXrefTables
	::updatePath	Presents the progress dialog box during the cross-reference generation process indicating the AOT node path being processed.
	::updateProgressBar	Updates the cross-reference progress bar during cross-reference information generation.

Top

Inheritance Hierarchy

Object Class
  RunBase Class
    SysUtilElementsTraverse Class
      xRefUpdate Class