format Method

Formats a value with the specified format to a string.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.CellTypes.Base();
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	GC.Spread.Sheets.Sheet instance	Indicates the current sheet.
context.row	number	The row index.
context.col	number	The column index.
context.sheetArea	GC.Spread.Sheets.SheetArea	The current sheet area.

Reference

Base type