Word.ListFormat class
表示某个区域的列表格式特征。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Gets the range covering the entire body and reads list formatting properties.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
listFormat.load("isSingleList, listType, listLevelNumber, listString, listValue");
await context.sync();
console.log("List format info for the body range:");
console.log(`- Is single list: ${listFormat.isSingleList}`);
console.log(`- List type: ${listFormat.listType}`);
console.log(`- List level number (first paragraph): ${listFormat.listLevelNumber}`);
console.log(`- List string (first paragraph): "${listFormat.listString}"`);
console.log(`- List value (first paragraph): ${listFormat.listValue}`);
});
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| is |
指示对象是否 |
| is |
指示对象是否 |
| list | 返回 |
| list |
指定对象第一段 |
| list |
获取对象范围内 |
| list |
获取与 |
| list |
获取对象的 |
| list |
获取对象范围内 |
方法
| apply |
向区域内的段落添加项目符号和格式。 |
| apply |
向区域内的段落添加项目符号和格式。 |
| apply |
将具有特定级别的列表模板应用于区域中的段落。 |
| apply |
为区域中的段落添加编号和格式。 |
| apply |
为区域中的段落添加编号和格式。 |
| apply |
向区域中的段落添加大纲编号和格式。 |
| apply |
向区域中的段落添加大纲编号和格式。 |
| can |
确定对象是否 |
| convert |
将列表中的数字转换为纯文本。 |
| convert |
将列表中的数字转换为纯文本。 |
| count |
对列表中编号项进行计数。 |
| list |
将列表缩进一级。 |
| list |
将列表减少一级。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| remove |
从列表中删除编号。 |
| remove |
从列表中删除编号。 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
context
isSingleList
isSingleListTemplate
指示对象是否 ListFormat 包含单个列表模板。
readonly isSingleListTemplate: boolean;属性值
boolean
注解
list
返回 List 表示对象中包含的 ListFormat 第一个格式化列表的对象。
readonly list: Word.List;属性值
注解
listLevelNumber
listString
获取对象范围内 ListFormat 第一段的列表值的字符串表示形式。
readonly listString: string;属性值
string
注解
listTemplate
获取与 ListFormat 对象关联的列表模板。
readonly listTemplate: Word.ListTemplate;属性值
注解
listType
获取对象的 ListFormat 列表类型。
readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";属性值
Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"
注解
listValue
方法详细信息
applyBulletDefault(defaultListBehavior)
向区域内的段落添加项目符号和格式。
applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;参数
- defaultListBehavior
- Word.DefaultListBehavior
可选。 指定默认列表行为。 默认值为 word97。
返回
void
注解
applyBulletDefault(defaultListBehavior)
向区域内的段落添加项目符号和格式。
applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;参数
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
可选。 指定默认列表行为。 默认值为 word97。
返回
void
注解
applyListTemplateWithLevel(listTemplate, options)
将具有特定级别的列表模板应用于区域中的段落。
applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;参数
- listTemplate
- Word.ListTemplate
要应用的列表模板。
- options
- Word.ListTemplateApplyOptions
可选。 应用列表模板的选项，例如是否继续上一个列表或将模板应用到列表的哪个部分。
返回
void
注解
applyNumberDefault(defaultListBehavior)
为区域中的段落添加编号和格式。
applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;参数
- defaultListBehavior
- Word.DefaultListBehavior
可选。 指定默认列表行为。
返回
void
注解
applyNumberDefault(defaultListBehavior)
为区域中的段落添加编号和格式。
applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;参数
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
可选。 指定默认列表行为。
返回
void
注解
applyOutlineNumberDefault(defaultListBehavior)
向区域中的段落添加大纲编号和格式。
applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;参数
- defaultListBehavior
- Word.DefaultListBehavior
可选。 指定默认列表行为。
返回
void
注解
applyOutlineNumberDefault(defaultListBehavior)
向区域中的段落添加大纲编号和格式。
applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;参数
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
可选。 指定默认列表行为。
返回
void
注解
canContinuePreviousList(listTemplate)
确定对象是否 ListFormat 可以继续上一个列表。
canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;参数
- listTemplate
- Word.ListTemplate
要检查的列表模板。
返回
Continue指示是否可以继续的值。
注解
convertNumbersToText(numberType)
将列表中的数字转换为纯文本。
convertNumbersToText(numberType: Word.NumberType): void;参数
- numberType
- Word.NumberType
可选。 要转换的数字类型。
返回
void
注解
convertNumbersToText(numberType)
将列表中的数字转换为纯文本。
convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;参数
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
可选。 要转换的数字类型。
返回
void
注解
countNumberedItems(options)
对列表中编号项进行计数。
countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;参数
可选。 用于计数编号项的选项，例如编号类型和要计数的级别。
返回
OfficeExtension.ClientResult<number>
项目数量。
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Counts all numbered items across every level using numberType: AllNumbers.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
const options: Word.ListFormatCountNumberedItemsOptions = {
numberType: Word.NumberType.allNumbers,
};
const count: OfficeExtension.ClientResult<number> = listFormat.countNumberedItems(options);
await context.sync();
console.log(`Total numbered items (all levels): ${count.value}`);
});
listIndent()
listOutdent()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.ListFormat;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ListFormat;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
removeNumbers(numberType)
从列表中删除编号。
removeNumbers(numberType: Word.NumberType): void;参数
- numberType
- Word.NumberType
可选。 要删除的数字的类型。
返回
void
注解
removeNumbers(numberType)
从列表中删除编号。
removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;参数
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
可选。 要删除的数字的类型。
返回
void
注解
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.ListFormatUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Word.ListFormat): void;参数
- properties
- Word.ListFormat
返回
void
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.ListFormat 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.ListFormatData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.ListFormatData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.ListFormat;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.ListFormat;