View source for FAQ What are IWorkspaceRunnable, IRunnableWithProgress, and WorkspaceModifyOperation?

<tt>IWorkspaceRunnable</tt> is a mechanism for batching a set of changes to the workspace so that change notification and autobuild are deferred until the entire batch completes. <tt>IRunnableWithProgress</tt> is a mechanism for batching a set of changes to be run outside the UI thread.  You often need to do both of these at once: Make multiple changes to the workspace outside the UI thread.  Wrapping one of these mechanisms inside the other would do the trick, but the resulting code is cumbersome, and it is awkward to communicate arguments, results, and exceptions between the caller and the operation to be run.

The solution is to use <tt>WorkspaceModifyOperation</tt>.  This class rolls the two mechanisms together by implementing <tt>IRunnableWithProgress</tt> and performing the work within a nested <tt>IWorkspaceRunnable</tt>. To use it, simply create a subclass that implements the abstract method <tt>execute</tt>, and pass an instance of this subclass to <tt>IRunnableContext.run</tt> to perform the work.  If you already have an instance of <tt>IRunnableWithProgress</tt> on hand, it can be passed to the constructor of the special subclass <tt>WorkspaceModifyDelegatingOperation</tt> to create a new <tt>IRunnableWithProgress</tt> that performs workspace batching for you.

== See Also: ==
*[[FAQ Actions, commands, operations, jobs: What does it all mean?]]
*[[FAQ How do I prevent builds between multiple changes to the workspace?]]

{{Template:FAQ Tagline}}