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 for the ScreenOutline object

You can use the following methods 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.

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.

Property summary for the ScreenOutline object

You can use the following properties with the ScreenOutline object:

Property	Description
screenOutline.currentScreen	A Screen object; the currently selected screen.
screenOutline.rootScreen	Read-only; the first screen in the screen outline.
screenOutline.screens	Read-only; the array of top-level Screen objects contained in the document (see Screen object).

Property

Description

screenOutline.currentScreen

A Screen object; the currently selected screen.

screenOutline.rootScreen

Read-only; the first screen in the screen outline.

screenOutline.screens

Read-only; the array of top-level Screen objects contained in the document (see Screen object).

Flash CS3