element <gridTemplate>
Namespace: |
http://schema.caplin.com/CaplinTrader/gridDefinitions |
XML Representation Summary |
<gridTemplate
|
|
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string : "Inherited from parent"
|
|
|
> |
|
|
</gridTemplate>
|
Child elements (4):
-
Parent elements (1):
-
Description
A grid template is an abstract grid definition. Multiple physical grids (<grid>) can be defined using
the same template; the physical grids inherit the characteristics of the template.
This allows various aspects of the physical grids, such as the default displayed columns, column names,
and column widths, to be reconfigured simply by modifying the template(s) associated with the grid.
A grid template can be based on (inherit from) another grid template.
Grid templates do not appear in the list of available grids when the user chooses to insert a new grid
into their layout.
baseTemplate
-
Type: |
xs:string, predefined
|
Use: |
optional |
The <gridTemplate>, if there is one, that this template inherits from.
displayedColumns
-
Type: |
xs:string, predefined
|
Use: |
optional |
Default: |
"Inherited from parent" |
The columns to display in the grid by default (for example, when the grid is first displayed),
and the order they should initially appear in. The columns defined within the <columnDefinitions>
tag specify all the available columns within a grid, but not the default set of columns
initially presented to the end user.
If a <gridTemplate> does not specify a displayedColumns attribute, it will inherit the value
from its parent, unless the template has no parent, in which case the attribute is undefined.
Note that a value for displayedColumns must be explicitly specified somewhere
in the inheritance hierarchy of a grid.
id
-
Type: |
xs:string, predefined
|
Use: |
required |
The identifier of this grid template.
The identifier must be unique across all grids (<grid>) and grid Templates.