EventWatcher

public class EventWatcher : IDisposable
An instance-based watcher for document and object events that can be notified for headless documents.

The static events on RhinoDoc are never raised for headless documents (a headless document is one created with RhinoDoc.CreateHeadless(string) or RhinoDoc.OpenHeadless(string), as used by Rhino.Inside and Rhino.Compute). Create an EventWatcher with includeHeadlessDocuments set to true to receive events for those documents as well.

IMPORTANT: When watching headless documents, events may be raised on a thread other than the main/UI thread, because headless documents can be created and read on background threads. Handlers must be thread-safe and must not assume they are running on the UI thread.

Call Dispose() when the watcher is no longer needed to stop receiving events and release the underlying native watcher.

Constructors

EventWatcher

#Since v9.0
Creates a new event watcher and begins watching.
public EventWatcher(
includeHeadlessDocuments
When true, events are also raised for headless documents. In this case handlers may be invoked on a non-UI thread (see the remarks on EventWatcher).
)

Finalizer

~EventWatcher

#
Releases the native watcher if Dispose() was not called.
~EventWatcher()

Properties

IncludeHeadlessDocuments

#Since v9.0
Gets whether this watcher also receives events for headless documents.
public bool IncludeHeadlessDocuments { get; }

Methods

Dispose

#Since v9.0
Stops watching and releases the underlying native watcher.
public void Dispose()

Events

AddRhinoObject

#Since v9.0
Raised when a new object is added to a document.
public event EventHandler<RhinoObjectEventArgs> AddRhinoObject

BeginOpenDocument

#Since v9.0
Raised when a document open operation begins.
public event EventHandler<DocumentOpenEventArgs> BeginOpenDocument

CloseDocument

#Since v9.0
Raised when a document is closed.
public event EventHandler<DocumentEventArgs> CloseDocument

DeleteRhinoObject

#Since v9.0
Raised when an object is deleted from a document.
public event EventHandler<RhinoObjectEventArgs> DeleteRhinoObject

EndOpenDocument

#Since v9.0
Raised when a document open operation ends.
public event EventHandler<DocumentOpenEventArgs> EndOpenDocument

NewDocument

#Since v9.0
Raised when a new document is created.
public event EventHandler<DocumentEventArgs> NewDocument

PurgeRhinoObject

#Since v9.0
Raised when an object is purged from a document.
public event EventHandler<RhinoObjectEventArgs> PurgeRhinoObject

ReplaceRhinoObject

#Since v9.0
Raised when an object is about to be replaced.
public event EventHandler<RhinoReplaceObjectEventArgs> ReplaceRhinoObject

UndeleteRhinoObject

#Since v9.0
Raised when a previously deleted object is un-deleted.
public event EventHandler<RhinoObjectEventArgs> UndeleteRhinoObject