:: Documentation >>

header model

Contains the properties (text, image, tooltip etc.) of the grid column headers.

Syntax

var value = obj.getHeaderProperty(name); // Retrieve property by name
obj.setHeaderProperty(name, value);      // Assign property value
obj.defineHeaderProperty(name, value);   // Define new property

var external = obj.getHeaderModel();     // Get reference to external model
obj.setHeaderModel(external);            // Assign external model
obj.clearHeaderModel();                  // Clear/reset all properties

Properties

countNumber of header rows.
dataHeader data.
formatHeader formatting object.
heightHeight of the header row.
imageHeader image.
indicesArray of header row indices.
linkHeader hyperlink URL.
offsetOffset of the first header row.
stateHeader row state.
textHeader text.
tooltipHeader tooltip.
valueHeader value.
visibleIndicates whether headers are visible.

Defined in

AW.UI.Grid

Used by

header template, headers template, top template (extended)

Examples

obj.setHeaderText("header text", 0); 
obj.setHeaderImage("favorites", 0);
obj.setHeaderTooltip("tooltip text", 0);

See also

Grid templates: header
Related models: column, cell, top, footer

Comments

Documentation:

Recent changes:

2.6.4
2.6.3
2.6.2
2.6.1
2.6.1
2.6.0
2.5.0 - 2.5.6
2.5.6
2.5.0 - 2.5.5
2.5.5