top data

Sets or retrieves the data in the top-left corner of the grid control (top selector data). Converted to the display text by the top format object.

Syntax

var value = obj.getTopData(); 
obj.setTopData(value);        

obj.onTopDataChanging = function(value){...}; 
obj.onTopDataChanged = function(value){...}; 
obj.onTopDataError = function(value){...}; 

Defined in

top model

Examples

Encoding html control characters (<, >, ", &).

obj.setTopData("<top text>");
obj.setTopFormat(new AW.Formats.String);
obj.setTopText(function(i){
    var data = this.getTopData(i);
    var format = this.getTopFormat(i);
    return format ? format.dataToText(data) : data;
});

<script> var obj = new AW.UI.Grid; obj.setSelectorVisible(true); obj.setSelectorWidth(100); obj.setTopData("<top text>"); obj.setTopFormat(new AW.Formats.String); obj.setTopText(function(i){ var data = this.getTopData(i); var format = this.getTopFormat(i); return format ? format.dataToText(data) : data; }); document.write(obj); </script>

Applying number format

var number = new AW.Formats.Number;
number.setTextFormat("$ #,###.##");

obj.setTopData("1234567.890");
obj.setTopFormat(number);
obj.setTopText(function(i){
    var data = this.getTopData(i);
    var format = this.getTopFormat(i);
    return format ? format.dataToText(data) : data;
});

<script> var obj = new AW.UI.Grid; obj.setSelectorVisible(true); obj.setSelectorWidth(100); var number = new AW.Formats.Number; number.setTextFormat("$ #,###.##"); obj.setTopData("1234567.890"); obj.setTopFormat(number); obj.setTopText(function(i){ var data = this.getTopData(i); var format = this.getTopFormat(i); return format ? format.dataToText(data) : data; }); document.write(obj); </script>

Remarks

Should always be used together with the top format object and converter function in the top text property (see the examples above).

See also

Overview: using format converters
Grid templates: top selector
Top model: text, image, tooltip, link, value, format
Data properties: cell, selector, header, footer, bottom