Clone

Description

Creates a general duplicate of the current PBDOM_OBJECT.

Syntax

pbdom_object_name.Clone(boolean bDeep)

Argument

Description

pbdom_object_name

The name of the PBDOM_OBJECT.

bDeep

A boolean specifying whether a deep or shallow clone is returned. Values are true for a deep clone and false for a shallow clone.


Return value

PBDOM_OBJECT. The return value is the clone of the PBDOM_OBJECT.

Throws

EXCEPTION_PBDOM_OBJECT_INVALID_FOR_USE -- This PBDOM_OBJECT object is not associated with a derived PBDOM_OBJECT class object.

Usage

The Clone method creates a general duplicate of the current PBDOM_OBJECT. If the bDeep parameter is true, a deep clone is returned; otherwise, a shallow clone is returned.

A PBDOM_OBJECT clone does not have a parent; however, it resides in the same PBDOM_DOCUMENT as its original. If the original PBDOM_OBJECT is standalone, the clone is also standalone.

If general, if bDeep is true, the Clone method recursively clones the subtree under the PBDOM_OBJECT. If bDeep is false, the Clone method clones only the PBDOM_OBJECT itself, together with as much information as possible.

Cloning is class specific

Cloning is not uniform across all PBDOM_OBJECT classes. See the documentation for each class for specific information.