Excel.NumberFormatInfo class

Package:

excel

Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.

Extends

OfficeExtension.ClientObject

Remarks

[Api set: ExcelApi 1.11]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
currencySymbol	Gets the currency symbol for currency values. This is based on current system settings.
numberDecimalSeparator	Gets the string used as the decimal separator for numeric values. This is based on current system settings.
numberGroupSeparator	Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.NumberFormatInfo object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NumberFormatInfoData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

currencySymbol

Gets the currency symbol for currency values. This is based on current system settings.

readonly currencySymbol: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.17]

numberDecimalSeparator

Gets the string used as the decimal separator for numeric values. This is based on current system settings.

readonly numberDecimalSeparator: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.11]

numberGroupSeparator

Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings.

readonly numberGroupSeparator: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.11]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.NumberFormatInfoLoadOptions): Excel.NumberFormatInfo;

Parameters

options

Excel.Interfaces.NumberFormatInfoLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.NumberFormatInfo

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.NumberFormatInfo;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.NumberFormatInfo

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NumberFormatInfo;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.NumberFormatInfo

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.NumberFormatInfo object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NumberFormatInfoData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.NumberFormatInfoData;

Returns

Excel.Interfaces.NumberFormatInfoData