SpreadJS Documentation
format Method
The object value to format.
The format.
The conditional foreground color.
The context associated with the cell type. See the Remarks for more information.
Formats a value with the specified format to a string.
Syntax
var instance = new GcSpread.Sheets.BaseCellType();
var returnValue; // Type: string
returnValue = instance.format(value, format, conditionalForeColor, context);
function format( 
   value : object,
   format : GeneralFormatter,
   conditionalForeColor : object,
   context : object
) : string;

Parameters

value
The object value to format.
format
The format.
conditionalForeColor
The conditional foreground color.
context
The context associated with the cell type. See the Remarks for more information.

Return Value

Returns the formatted string.
Remarks

The context parameter can include the following items:

Item Type Description
context.sheet GcSpread.Sheets.Sheet instance Indicates the current sheet.
context.row number The row index.
context.col number The column index.
context.sheetArea GcSpread.Sheets.SheetArea The current sheet area.

 

See Also

Reference

BaseCellType type

 

 


Copyright © GrapeCity, inc. All rights reserved.

Send comments on this topic.