通过

Excel.StyleCollection class

  • 参考
包:
excel

表示所有样式的集合。

扩展
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.7 ]

属性

context

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

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

方法

add(name)

向集合添加新样式。
getCount()

获取集合中的样式数量。
getItem(name)

Style按名称获取 。
getItemAt(index)

根据其在集合中的位置获取样式。
getItemOrNullObject(name)

按名称获取样式。 如果样式对象不存在，则此方法返回一个对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)

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

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

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

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

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

items

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

readonly items: Excel.Style[];

属性值

Excel.Style[]

方法详细信息

add(name)

向集合添加新样式。

add(name: string): void;

参数

name

string

要添加的样式的名称。

返回

void

注解

[ API 集：ExcelApi 1.7 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let styles = context.workbook.styles;

    // Add a new style to the style collection.
    // Styles is in the Home tab ribbon.
    styles.add("Diagonal Orientation Style");
          
    let newStyle = styles.getItem("Diagonal Orientation Style");
    
    // The "Diagonal Orientation Style" properties.
    newStyle.textOrientation = 38;
    newStyle.autoIndent = true;
    newStyle.includeProtection = true;
    newStyle.shrinkToFit = true;
    newStyle.locked = false;
    
    await context.sync();

    console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});

getCount()

获取集合中的样式数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

[ API 集：ExcelApi 1.9 ]

getItem(name)

Style按名称获取 。

getItem(name: string): Excel.Style;

参数

name

string

要检索的样式的名称。

返回

Excel.Style

注解

[ API 集：ExcelApi 1.7 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let styles = context.workbook.styles;

    // Add a new style to the style collection.
    // Styles is in the Home tab ribbon.
    styles.add("Diagonal Orientation Style");
          
    let newStyle = styles.getItem("Diagonal Orientation Style");
    
    // The "Diagonal Orientation Style" properties.
    newStyle.textOrientation = 38;
    newStyle.autoIndent = true;
    newStyle.includeProtection = true;
    newStyle.shrinkToFit = true;
    newStyle.locked = false;
    
    await context.sync();

    console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});

getItemAt(index)

根据其在集合中的位置获取样式。

getItemAt(index: number): Excel.Style;

参数

index

number

要检索的样式对象的索引值。 从零开始编制索引。

返回

Excel.Style

注解

[ API 集：ExcelApi 1.9 ]

getItemOrNullObject(name)

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

getItemOrNullObject(name: string): Excel.Style;

参数

name

string

要检索的样式的名称。

返回

Excel.Style

注解

[ API 集：ExcelApi 1.14 ]

load(options)

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

load(options?: Excel.Interfaces.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection;

参数

options

Excel.Interfaces.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.StyleCollection

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.StyleCollection

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

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

返回

Excel.StyleCollection

toJSON()

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

toJSON(): Excel.Interfaces.StyleCollectionData;

返回

Excel.Interfaces.StyleCollectionData