SysCompareContextProvider Interface [AX 2012]

Article
2014-04-11

The SysCompareContextProvider class can be used by classes that implement this interface to start and to control a visual comparison of two or more classes that are implementing the SysComparable Interface, or the specialized SysMergeable Interface.

Syntax

interface SysCompareContextProvider

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	caption	Specifies the caption of the comparison form.
	comparableItemDefault
	comparableList	Implementations of this method should return a list of classes that are implementing the SysComparable interface. The user can pick two of these classes in the comparison form.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	manipulateResult
	mergeDirection	Specifies which SysMergeable interface is the target for the merge.
	new	Initializes a new instance of the Object class. (Inherited from Object.)
	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.)
	onCompareStart
	onContextMenu	Notifies the class that the user has right-clicked in the comparison tree pane.
	onDeleteTopNode
	owner	Returns the instance that owns the object. (Inherited from Object.)
	parmCaseSensitive	Gets or sets the CaseSensitive parameter.
	parmShowDifferencesOnly	Gets or sets the ShowDifferencesOnly parameter.
	parmShowLineNumbers	Gets or sets the ShowLineNumbers parameter.
	parmSuppressNodesOnlyIn1	Gets or sets the SuppressNodesOnlyIn1 parameter.
	parmSuppressNodesOnlyIn2	Gets or sets the SuppressNodesOnlyIn2 parameter.
	parmSuppressWhitespace	Gets or sets the SuppressWhitespace parameter.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showTreePane	Determines whether the tree pane is shown in the comparison window.
	supportDeleteWhenIdentical
	toString	Returns a string that represents the current object. (Inherited from Object.)
	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

For an example of how this class is used, see the Tutorial_CompareContextProvider::main Method

Inheritance Hierarchy

Object Class
SysCompareContextProvider Interface

Share via