Page Header and Trailer
- Last UpdatedJan 28, 2025
- 5 minute read
Headers
A page Header will be rendered at the top of each sheet in the resulting workbook. A Header row spans all columns in a sheet:
The full syntax for page Header definitions are as follows:
<Page>
<Headers>
<Header geicl:id="Name" style="PageHeader" value="./@name ?? ./@id" suppress="$suppressHeader">
<Style>
<Font bold="true"/>
</Style>
<Conditions>
<Condition geicl:id="Demo" where="./@id ?== 'aveva.com'" value="Demo Class Library" style="DemoPageHeader">
<Style><Fill patternColor="rgb(209,204,0)"/> </Style>
</Condition>
</Conditions>
</Header>
<Header geicl:id="Blank Line" style="Default" value="' '"/>
</Headers>
</Page>
|
Element |
Property |
Description |
|---|---|---|
|
Page |
The containing element for Headers and Trailers. All expressions supplied for property values on this element, and any descendants, will be resolved in the context of the ClassLibrary node (see Context nodes and expression syntax). |
|
|
Headers |
The containing element holding a collection of Header definitions |
|
|
Header |
geicl:id |
Assigns an identifier to the Header. All items inside a collection element, such as Headers must have an identifier which is unique within the containing collection |
|
style |
An optional reference to a Named Style definition from the Named styles section above. The content of the Header will be formatted according to the referenced style definition. If not specified, the default value will be taken from PermissibleGrid@style |
|
|
Value |
An expression defining the content of the header row (see Value expressions) |
|
|
suppress |
When the value of this property resolves to true the Header definition will be excluded from the report definition. This feature can e.g. be used select applicable Header definitions, based on conditions derived from context or user input |
|
|
geicl:sortOrder |
An integer value that controls the order of siblings in the containing collection. To fully understand the impact of using this property. |
|
|
Style |
An optional inline style definition, supporting the same syntax as Named styles. When present, all inline definitions will take precedence over the definitions in a Named Style, referenced by the @style property |
|
|
Conditions |
The containing element for optional Condition definitions. Condition definitions can be used to override style settings and optionally the @value of the header row, based on a condition. |
|
|
Condition |
geicl:id |
Assigns an identifier to the Condition. All items inside a collection element, such as Conditions must have an identifier which is unique within the containing collection |
|
where |
A Boolean expression used to control whether the condition is fulfilled (see Context nodes and expression syntax) |
|
|
style |
An optional reference to a Named Style definition from the Named styles section above. When the condition is fulfilled the effective style for the header row will be an aggregate of the style definitions on the Condition and the Header, with definitions on Condition taking precedence |
|
|
value |
An optional expression defining the content of the header row (see Value expressions). When the condition is fulfilled, the Condition@value will take precedence over the Header@value. The presence of @value has an impact on how Condition statements are applied: When there are more than one Condition having @value, the first fulfilled Condition (in the order of appearance) will be applied. When there are one or more Condition not having @value, all fulfilled Condition will be applied. I.e. the style definitions from all fulfilled Condition without @value will be aggregated together with any style definitions on the Header |
|
|
Condition/Style |
An optional inline style definition, supporting the same syntax as Named styles. When present, all inline definitions will take precedence over the definitions in a Named Style, referenced by the @style property |
Trailers
A page Trailer will be rendered at the bottom of each sheet in the workbook. A Trailer row spans all columns in a sheet:
The full syntax for page Trailer definitions are as follows:
<Page>
<Headers>
…
</Headers>
<Trailers>
<Trailer geicl:id="Blank Line" style="Default" value="' '" suppress="$suppressTrailer1"/>
<Trailer geicl:id="Version" style="PageTrailer" value="'Version '.concat(./@version)">
<Style>
<Font italic="true"/>
</Style>
<Conditions>
<Condition geicl:id="Not Released" where="!(./@version ?== '.0')" value="'Version '.concat(./@version, ' (unofficial)')"
style="PageTrailerUnofficial"/>
</Conditions>
</Trailer>
</Trailers>
</Page>
|
Element |
Property |
Description |
|---|---|---|
|
Page |
The containing element for Headers and Trailers. All expressions supplied for property values on this element, and any descendants, will be resolved in the context of the ClassLibrary node (see Context nodes and expression syntax). |
|
|
Trailers |
The containing element holding a collection of Trailer definitions |
|
|
Trailer |
geicl:id |
Assigns an identifier to the Trailer. All items inside a collection element, such as Trailers must have an identifier which is unique within the containing collection |
|
style |
An optional reference to a Named Style definition from the Named styles section above. The content of the Trailer will be formatted according to the referenced style definition. If not specified, the default value will be taken from PermissibleGrid@style |
|
|
value |
An expression defining the content of the trailer row (see Value expressions) |
|
|
suppress |
When the value of this property resolves to true the Trailer definition will be excluded from the report definition. This feature can e.g. be used select applicable Trailer definitions, based on conditions derived from context or user input |
|
|
geicl:sortOrder |
An integer value that controls the order of siblings in the containing collection. To fully understand the impact of using this property. |
|
|
Style |
An optional inline style definition, supporting the same syntax as Named styles. When present, all inline definitions will take precedence over the definitions in a Named Style, referenced by the @style property |
|
|
Conditions |
The containing element for optional Condition definitions. Condition definitions can be used to override style settings and optionally the @value of the trailer row, based on a condition. |
|
|
Condition |
geicl:id |
Assigns an identifier to the Condition. All items inside a collection element, such as Conditions must have an identifier which is unique within the containing collection |
|
where |
A Boolean expression used to control whether the condition is fulfilled (see Context nodes and expression syntax) |
|
|
style |
An optional reference to a Named Style definition from the Named styles section above. When the condition is fulfilled the effective style for the trailer row will be an aggregate of the style definitions on the Condition and the Trailer, with definitions on Condition taking precedence |
|
|
value |
An optional expression defining the content of the trailer row (see Value expressions). When the condition is fulfilled, the Condition@value will take precedence over the Trailer@value. The presence of @value has an impact on how Condition statements are applied: When there are more than one Condition having @value, the first fulfilled Condition (in the order of appearance) will be applied. When there are one or more Condition not having @value, all fulfilled Condition will be applied. I.e. the style definitions from all fulfilled Condition without @value will be aggregated together with any style definitions on the Trailer |
|
|
Condition/Style |
An optional inline style definition, supporting the same syntax as Named styles. When present, all inline definitions will take precedence over the definitions in a Named Style, referenced by the @style property |