layout:getPaneInstance

Purpose

Returns a reference to one instance of a pane inside an iterating format. The reference can be used wherever a pane name can be used.

Note:

Only useful in XDIME rendering. For XDIME 2 see Container reference functions.

Signature

layout:getPaneInstance [paneStem, index]

Parameter

Name Description Type Use
paneStem The name of the pane as it appears in the layout without any index dependent information xs:string required 
index The index of the instance of the pane required. There must be at least one of these values. There may be more if the reference requires it. xs:integer required 

Example

<?xml version="1.0" encoding="UTF-8"?>
<canvas layoutName="/test.mlyt" pageTitle="layout:getPaneInstance">
  <pane name="{layout:getPaneInstance('Aaa', 0)}">
    <p>Pane "Aaa" inside a spacial iterator (1st instance)</p>
  </pane>
  <pane name="{layout:getPaneInstance('Aaa', 1)}">
    <p>Pane "Aaa" inside a spacial iterator (2nd instance)</p>
  </pane>
  <pane name="{layout:getPaneInstance('Aaa', 2)}">
    <p>Pane "Aaa" inside a spacial iterator (3rd instance)</p>
  </pane>
</canvas>

The test.mlyt layout may have the following structure.

Spatial Iterator - Pane

Related topics