Word.ListFormat class

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

context: RequestContext;

属性值

指示对象是否 ListFormat 包含单个列表。

readonly isSingleList: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指示对象是否 ListFormat 包含单个列表模板。

readonly isSingleListTemplate: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 List 对象，该对象表示对象中包含的 ListFormat 第一个格式化列表。

readonly list: Word.List;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定对象的第一个段落 ListFormat 的列表级别编号。

listLevelNumber: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取对象区域中 ListFormat 第一个段落的列表值的字符串表示形式。

readonly listString: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取与 对象关联的 ListFormat 列表模板。

readonly listTemplate: Word.ListTemplate;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取 对象的列表 ListFormat 类型。

readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取对象范围中第一段的 ListFormat 数值。

readonly listValue: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

向区域中的段落添加项目符号和格式。

applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

向区域中的段落添加项目符号和格式。

applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将具有特定级别的列表模板应用于区域中的段落。

applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

向区域中的段落添加编号和格式。

applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

向区域中的段落添加编号和格式。

applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

向区域中的段落添加大纲编号和格式。

applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

向区域中的段落添加大纲编号和格式。

applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

确定对象是否可以 ListFormat 继续上一个列表。

canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;

参数

返回

一个 Continue 值，该值指示是否可以继续。

注解

[ API 集：WordApiDesktop 1.3 ]

将列表中的数字转换为纯文本。

convertNumbersToText(numberType: Word.NumberType): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将列表中的数字转换为纯文本。

convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

对列表中的编号项进行计数。

countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

参数

返回

项目数量。

注解

[ API 集：WordApiDesktop 1.3 ]

将列表缩进一个级别。

listIndent(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将列表缩进一个级别。

listOutdent(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat;

参数

返回

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

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

参数

返回

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

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

参数

返回

从列表中删除编号。

removeNumbers(numberType: Word.NumberType): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

从列表中删除编号。

removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

参数

返回

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

set(properties: Word.ListFormat): void;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.ListFormat对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.ListFormatData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.ListFormatData;

返回

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

track(): Word.ListFormat;

返回

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

untrack(): Word.ListFormat;

返回