Word.TableStyle class

包:

word

表示 TableStyle 对象。

Extends

OfficeExtension.ClientObject

注解

[ API 集：WordApi 1.6 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-custom-style.yaml

// Gets the table style properties and displays them in the form.
const styleName = $("#style-name")
  .val()
  .toString();
if (styleName == "") {
  console.warn("Please input a table style name.");
  return;
}

await Word.run(async (context) => {
  const tableStyle = context.document.getStyles().getByName(styleName).tableStyle;
  tableStyle.load();
  await context.sync();

  if (tableStyle.isNullObject) {
    console.warn(`There's no existing table style with the name '${styleName}'.`);
    return;
  }

  console.log(tableStyle);
  $("#alignment").val(tableStyle.alignment);
  $("#allow-break-across-page").val(tableStyle.allowBreakAcrossPage.toString());
  $("#top-cell-margin").val(tableStyle.topCellMargin);
  $("#bottom-cell-margin").val(tableStyle.bottomCellMargin);
  $("#left-cell-margin").val(tableStyle.leftCellMargin);
  $("#right-cell-margin").val(tableStyle.rightCellMargin);
  $("#cell-spacing").val(tableStyle.cellSpacing);
});

属性

alignment	指定表与页边距的对齐方式。
allowBreakAcrossPage	指定用指定样式设置格式的表中的行是否跨页分隔。
bottomCellMargin	指定要在内容和单元格底部边框之间添加的空间量。
cellSpacing	指定表格样式中单元格之间的间距 () 磅。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
leftCellMargin	指定要在内容和单元格的左边框之间添加的空间量。
rightCellMargin	指定要在内容和单元格的右边框之间添加的空间量。
topCellMargin	指定要在内容和单元格上边框之间添加的空间量。

方法

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传递给它的 对象的 方法。) 而原始Word。TableStyle 对象是一个 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.TableStyleData) ，其中包含原始对象中任何已加载子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

属性详细信息

alignment

注意

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

指定表与页边距的对齐方式。

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

属性值

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

注解

[ API 集：WordApi BETA (仅预览版) ]

allowBreakAcrossPage

注意

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

指定用指定样式设置格式的表中的行是否跨页分隔。

allowBreakAcrossPage: boolean;

属性值

boolean

注解

[ API 集：WordApi BETA (仅预览版) ]

bottomCellMargin

指定要在内容和单元格底部边框之间添加的空间量。

bottomCellMargin: number;

属性值

number

注解

[ API 集：WordApi 1.6 ]

cellSpacing

指定表格样式中单元格之间的间距 () 磅。

cellSpacing: number;

属性值

number

注解

[ API 集：WordApi 1.6 ]

context

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

context: RequestContext;

属性值

Word.RequestContext

leftCellMargin

指定要在内容和单元格的左边框之间添加的空间量。

leftCellMargin: number;

属性值

number

注解

[ API 集：WordApi 1.6 ]

rightCellMargin

指定要在内容和单元格的右边框之间添加的空间量。

rightCellMargin: number;

属性值

number

注解

[ API 集：WordApi 1.6 ]

topCellMargin

指定要在内容和单元格上边框之间添加的空间量。

topCellMargin: number;

属性值

number

注解

[ API 集：WordApi 1.6 ]

方法详细信息

load(options)

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

load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;

参数

options

Word.Interfaces.TableStyleLoadOptions

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

返回

Word.TableStyle

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.TableStyle;

参数

propertyNames

string | string[]

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

返回

Word.TableStyle

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableStyle;

参数

propertyNamesAndPaths

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

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

返回

Word.TableStyle

set(properties, options)

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

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

参数

properties

Word.Interfaces.TableStyleUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Word.TableStyle): void;

参数

properties

Word.TableStyle

返回

void

toJSON()

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

toJSON(): Word.Interfaces.TableStyleData;

返回

Word.Interfaces.TableStyleData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.TableStyle;

返回

Word.TableStyle

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.TableStyle;

返回

Word.TableStyle