Adobe Extending Flash Professional CS4 - Manual (Page 397)

375
Chapter 37: ScreenOutline object
Availability
Flash MX 2004.
Description
The ScreenOutline object represents the group of screens in a slide or form document. The object is accessed by using
fl.getDocumentDOM().screenOutline.
The ScreenOutline object exists only if the document is a slide or form document, so before accessing the property, use
document.allowScreens() to verify that a Screens document exists, as shown in the following example:
if(fl.getDocumentDOM().allowScreens) {
var myName = fl.getDocumentDOM().screenOutline.rootScreen.childScreens[0].name;
fl.trace("The name of the screen is " + myName + ". ");
}
Method summary
You can use the following methods with the ScreenOutline object:
Property summary
You can use the following properties with the ScreenOutline object:
Method Description
screenOutline.copyScreenFromFile() Inserts all the screens, or a named screen and its children, from a
specified document under the currently selected screen.
screenOutline.deleteScreen() Deletes the currently selected screen(s), or a specified screen, and the
children of the screen(s).
screenOutline.duplicateScreen() Duplicates the currently selected screen(s) or a specified screen.
screenOutline.getSelectedScreens() Returns an array of Screen objects that are currently selected in the
screen outline.
screenOutline.insertNestedScreen() Inserts a nested screen of a specific type into a particular location in
the screen outline.
screenOutline.insertScreen() Inserts a new blank screen of a specified type into the document at a
specified location.
screenOutline.moveScreen() Moves the specified screen in relation to the value of the
referenceScreen parameter; either before, after, as the first child,
or as the last child.
screenOutline.renameScreen() Changes the screen with a specified name to a new name.
screenOutline.setCurrentScreen() Sets the current selection in the screen outline to the specified screen.
screenOutline.setScreenProperty() Sets the specified property with the specified value for the selected
screens.
screenOutline.setSelectedScreens() Selects the specified screens in the Screen Outline pane.