SetCursor()

Summary

Sets the system pointer cursor style to one of several predefined options.

Syntax

SetCursor(string cursor_type)

Argument Contents
cursor_type One of the following: Arrow, Hourglass, Crosshair, Digitizer.

Notes

  • The current cursor type is saved when SetCursor() is called and is restored by a call to ResetCursor().

  • If cursor_type is null, the pointer is set to an arrow cursor.

  • The SetCursor() and ResetCursor() functions should be called in pairs, since each call to ResetCursor() restores the cursor to its state before the previous SetCursor() call.

Example

SetCursor("Hourglass")
RunMacro("my macro") // Hourglass displays while the macro runs...
ResetCursor()

Error Codes

Error Type Meaning
NotFound The cursor_type argument is not one of the predefined cursor types.

See Also

Function Summary
ResetCursor() Restores the system pointer to the type previously used