bottom format

Sets or retrieves the data format converter for the bottom-left corner of the grid (bottom selector format).

Format converters are used to perform client-side data transformations, for example, encode html control characters or apply particular date or number formats.

Syntax

var value = obj.getBottomFormat(); 
obj.setBottomFormat(value);        

obj.onBottomFormatChanging = function(value){...}; 
obj.onBottomFormatChanged = function(value){...}; 
obj.onBottomFormatError = function(value){...}; 

Defined in

bottom model

Examples

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

obj.setBottomData("<bottom text>");
obj.setBottomFormat(new AW.Formats.String);
obj.setBottomText(function(i){
    var data = this.getBottomData(i);
    var format = this.getBottomFormat(i);
    return format ? format.dataToText(data) : data;
});

<script> var obj = new AW.UI.Grid; obj.setFooterVisible(true); obj.setSelectorVisible(true); obj.setSelectorWidth(100); obj.setBottomData("<bottom text>"); obj.setBottomFormat(new AW.Formats.String); obj.setBottomText(function(i){ var data = this.getBottomData(i); var format = this.getBottomFormat(i); return format ? format.dataToText(data) : data; }); document.write(obj); </script>

Applying number format

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

obj.setBottomData("1234567.890");
obj.setBottomFormat(number);
obj.setBottomText(function(i){
    var data = this.getBottomData(i);
    var format = this.getBottomFormat(i);
    return format ? format.dataToText(data) : data;
});

<script> var obj = new AW.UI.Grid; obj.setFooterVisible(true); obj.setSelectorVisible(true); obj.setSelectorWidth(100); var number = new AW.Formats.Number; number.setTextFormat("$ #,###.##"); obj.setBottomData("1234567.890"); obj.setBottomFormat(number); obj.setBottomText(function(i){ var data = this.getBottomData(i); var format = this.getBottomFormat(i); return format ? format.dataToText(data) : data; }); document.write(obj); </script>

Remarks

To activate the data/text transformations set the bottom text property to the converter function, like in example above.

See also

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