swirl Guide to OmniMark 5   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesOMX VariablesErrors
 
  Related Syntax    
operator   ancestor is    

Return type: Boolean
Returns:       

Returns true if the named element occurs in the element stack before the current or specified element, otherwise false.



Syntax
  ancestor ancestry-qualifier (is | isnt) element-name


Purpose

An element test. An element can be opened more than once, so its "name" can occur more than once in a set of opened elements. As a consequence, a specific element is typically identified by a "relationship" to another element, as well as or instead of by its name. ancestor refers to any element containing the specified element at any level. This is a very broad parameter, so care should be taken in its use.

The test returns true if the element indicated has any ancestor with the specified element name, and false otherwise. Replacing is with isnt will reverse these results.

If no element qualifiers are present, the test always starts searching for ancestors starting with the parent of the current element.

Instead of specifying only a single element name, the test allows the programmer to specify a parenthesized list of element names separated by or (or |). The test succeeds if the reference element is identified by any of the names in this element name list.

    Related Syntax
   element
   parent is
   preparent is
 
 
----  

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ OMX ] [ OMX ] [ ERRORS ]

Generated: August 11, 2000 at 3:06:58 pm
If you have any comments about this section of the documentation, send email to docerrors@omnimark.com

Copyright © OmniMark Technologies Corporation, 1988-2000.