4Suite API Documentation: Ft.Xml.XPointer.XPtrFunctions

4Suite™ API Documentation

# ► Module Ft.Xml.XPointer.XPtrFunctions

Functions: EndPoint, Here, Origin, Range, RangeInside, RangeTo, StartPoint, StringRange, Unique |  |  |  | Globals: CoreFunctions, EMPTY_NAMESPACE

## Functions

EndPoint(context, point)
  <point> end-point(<point>)

      For each location x in the argument location-set, end-point adds a location
      of type point to the result location-set.

Here(context)
  <location-set> here()

      The here function returns a location-set with a single member.  That
      location locates the node that directly contains the XPointer being
      evaluated.

Origin(context)
  <location-set> origin()

      The origin functions enables addressing relative to out-of-line links
      such as defined in XLink. This allows XPointers to be used in applications
      to express relative locations when links do not reside directly at one of
      their endpoints. The function returns a location-set with a single member,
      which locates the element from which a user or program initiated traversal
      of the link.

Range(context, locationSet)
  <location-set> range(<location-set>)

      The range function returns ranges covering the locations in the argument
      location-set.  For each location x in the argument location-set, a range
      location representing the covering range of x is added to the result
      location-set.

RangeInside(context, locationSet)
  <location-set> range-inside(<location-set>)

      The range-inside function returns ranges covering the content of the
      locations in the argument location-set.  For each location x in the
      argument location-set, a range location is added to the result location-set.

RangeTo(context, expr)
  <location-set> range-to(<expr>)

      For each location in the context, range-to returns a range.

StartPoint(context, point)
  <point> start-point(<point>)

      For each location x in the argument location-set, start-point adds a
      location of type point to the result location-set.

StringRange(context, string, startPos=1, length=None)
  <location-set> string-range(<location-set>, <string>, <number>?, <number>?)

      For each location in the location-set argument, string-range returns a set
      of string ranges, a set of substrings in a string.

Unique(context)
  <boolean> unique()

      The predicate function unique returns true if and only if context size is
      equal to 1.

## Globals

CoreFunctions = {(None, 'end-point'): <function EndPoint>, (None, 'here'): <function Here>, (None, 'origin'): <function Origin>, (None, 'range'): <function Range>, (None, 'range-inside'): <function RangeInside>, (None, 'range-to'): <function RangeTo>, (None, 'start-point'): <function StartPoint>, (None, 'string-range'): <function StringRange>, (None, 'unique'): <function Unique>}
EMPTY_NAMESPACE = None