SetParentObject

Description

Sets the referenced PBDOM_OBJECT to be the parent of the current PBDOM_TEXT object.

Syntax

pbdom_text_name.SetParentObject(pbdom_object pbdom_object_ref)

Argument

Description

pbdom_text_name

The name of a PBDOM_TEXT object

pbdom_object_ref

A PBDOM_OBJECT to be set as the parent of the current PBDOM_TEXT object


Return value

PBDOM_OBJECT.

Throws

EXCEPTION_PBDOM_OBJECT_INVALID_FOR_USE -- If the input PBDOM_OBJECT is not referenced to an object derived from PBDOM_OBJECT.

EXCEPTION_PBDOM_OBJECT_ALREADY_HAS_PARENT -- If the current PBDOM_TEXT object already has a parent.

EXCEPTION_INAPPROPRIATE_USE_OF_PBDOM_OBJECT -- If the input PBDOM_OBJECT is of a class that does not have a proper parent-child relationship with the PBDOM_TEXT class.

EXCEPTION_USE_OF_UNNAMED_PBDOM_OBJECT -- If the input PBDOM_OBJECT requires a user-defined name and it has not been named.

Usage

The PBDOM_OBJECT that you set to be the parent of the current PBDOM_TEXT object must have a legal parent-child relationship with the current object. If it does not, an exception is thrown. Only a PBDOM_ELEMENT is allowed to be set as the parent of a PBDOM_TEXT object.

See also

GetParentObject