DisplayClearEvent

Message

DisplayClearEvent <docname> <objectname> <eventclass>

Originator

Client

Response

SyntaxError: insufficient parameters to DisplayClearEvent

SyntaxError: invalid parameters to DisplayClearEvent

SyntaxError: no such event class

Error: document docname not found by DisplayClearEvent

Error: No object called objectname found on display document docname by DisplayClearEvent

Info: event(s) removed

Response (immediate socket)

Success

Failure

Details

The specified event class is cleared for the appropriate object(s) (see DisplaySetEvent).

If eventclass is blank, all events are cleared for the specified object.

Cacheing mode and display events

If cacheing mode is enabled, the client may set or clear events, or change event transparency,  for objects not yet displayed (that is, added since DisplayCacheChanges), or for objects which are awaiting deletion (deleted since DisplayCacheChanges). Commands will take effect immediately for any objects currently displayed.

Revision history

Implemented by WhiskerServer version 2.3.

See also