document.punch()

Availability

Flash 8.

Usage

document.punch()

Parameters

None.

Returns

A Boolean value: true if successful; false otherwise.

Description

Method; uses top selected drawing object to punch through all selected drawing objects underneath it. This method returns false if there are no drawing objects selected, or if any of the selected items are not drawing objects.

Example

The following example punches through drawing objects underneath the selected drawing object:

fl.getDocumentDOM().punch();