Excel.TimelineStyleCollection class

备注

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

表示 TimelineStyles 的集合。Represents a collection of TimelineStyles.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

Extends

属性

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

items

获取此集合中已加载的子项。Gets the loaded child items in this collection.

方法

add(name, makeUniqueName)

使用指定名称创建空白 TimelineStyle。Creates a blank TimelineStyle with the specified name.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getCount()

获取集合中日程表样式的数量。Gets the number of timeline styles in the collection.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getDefault()

获取父对象范围的默认 TimelineStyle。Gets the default TimelineStyle for the parent object's scope.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(name)

按名称获取 TimelineStyle。Gets a TimelineStyle by name.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(name)

按名称获取 TimelineStyle。Gets a TimelineStyle by name. 如果没有 TimelineStyle,将返回 null 对象。If the TimelineStyle does not exist, will return a null object.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(option)
setDefault(newDefaultStyle)

设置在父对象范围内使用的默认 TimelineStyle。Sets the default TimelineStyle for use in the parent object's scope.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始Excel.TimelineStyleCollection对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.TimelineStyleCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TimelineStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TimelineStyleCollectionData), 其中包含集合的项中所有加载属性的浅表副本的 "items" 数组。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

属性详细信息

context

备注

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

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

context: RequestContext;

属性值

RequestContext

items

备注

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

获取此集合中已加载的子项。Gets the loaded child items in this collection.

readonly items: Excel.TimelineStyle[];

属性值

Excel.TimelineStyle[]

方法详细信息

add(name, makeUniqueName)

备注

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

使用指定名称创建空白 TimelineStyle。Creates a blank TimelineStyle with the specified name.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;

参数

name
string

新 TimelineStyle 的唯一名称。The unique name for the new TimelineStyle. 如果名称已在使用中, 则将引发无效参数异常。Will throw an invalid argument exception if the name is already in use.

makeUniqueName
boolean

可选, 默认值为 false。Optional, defaults to false. 如果为 true, 则将数字追加到名称, 以便根据需要使其唯一。If true, will append numbers to the name in order to make it unique, if needed.

返回

新创建的 TimelineStyle。The newly created TimelineStyle.

getCount()

备注

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

获取集合中日程表样式的数量。Gets the number of timeline styles in the collection.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

getDefault()

备注

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

获取父对象范围的默认 TimelineStyle。Gets the default TimelineStyle for the parent object's scope.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getDefault(): Excel.TimelineStyle;

返回

作为当前默认 TimelineStyle 的 TimelineStyle 对象。The TimelineStyle object that is the current default TimelineStyle.

getItem(name)

备注

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

按名称获取 TimelineStyle。Gets a TimelineStyle by name.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(name: string): Excel.TimelineStyle;

参数

name
string

要检索的 TimelineStyle 的名称。Name of the TimelineStyle to be retrieved.

返回

其名称与输入匹配的 TimelineStyle 对象。The TimelineStyle object whose name matches the input.

getItemOrNullObject(name)

备注

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

按名称获取 TimelineStyle。Gets a TimelineStyle by name. 如果没有 TimelineStyle,将返回 null 对象。If the TimelineStyle does not exist, will return a null object.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(name: string): Excel.TimelineStyle;

参数

name
string

要检索的 TimelineStyle 的名称。Name of the TimelineStyle to be retrieved.

返回

其名称与输入匹配的 TimelineStyle 对象。The TimelineStyle object whose name matches the input.

load(option)

备注

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

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;

参数

option
Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

返回

注解

除了此签名之外, 此方法还具有以下签名:In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.TimelineStyleCollection-Where 选项是一个逗号分隔的字符串或一个字符串数组, 用于指定要加载的属性。load(option?: string | string[]): Excel.TimelineStyleCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.TimelineStyleCollection-Where 选项。选择是一个用逗号分隔的字符串, 用于指定要加载的属性和选项。 expand 是一个用逗号分隔的字符串, 用于指定要加载的导航属性。load(option?: { select?: string; expand?: string; }): Excel.TimelineStyleCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TimelineStyleCollection-仅适用于集合类型。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TimelineStyleCollection - Only available on collection types. 它类似于前面的签名。It is similar to the preceding signature. top 指定结果中可包含的集合项的最大数量。Option.top specifies the maximum number of collection items that can be included in the result. 选项。 skip 指定要跳过且不包含在结果中的项目数。Option.skip specifies the number of items that are to be skipped and not included in the result. 如果指定了 top 选项, 则在跳过指定数目的项目后将启动结果集。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

备注

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

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

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

参数

propertyNames
string | string[]

一个以逗号分隔的字符串或字符串数组, 用于指定要加载的属性。A comma-delimited string or an array of strings that specify the properties to load.

返回

load(option)

备注

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

load(option?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection;

参数

返回

setDefault(newDefaultStyle)

备注

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

设置在父对象范围内使用的默认 TimelineStyle。Sets the default TimelineStyle for use in the parent object's scope.

[API 集: ExcelApi BETA (仅限预览)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

setDefault(newDefaultStyle: TimelineStyle | string): void;

参数

newDefaultStyle
TimelineStyle | string

应为新的默认值的 TimelineStyle 对象的 TimelineStyle 对象或名称。The TimelineStyle object or name of the TimelineStyle object that should be the new default.

返回

void

toJSON()

备注

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

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始Excel.TimelineStyleCollection对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.TimelineStyleCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TimelineStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TimelineStyleCollectionData), 其中包含集合的项中所有加载属性的浅表副本的 "items" 数组。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.TimelineStyleCollectionData;

返回