SysOperationProgressEmbedded Class [AX 2012]

The SysOperationProgressEmbedded class enables you to put an operation progress bar on your own form.

Syntax

class SysOperationProgressEmbedded extends SysOperationProgressBase

Run On

Called

Methods

	Method	Description
	allowFormSetup	(Inherited from SysOperationProgressBase.)
	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.)
	finalUpdate
	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.)
	incCount	Increments the progress bar during an operation. (Inherited from SysOperationProgressBase.)
	init	(Inherited from SysOperationProgressBase.)
	new	Initializes a new instance of the SysOperationProgressBase class. (Inherited from SysOperationProgressBase.)
	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.)
	sendProgress	(Overrides the sendProgress Method.)
	sendTime	(Inherited from SysOperationProgressBase.)
	setCount	Sets the position of the progress bar during an operation. (Inherited from SysOperationProgressBase.)
	setFormControl
	setFormRun	Sets the formRun of the form that holds the embedded operation progress.
	setText	Sets a description of the process that is currently occurring. (Inherited from SysOperationProgressBase.)
	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	(Inherited from SysOperationProgressBase.)
	start	Call this method just before the actual operation begins. This is used for the time remaining calculation.
	timeFinalUpdate
	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.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::construct	Initializes a new instance of the SysOperationProgressEmbedded class.
	::newGeneral	Instantiates an embedded operation progress class.

Top

Remarks

This could be useful in a wizard for example. The operation progress bar will have all the same features as a normal progress bar, including time remaining calculation.

Inheritance Hierarchy

Object Class
  SysOperationProgressBase Class
    SysOperationProgressEmbedded Class

See Also

SysOperationProgress Class