displayTemplate

Usage

-- Lingo syntax
_movie.displayTemplate

// JavaScript syntax
_movie.displayTemplate;

Description

Movie property; provides access to a list of properties that are applied to the window in which a movie is playing back. Read/write.

The displayTemplate property provides access to the properties of the Window object that are used to specify default window settings. Therefore, displayTemplate is used on the Movie object to return or set default window settings in the same way the appearanceOptions and titlebarOptions properties are used on the Window object.

The displayTemplate property provides access to the following properties.

Property	Description
appearanceOptions	A property list that stores appearance options for a window. The appearance options are `mask`, `border`, `metal`, `dragRegionMask`, `shadow`, and `liveresize`. For more information, see `appearanceOptions`.
dockingEnabled	Determines whether a movie in a window (MIAW) will be dockable when opened during authoring. If `TRUE`, the window can be docked. If `FALSE`, the window cannot be docked. The default value is `FALSE`. For more information, see `dockingEnabled`.
resizable	Determines whether a window is resizable. If `TRUE`, the window is resizable. If `FALSE`, the window is not resizable. The default value is `TRUE`. For more information, see `resizable`.
title	Returns or sets the title of the display template. For more information, see `title`.
titlebarOptions	A property list that stores title bar options for a window. The title bar options are `icon`, `visible`, `closebox`, `minimizebox`, `maximizebox`, and `sideTitlebar`. For more information, see `titlebarOptions`.
systemTrayIcon	(Microsoft Windows only) Determines whether a window has an associated icon in the system tray of a user's desktop.
systemTrayTooltip	(Microsoft Windows only) Determines the string that appears in the tooltip pop-up of the system tray icon.
type	Returns or sets the type of a window. If a window's type is set, all of the properties pertaining to that window type are set as well. The types of windows are `tool`, `document`, and `dialog`. For more information, see `type`.

Example

These statements display the displayTemplate properties and their corresponding values in the Message window.

-- Lingo syntax
trace(_movie.displayTemplate)

// JavaScript syntax
trace(_movie.displayTemplate);

These statements set various displayTemplate properties.

-- Lingo syntax
_movie.displayTemplate.dockingEnabled = TRUE
_movie.displayTemplate.resizable = FALSE
_movie.displayTemplate.appearanceOptions.mask = member("mask")
_movie.displayTemplate.titlebarOptions.sideTitlebar = TRUE

// JavaScript syntax
_movie.displayTemplate.dockingEnabled = true;
_movie.displayTemplate.resizable = false;
_movie.displayTemplate.appearanceOptions.mask = member("mask");
_movie.displayTemplate.titlebarOptions.sideTitlebar = true;

displayTemplate

Usage

Description

Example

See also