Excel.TimelineStyle class

包:

excel

表示一个 TimelineStyle，该时间线中按区域定义样式元素。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.10 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
name	指定时间线样式的名称。
readOnly	指定此 TimelineStyle 对象是否为只读。

方法

delete()	删除表格样式。
duplicate()	使用所有样式元素的副本创建此时间线样式的副本。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.TimelineStyle对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TimelineStyleData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

name

指定时间线样式的名称。

name: string;

属性值

string

注解

[ API 集：ExcelApi 1.10 ]

readOnly

指定此 TimelineStyle 对象是否为只读。

readonly readOnly: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.10 ]

方法详细信息

delete()

删除表格样式。

delete(): void;

返回

void

注解

[ API 集：ExcelApi 1.10 ]

duplicate()

使用所有样式元素的副本创建此时间线样式的副本。

duplicate(): Excel.TimelineStyle;

返回

Excel.TimelineStyle

从此时间线样式复制的新TimelineStyle对象。

注解

[ API 集：ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.TimelineStyleLoadOptions): Excel.TimelineStyle;

参数

options

Excel.Interfaces.TimelineStyleLoadOptions

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

返回

Excel.TimelineStyle

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.TimelineStyle

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.TimelineStyle

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.TimelineStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties

Excel.Interfaces.TimelineStyleUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.TimelineStyle): void;

参数

properties

Excel.TimelineStyle

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.TimelineStyleData;

返回

Excel.Interfaces.TimelineStyleData