Reviewing Commonly-used API Calls

This section provides a quick reference of the most commonly used API calls. Review this information before starting to implement methods.

These methods are in CustomServerBase except where indicated.

For more information, see the API Reference.

Test Record Methods

AddHandler

Adds an event handler as the first handler of the event.

RecordFunction

Records a step in the test.

Back to top

Test Record Callback Methods

GetWndMessageFilter

Called by OpenText Functional Testing to set the Windows message filter.

InitEventListener

Called by OpenText Functional Testing to load event handlers and start listening for events.

OnMessage

Called when OpenText Functional Testing hooks the window message.

ReleaseEventListener

Stops listening for events.

Back to top

Test Run Methods

DragAndDrop, KeyDown, KeyUp, MouseClick, MouseDblClick, MouseDown, MouseMove, MouseUp, PressKey, PressNKeys, SendKeys, SendString

Mouse and keyboard simulation methods.

PrepareForReplay

Prepares the control for an action run.

ReplayReportStep

Writes an event to the test report.

ReplayThrowError

Generates an error message and changes the reported step status.

ShowError

Displays the .NET warning icon.

TestObjectInvokeMethod

Invokes one of the methods exposed by the test object's IDispatch interface.

Back to top

Cross-Process Methods

AddRemoteEventListener

Creates an EventListener instance in the Application under test process.

CreateRemoteObject

Creates an instance of an assistant object in the Application under test process.

GetEventArgs (IEventArgsHelper)

Retrieves and deserializes the EventArgs object.

Init (IEventArgsHelper)

Initializes the EventArguments helper class with an EventArgs object.

InvokeAssistant

Invokes a method of a CustomAssistantBase class in the control's thread.

InvokeCustomServer (EventsListenerBase)

Invokes the Custom Server's methods running in the OpenText Functional Testing process from the Application under test process.

SetTargetControl (CustomAssistantBase)

Attaches to the source custom control by the control's window handle.

Back to top

General Methods

ControlGetProperty

Retrieves a property of a control that is not thread-safe.

ControlInvokeMethod

Invokes a method of a control that is not thread-safe.

ControlSetProperty

Sets a property of a control that is not thread-safe.

GetSettingsValue

Gets a parameter value from the settings of this control in the configuration file.

GetSettingsXML

Returns the settings of this control as entered in the configuration file.

Back to top

Table Checkpoint and Output Value Support Methods

GetTableData (VerificationServerBase)

Called by OpenText Functional Testing to retrieve the data in a table.

GetTableRowRange (VerificationServerBase)

Called by OpenText Functional Testing to retrieve the first and last rows of the table.

GetTableColNames (VerificationServerBase)

Called by OpenText Functional Testing to retrieve the names of the table columns.

Back to top