Class: FormatterBase

Spread.Formatter.FormatterBase

Table of contents

Constructors

• constructor

Properties

• typeName

Methods

• format
• fromJSON
• parse
• toJSON

Constructors

constructor

• new FormatterBase(format, cultureName)

Represents a custom formatter with the specified format string.

Parameters

Properties

typeName

• typeName: string

Represents the type name string used for supporting serialization.

Methods

format

▸ format(obj): string

Formats the specified object as a string with a conditional color. This function should be overwritten.

example

//This example creates a custom formatter.
var customFormatterTest = {};
customFormatterTest.prototype = GC.Spread.Formatter.FormatterBase;
customFormatterTest.format = function (obj, data) {
    data.conditionalForeColor = "blue";
    return "My format result : " + obj.toString();
};
customFormatterTest.parse = function (str) {
    if (!str) {
        return "";
    }
    return str;
}
activeSheet.getCell(1, 0).formatter(customFormatterTest);
activeSheet.getCell(1, 0).value("Test");

Parameters

Returns

string

The formatted string.

fromJSON

▸ fromJSON(settings): void

Loads the object state from the specified JSON string.

Parameters

Returns

void

parse

▸ parse(str): Object

Parses the specified text. This function should be overwritten.

example

//This example creates a custom formatter.
var customFormatterTest = {};
customFormatterTest.prototype = GC.Spread.Formatter.FormatterBase;
customFormatterTest.format = function (obj, conditionalForeColor) {
    conditionalForeColor.value = "blue";
    return "My format result : " + obj.toString();
};
customFormatterTest.parse = function (str) {
    if (!str) {
        return "";
    }
    return str;
}
activeSheet.getCell(1, 0).formatter(customFormatterTest);
activeSheet.getCell(1, 0).value("Test")

Parameters

Returns

Object

The parsed object.

toJSON

▸ toJSON(): Object

Saves the object state to a JSON string.

Returns

Object

The custom formatter data.