DisplaySetBackgroundEvent

Top  Previous  Next

Message

 

DisplaySetBackgroundEvent <docname> <eventclass> <eventmessage>

 

Originator

 

Client

 

Response

 

SyntaxError: insufficient parameters to DisplaySetEvent

SyntaxError: invalid parameters to DisplaySetEvent

SyntaxError: no such event class

Error: document docname not found by DisplaySetEvent

Info: event created for background

 

Response (immediate socket)

 

Success

Failure

 

Details

 

Allows you to set events on a document's background. For details of events, see DisplaySetEvent.

       

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

 

Display devices
Event
DisplayAddObject
DisplayClearBackgroundEvent
DisplaySetEvent
DisplayClearEvent