DisplayClearBackgroundEvent

Message

DisplayClearBackgroundEvent <docname> <eventclass>

Originator

Client

Response

SyntaxError: insufficient parameters to DisplayClearBackgroundEvent

SyntaxError: invalid parameters to DisplayClearBackgroundEvent

SyntaxError: no such event class

Error: document docname not found by DisplayClearBackgroundEvent

Info: event(s) removed

Response (immediate socket)

Success

Failure

Details

The specified event class is cleared for the document's background.

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

Cacheing mode and display events

Regardless of the caching mode, changes to background events take effect immediately.

Revision history

Implemented in WhiskerServer version 2.6.07.

See also