User Guide

742 Chapter 14: Properties
dockingEnabled
Usage
-- Lingo syntax
_movie.displayTemplate.dockingEnabled
windowObjRef.dockingEnabled
// JavaScript syntax
_movie.displayTemplate.dockingEnabled;
windowObjRef.dockingEnabled;
Description
Movie and Window property; specifies whether a movie in a window (MIAW) will be a dockable
window when opened during authoring. Read/write.
This property cannot be accessed directly from a Movie object; you access this property from the
Movie object’s
displayTemplate property.
The default value of this property is
FALSE, which specifies that a MIAW will not be dockable
when opened during authoring. If this property is set to
TRUE, the value of the Window object’s
type property determines how the window will appear during authoring.
• If dockingEnabled is TRUE and type is set to #document, the MIAW will look and act like a
document windows in Director. The window will appear in the “view port” area and be
dockable with the Stage, Score, and Cast windows, media editors, and message windows.
However, the window will not be able to group with any of these windows.
• If dockingEnabled is TRUE and type is set to #tool, the MIAW will look and act like one of
tool windows in Director. The window will be able to group with all tool windows except the
Property inspector and the Tool palette.
• If dockingEnabled is TRUE and type is set to #dialog, the type is ignored and the window
will be an authoring window.
This property is ignored in projectors.
Example
These statements set the dockingEnabled property to TRUE.
-- Lingo syntax
_movie.displayTemplate.dockingEnabled = TRUE -- from the Movie object
window("Instructions").dockingEnabled = TRUE -- from the Window object
// JavaScript syntax
_movie.displayTemplate.dockingEnabled = true; // from the Movie object
window("Instructions").dockingEnabled = true; // from the Window object
See also
appearanceOptions, displayTemplate, Movie, titlebarOptions, type (Window),
Window