Equals

Description

Tests for the equality of the current PBDOM_TEXT object and a referenced PBDOM_OBJECT.

Syntax

pbdom_text_name.Equals(pbdom_object pbdom_object_ref)

Argument

Description

pbdom_text_name

The name of a PBDOM_TEXT object

pbdom_object_ref

A reference to a PBDOM_OBJECT to test for equality with the current PBDOM_TEXT object


Return value

Boolean.

Returns true if the current PBDOM_TEXT object is equivalent to the input PBDOM_OBJECT, and false otherwise.

Throws

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

Usage

True is returned only if the referenced PBDOM_OBJECT is also a derived PBDOM_TEXT object and refers to the same DOM object as the current PBDOM_TEXT object. Two separately created PBDOM_TEXT objects, for example, can contain exactly the same text but not be equal.