IDLitTool::DoUIService

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitTool::DoUIService function method initiates a request for a UI service to execute. This method allows underlying iTool functionality to perform user-interface interactions without having a direct connection to the user interface portion of the iTool.

An example of an iTool UI service would be the File → Open command, which will prompt the user to select a file using the standard file open dialog. This command is identified by setting the ServiceIdentifier argument to FileOpen. See Creating a User Interface Service (iTool Developer's Guide) for more information about UI services.

Syntax

Result = Obj->[IDLitTool::]DoUIService(ServiceIdentifier, Requestor)

Return Value

Returns 1 if the action succeeds, or 0 if the action fails.

Arguments

ServiceIdentifier

A string identifier that specifies the UI service being requested. This identifier is passed to the tools user interface for control dispatching purposes.

Requestor

An object reference to the object that is requesting the UI service. The UI service uses this object to obtain any information particular to the interaction taking place.

Keywords

None

Version History