Returns a vector containing the predecessor of the specified element
starting from the immediate one (which is provided by
element.predecessor
property) until the predecessor
whose unique identifier is equal to the specified one
(if parameter included
is true
, that predecessor
will also be included in result vector).
The element predecessors are other elements by which the given element has been reached as it was retrieved from the data source (DSM). See also "What are element predecessors?" below.
Note: This is a convenience function whose result may be achieved
using GOMElement.predecessors
and
GOMElement.id
properties and the functions:
iterate(), Vector()
.
Parameters:
element
The element whose predecessors are requested.If not specified, the generator context element is assumed, which is the same as the call:
See Also:getPredecessorsUntilId ( contextElement, elementId, included )
GOMContext.contextElement
Note: When this parameter is
null
, the function returns an empty vector.
elementId
The element unique identifier that terminates the predecessor search.See Also:
GOMElement.id
When neither of the predecessors has an identifiers equal to the specified one, the result vector will include all predecessors (same as it would be returned by:
element.predecessors.toVector()
).
included
When this parameter is true
, the predecessor on whom
the search was terminated will also be included in the result
vector (as its last element).
See Also:
GOMElement.id, findElementById()
${include ../../../refs/element_predecessors.htm}
${include ../../../refs/element_id.htm}