SysOperationProgress Class [AX 2012]

Article
2014-04-11

The SysOperationProgress class informs the user about status, operation, and progress so that the system can be responsive and user-friendly.

Syntax

class SysOperationProgress extends SysOperationProgressBase

Run On

Called

Methods

	Method	Description
	allowFormSetup	(Overrides the allowFormSetup Method.)
	buildForm	(Overrides the buildForm Method.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getCount_RU	(Inherited from SysOperationProgressBase.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getTotal	Sets the number of steps in the process. (Inherited from SysOperationProgressBase.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hide	Use this method to temporarily hide the progress bar.
	incCount	Increments the progress bar during an operation. (Inherited from SysOperationProgressBase.)
	init	(Inherited from SysOperationProgressBase.)
	kill	Use the reset method instead. This method is deprecated.
	new	Constructs an instance of the SysOperationProgress 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.)
	parmFormInited	Gets or sets the FormInited parameter. (Inherited from SysOperationProgressBase.)
	progressForm	(Overrides the progressForm Method.)
	reset	Resets the progress form so that it can be used over again. You do not have to set animation, caption, and totals again.
	sendProgress	(Overrides the sendProgress Method.)
	sendTime	(Overrides the sendTime Method.)
	setAnimation	Specifies which animation to display during the operation.
	setCaption	Sets the caption of the form.
	setCount	Sets the position of the progress bar during an operation. (Inherited from SysOperationProgressBase.)
	setText	Sets a description of the process that is currently occurring. (Inherited from SysOperationProgressBase.)
	setTextLength	Sets the length of the progress text controls.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setTotal	Sets the number of steps in the process. (Inherited from SysOperationProgressBase.)
	setupForm	(Overrides the setupForm Method.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	update	Updates the operation progress bar. (Overrides the update Method.)
	updateInterval	Sets the update interval. The update interval is the number of seconds between each update of the form. (Inherited from SysOperationProgressBase.)
	updateTime	(Inherited from SysOperationProgressBase.)
	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.)
	waitForParent	If you have two instances of the operation progress framework that are running at the same time, the child will hook up on the parent so that the user only will see one progress form on the screen.
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::clearCache
	::clearCacheClient
	::clearCacheServer
	::clientUpdate
	::clientUpdateTime
	::construct
	::getDefaultTextLength	Gets the default maximum length for the progress text before the text wraps to an additional line.
	::newGeneral	Constructs an instance of the SysOperationProgress class as a single-bar progress indicator.
	::newMultiBar	Constructs an instance of the SysOperationProgress class as a multi-bar progress indicator.
	::setCache

Top

Remarks

Split up an operation in as many steps as possible. This will give the user the best information and the best remaining time estimate. You do not have to worry about the time that you must spend informing the user because the form only is updated once a second and even less frequently on low bandwidth connections.

Inheritance Hierarchy

Object Class
SysOperationProgressBase Class
SysOperationProgress Class

Share via