Excel.DatetimeFormatInfo 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.12 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
dateSeparator	Gets the string used as the date separator. This is based on current system settings.
longDatePattern	Gets the format string for a long date value. This is based on current system settings.
longTimePattern	Gets the format string for a long time value. This is based on current system settings.
shortDatePattern	Gets the format string for a short date value. This is based on current system settings.
shortDateTimePattern	Gets the format string for a short date and time value. This is based on current system settings.
timeSeparator	Gets the string used as the time separator. 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 is passed to it.) Whereas the original Excel.DatetimeFormatInfo object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DatetimeFormatInfoData) 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

dateSeparator

Gets the string used as the date separator. This is based on current system settings.

readonly dateSeparator: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.12 ]

longDatePattern

Gets the format string for a long date value. This is based on current system settings.

readonly longDatePattern: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.12 ]

longTimePattern

Gets the format string for a long time value. This is based on current system settings.

readonly longTimePattern: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.12 ]

shortDatePattern

Gets the format string for a short date value. This is based on current system settings.

readonly shortDatePattern: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.12 ]

shortDateTimePattern

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the format string for a short date and time value. This is based on current system settings.

readonly shortDateTimePattern: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

timeSeparator

Gets the string used as the time separator. This is based on current system settings.

readonly timeSeparator: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.12 ]

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.DatetimeFormatInfoLoadOptions): Excel.DatetimeFormatInfo;

Parameters

options

Excel.Interfaces.DatetimeFormatInfoLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.DatetimeFormatInfo

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.DatetimeFormatInfo;

Parameters

propertyNames

string | string[]

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

Returns

Excel.DatetimeFormatInfo

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.DatetimeFormatInfo;

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.DatetimeFormatInfo

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 is passed to it.) Whereas the original Excel.DatetimeFormatInfo object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DatetimeFormatInfoData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.DatetimeFormatInfoData;

Returns

Excel.Interfaces.DatetimeFormatInfoData