Community articleAbout references
Added by IBM contributorIBM on May 2, 2012
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.



References allow you to identify a specific page, item, option, or argument by providing a "path" to that element. This means that you can access an element directly without having to locate any of its ancestors. The syntax of a reference follows this general pattern:
   page.item.option [argument]

Each element of the reference is constructed as follows:
  • Page and Item — Pages and items are identified by their scope identifiers (sid). For example, Page1 or Field1.
  • Options — Options are identified by their tag name. For example, value or itemlocation.
  • Arguments — Arguments are identified by their tag name or a zero-based numeric index. Argument references are always enclosed in brackets. For example, [1] or [message].
  • Arguments can also have any depth. For example, you might have an argument that contains arguments. You can reference additional levels of depth by adding another bracketed reference. For example, to refer to the first argument in the first argument of the printsettings option, you could use either [0][0] or the tag names in brackets, such as [pages][filter].
You can create references to any level of the node hierarchy. For example, the following table illustrates a number of references starting at different levels of the form:
Start AtRef to PageRef to ItemRef to OptionRef to Argument
PagePage1Page1.Field1Page1.Field1.formatPage1.Field1.format[message]
ItemField1Field1.formatField1.format[message]
Optionformatformat[message]
Argument[message]


Parent topic:
C API