Excel.TimelineStyleCollection class

包:

excel

表示时间线样式的集合。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.10

使用方

• Excel.Workbook： timelineStyles

属性

context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

add(name, makeUniqueName)	创建具有指定名称的空白。TimelineStyle
getCount()	获取集合中日程表样式的数量。
getDefault()	获取父对象作用域的默认时间线样式。
getItem(name)	按名称获取 TimelineStyle 。
getItemOrNullObject(name)	按名称获取 TimelineStyle 。 如果时间线样式不存在，则此方法将返回其isNullObject属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
setDefault(newDefaultStyle)	设置要在父对象作用域中使用的默认时间线样式。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.TimelineStyleCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TimelineStyleCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

items

获取此集合中已加载的子项。

readonly items: Excel.TimelineStyle[];

属性值

Excel.TimelineStyle[]

方法详细信息

add(name, makeUniqueName)

创建具有指定名称的空白。TimelineStyle

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

参数

name

string

新时间线样式的唯一名称。 如果该名称已在使用中，将引发 InvalidArgument 错误。

makeUniqueName

boolean

可选。 默认为 false. 如果 true，将在需要时将数字附加到名称中，以使其唯一。

返回

Excel.TimelineStyle

新创建 TimelineStyle的 .

注解

API 集：ExcelApi 1.10

getCount()

获取集合中日程表样式的数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

API 集：ExcelApi 1.10

getDefault()

获取父对象作用域的默认时间线样式。

getDefault(): Excel.TimelineStyle;

返回

Excel.TimelineStyle

TimelineStyle当前默认时间线样式的对象。

注解

API 集：ExcelApi 1.10

getItem(name)

按名称获取 TimelineStyle 。

getItem(name: string): Excel.TimelineStyle;

参数

name

string

要检索的时间线样式的名称。

返回

Excel.TimelineStyle

TimelineStyle名称与输入匹配的对象。

注解

API 集：ExcelApi 1.10

getItemOrNullObject(name)

按名称获取 TimelineStyle 。 如果时间线样式不存在，则此方法将返回其isNullObject属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(name: string): Excel.TimelineStyle;

参数

name

string

要检索的时间线样式的名称。

返回

Excel.TimelineStyle

TimelineStyle名称与输入匹配的对象。

注解

API 集：ExcelApi 1.10

load(options)

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

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

参数

options

Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.TimelineStyleCollection

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.TimelineStyleCollection

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

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

返回

Excel.TimelineStyleCollection

setDefault(newDefaultStyle)

设置要在父对象作用域中使用的默认时间线样式。

setDefault(newDefaultStyle: TimelineStyle | string): void;

参数

newDefaultStyle

Excel.TimelineStyle | string

TimelineStyle应为新的默认值的对象或对象名称TimelineStyle。

返回

void

注解

API 集：ExcelApi 1.10

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.TimelineStyleCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TimelineStyleCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

toJSON(): Excel.Interfaces.TimelineStyleCollectionData;

返回

Excel.Interfaces.TimelineStyleCollectionData