header text

Sets or retrieves the text in the grid column headers (header text). Does not encode the html controls characters (<, >, ", &) - the text containing correct html markup will be displayed as html.

Syntax

var value = obj.getHeaderText(); 
obj.setHeaderText(value);        

obj.onHeaderTextChanging = function(value){...}; 
obj.onHeaderTextChanged = function(value){...}; 
obj.onHeaderTextError = function(value){...}; 

Defined in

header model

Examples

Single header cell

obj.setHeaderText("header text", 0); // header text, column-0

<script> var obj = new AW.UI.Grid; obj.setColumnCount(10); obj.setHeaderText("header text", 0); // header text, column-0 obj.setHeaderImage("favorites", 0); obj.setHeaderTooltip("tooltip text", 0); document.write(obj); </script>

Complete header row

obj.setHeaderText(textArray); // header text, array

<script> var textArray = ["Home", "Favorites", "Font size", "Search"]; var imageArray = ["home", "favorites", "fontsize", "search"]; var tooltipArray = ["home", "favorites", "fontsize", "search"]; var obj = new AW.UI.Grid; obj.setColumnCount(10); obj.setHeaderText(textArray); // header text, array obj.setHeaderImage(imageArray); obj.setHeaderTooltip(tooltipArray); document.write(obj); </script>

Extended grid (multiple header rows)

// 3 header rows
obj.setHeaderCount(3);

// function - all columns/rows
obj.setHeaderText(function(col, row){return col + "." + row});

// array - row 1
obj.setHeaderText(["Home", "Favorites", "Font size", "Search"], 1);

// single value - col 0, row 0
obj.setHeaderText("** header **", 0, 0);

<script> var obj = new AW.Grid.Extended; obj.setColumnCount(10); // 3 header rows obj.setHeaderCount(3); // function - all columns/rows obj.setHeaderText(function(col, row){return col + "." + row}); // array - row 1 obj.setHeaderText(["Home", "Favorites", "Font size", "Search"], 1); // single value - col 0, row 0 obj.setHeaderText("** header **", 0, 0); document.write(obj); </script>

Remarks

When some of the html controls characters (<, >, ", &) should appear as text - convert them into html entity codes (<, >, ", &).

See also

Grid templates: header
Header model: image, tooltip, link, value, data, format
Text properties: cell, selector, footer, top, bottom