InfoBar Class [AX 2012]

The info bar is meant to display of information, warnings and error messages to the user. It must be conjugated with form UI elements.

Syntax

class InfoBar extends Object

Run On

Called

Methods

	Method	Description
	addMessage	Adds message to info bar stack.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	changeLatestMessageStyle
	dismissAllMessages	Dismiss all messages from the info bar stack.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	finalize	Unloads infobar resources.
	flashLatestMessage	Flashes the latest info bar message to grab the users attention.
	getAllMessages	Gets a list of all accumulated info bar messages.
	getLatestMessage	Gets the latest info bar message.
	getMessageCount	Gets the number of messages that the info bar has accumulated.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hideFixItButtons	Makes all info bar buttons (e.g. Fix it buttons) invisible.
	id	Gets the info bar id.
	isListening	Checks whether the info bar is listening.
	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.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parmIsListening	Gets or sets the IsListening parameter.
	parmIsShowingAllMessages	Gets or sets the IsShowingAllMessages parameter.
	refresh	Refreshes info bar UI so the user can see its current messages or lack thereof.
	registerInGlobalCache
	removeLatestMessage	Removes the latest message from the info bar.
	removeMessage	Removes a given message from the info bar stack.
	resetLastestMessageStyle
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	shouldShowInfoBar	Gets whether the info bar should be visible.
	startListening	Sets the info bar to the Listening state.
	stopListening	Sets the info bar to the Not listening state.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unregisterFromGlobalCache	Removes info bar from the global cache.
	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.)
	::getInfoBarsForCurrentUser	Gets the list of info bars created for the current user.
	::getInfoBarsGlobalCacheKeyForCurrentUser
	::getInfoBarsGlobalCacheOwner

Top

Remarks

The unregisterFromGlobalCache method must be called after you're done using the infoBar instance.

Inheritance Hierarchy

Object Class
  InfoBar Class