GetDisplayRoot

(System Library)

Description: Climbs the call tree looking for the best display context.
Returns: Window reference
Usage: Script Only.
Function Groups: Graphics
Related to: VStatus
Format: System.GetDisplayRoot(StartContext)
Parameters:  
StartContext  
Optional. Local window reference for where to start looking for DisplayRoot. Defaults to Self().
Comments:

"DisplayRoot" is used as a standard variable name to identify the best context for the monitor (as defined by VStatus(DisplayRoot, 35) to use.

Any running object in an unexpected context (i.e. launched with a caller that might be in a different monitor than expected) should have its own DisplayRoot variable or parameter which is set to a context in a window on the expected monitor.

 

For example, the tag browser has a DisplayRoot parameter, because the tag browser is launched from many different locations with many callers. The DisplayRoot parameter allows us to specify the most natural context to use as the originating display.