Word.TableOfAuthoritiesAddOptions interface
指定用于添加到 Word 的选项。TableOfAuthoritiesCollection 对象。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-authorities.yaml
// Adds a table of authorities at the start of the document.
await Word.run(async (context) => {
const documentBody: Word.Body = context.document.body;
const tablesOfAuthorities: Word.TableOfAuthoritiesCollection = context.document.tablesOfAuthorities;
const insertionRange: Word.Range = documentBody.getRange(Word.RangeLocation.start);
const tableOptions: Word.TableOfAuthoritiesAddOptions = {
category: 1,
entrySeparator: " ",
includeCategoryHeader: true,
keepEntryFormatting: true,
};
const tableOfAuthorities: Word.TableOfAuthorities = tablesOfAuthorities.add(insertionRange, tableOptions);
await context.sync();
console.log("Created a table of authorities.");
});
属性
| bookmark | 如果提供，则指定要从中收集授权表条目的书签的字符串名称。 指定后，仅从文档中由书签标记的部分收集条目。 对应于 |
| category | 如果提供，则指定要包含在颁发机构表中的条目的类别。 对应于 |
| entry |
如果提供，则指定最多五个字符的分隔符。 它显示在机构条目表及其页码之间。 对应于 |
| include |
如果提供，则指定每组条目的类别名称是否显示在颁发机构表中， (例如，“案例”) 。 对应于 |
| keep |
如果提供，则指定机构表中的条目是否以其格式显示在表中。 对应于 |
| page |
如果提供，则指定最多五个字符的分隔符。 这显示在权威机构表中的各个页面引用之间。 对应于 |
| page |
如果提供，则指定最多五个字符的分隔符。 这显示在颁发机构表的页面范围之间。 对应于 |
| sequence |
如果提供，则指定标识授权表的序列 (序列) 字段标识符的字符串。 对应于 |
| sequence |
如果提供，则指定最多五个字符的分隔符。 它显示在颁发机构表的序列号和页码之间。 对应于 |
| use |
如果提供，则指定是否将五个或更多页面上重复的对同一颁发机构的引用替换为“Passim”。 对应于 |
属性详细信息
bookmark
如果提供，则指定要从中收集授权表条目的书签的字符串名称。 指定后，仅从文档中由书签标记的部分收集条目。 对应于\b机构表 (TOA) 字段的开关。
bookmark?: string;属性值
string
注解
category
如果提供，则指定要包含在颁发机构表中的条目的类别。 对应于\c机构表 (TOA) 字段的开关。 值 0 到 16 对应于“机构表”对话框的“类别”框中列出的项目。 若要了解如何通过 Word UI 访问此功能，请参阅创建颁发机构表。 默认值为 1。
category?: number;属性值
number
注解
entrySeparator
如果提供，则指定最多五个字符的分隔符。 它显示在机构条目表及其页码之间。 对应于\e机构表 (TOA) 字段的开关。 如果省略，则不使用分隔符。
entrySeparator?: string;属性值
string
注解
includeCategoryHeader
如果提供，则指定每组条目的类别名称是否显示在颁发机构表中， (例如，“案例”) 。 对应于\h机构表 (TOA) 字段的开关。 默认值为 true。
includeCategoryHeader?: boolean;属性值
boolean
注解
keepEntryFormatting
如果提供，则指定机构表中的条目是否以其格式显示在表中。 对应于\f机构表 (TOA) 字段的开关。 默认值为 true。
keepEntryFormatting?: boolean;属性值
boolean
注解
pageNumberSeparator
如果提供，则指定最多五个字符的分隔符。 这显示在权威机构表中的各个页面引用之间。 对应于\l机构表 (TOA) 字段的开关。 如果省略，则使用逗号和空格 (“， ”) 。
pageNumberSeparator?: string;属性值
string
注解
pageRangeSeparator
如果提供，则指定最多五个字符的分隔符。 这显示在颁发机构表的页面范围之间。 对应于\g机构表 (TOA) 字段的开关。 如果省略，将使用短划线 (“–”) 。
pageRangeSeparator?: string;属性值
string
注解
sequenceName
sequenceSeparator
如果提供，则指定最多五个字符的分隔符。 它显示在颁发机构表的序列号和页码之间。 对应于\d机构表 (TOA) 字段的开关。 如果省略，则使用连字符 (“-”) 。
sequenceSeparator?: string;属性值
string
注解
usePassim
如果提供，则指定是否将五个或更多页面上重复的对同一颁发机构的引用替换为“Passim”。 对应于\p机构表 (TOA) 字段的开关。 默认值为 false。
usePassim?: boolean;属性值
boolean