Excel.DatetimeFormatInfo class

定义显示数字在区域性上合适的格式。 这基于当前的系统区域性设置。

扩展

注解

[ API 集:ExcelApi 1.12 ]

属性

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

dateSeparator

获取用作日期分隔符的字符串。 这基于当前的系统设置。

longDatePattern

获取长日期值的格式字符串。 这基于当前的系统设置。

longTimePattern

获取长时间值的格式字符串。 这基于当前的系统设置。

shortDatePattern

获取短日期值的格式字符串。 这基于当前的系统设置。

shortDateTimePattern

获取短日期和时间值的格式字符串。 这基于当前的系统设置。

timeSeparator

获取用作时间分隔符的字符串。 这基于当前的系统设置。

方法

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.DatetimeFormatInfo对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.DatetimeFormatInfoData) ,其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

dateSeparator

获取用作日期分隔符的字符串。 这基于当前的系统设置。

readonly dateSeparator: string;

属性值

string

注解

[ API 集:ExcelApi 1.12 ]

longDatePattern

获取长日期值的格式字符串。 这基于当前的系统设置。

readonly longDatePattern: string;

属性值

string

注解

[ API 集:ExcelApi 1.12 ]

longTimePattern

获取长时间值的格式字符串。 这基于当前的系统设置。

readonly longTimePattern: string;

属性值

string

注解

[ API 集:ExcelApi 1.12 ]

shortDatePattern

获取短日期值的格式字符串。 这基于当前的系统设置。

readonly shortDatePattern: string;

属性值

string

注解

[ API 集:ExcelApi 1.12 ]

shortDateTimePattern

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取短日期和时间值的格式字符串。 这基于当前的系统设置。

readonly shortDateTimePattern: string;

属性值

string

注解

[ API 集:ExcelApi BETA (仅预览版) ]

timeSeparator

获取用作时间分隔符的字符串。 这基于当前的系统设置。

readonly timeSeparator: string;

属性值

string

注解

[ API 集:ExcelApi 1.12 ]

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(options?: Excel.Interfaces.DatetimeFormatInfoLoadOptions): Excel.DatetimeFormatInfo;

参数

options
Excel.Interfaces.DatetimeFormatInfoLoadOptions

提供要加载对象的属性的选项。

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.DatetimeFormatInfo对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.DatetimeFormatInfoData) ,其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.DatetimeFormatInfoData;

返回