FieldIndex

概述

FieldIndex 是 Aspose.Words FOSS 中用于 .NET 的一个类。继承自：Field，IFieldCodeTokenInfoProvider。

实现 INDEX 字段。

此类提供 4 个方法，用于在 .NET 程序中处理 FieldIndex 对象。可用方法包括：GetFieldCode、Remove、Unlink、Update。在安装了 Aspose.Words FOSS for .NET 包后，所有公共成员对任何 .NET 应用程序均可访问。属性：BookmarkName、CrossReferenceSeparator、DisplayResult、End、EntryType、Format，以及另外 20 项。

属性

名称	类型	访问	描述
`BookmarkName`	`string`	读写	获取或设置标记用于构建索引的文档部分的书签名称。
`NumberOfColumns`	`string`	读写	获取或设置构建索引时每页使用的列数。
`SequenceSeparator`	`string`	读写	获取或设置用于分隔序列号和页码的字符序列。
`PageNumberSeparator`	`string`	读写	获取或设置用于分隔索引条目及其页码的字符序列。
`HasPageNumberSeparator`	`bool`	读取	获取一个值，指示是否通过字段代码覆盖了页码分隔符。
`EntryType`	`string`	读写	获取或设置用于构建索引的索引条目类型。
`PageRangeSeparator`	`string`	读写	获取或设置用于分隔页码范围的起始和结束的字符序列。
`Heading`	`string`	读写	获取或设置在每个特定字母的条目集合开头出现的标题。
`CrossReferenceSeparator`	`string`	读写	获取或设置用于分隔交叉引用和其他条目的字符序列。
`PageNumberListSeparator`	`string`	读写	获取或设置用于在页码列表中分隔两个页码的字符序列。
`LetterRange`	`string`	读写	获取或设置一个用于限制索引的字母范围。
`RunSubentriesOnSameLine`	`bool`	读写	获取或设置是否将子条目与主条目放在同一行。
`SequenceName`	`string`	读写	获取或设置一个序列的名称，该序列的编号会随页码一起包含。
`HasSequenceName`	`bool`	读取	获取一个值，指示在字段结果生成期间是否应使用序列。
`UseYomi`	`bool`	读写	获取或设置是否启用对索引条目使用 yomi 文本。
`LanguageId`	`string`	读写	获取或设置用于生成索引的语言 ID。
`Start`	`FieldStart`	读取	获取表示字段开始的节点。
`Separator`	`FieldSeparator`	读取	获取表示字段分隔符的节点。
`End`	`FieldEnd`	读取	获取表示字段结束的节点。
`Type`	`FieldType`	读取	获取 Microsoft Word 字段类型。
`Result`	`string`	读写	获取或设置位于字段分隔符和字段结束之间的文本。
`DisplayResult`	`string`	读取	获取表示显示字段结果的文本。
`IsLocked`	`bool`	读写	获取或设置字段是否被锁定（不应重新计算其结果）。
`IsDirty`	`bool`	读写	获取或设置字段的当前结果是否因文档的其他修改而不再正确（已过时）。
`Format`	`FieldFormat`	读取	获取一个 FieldFormat 对象，提供对字段格式的类型化访问。
`LocaleId`	`int`	读写	获取或设置字段的 LCID。

方法

签名	描述
`GetFieldCode()`	返回字段起始位置和字段分隔符之间的文本（如果没有分隔符，则返回字段结束位置之间的文本）。
`Remove()`	从文档中移除该字段。
`Update()`	执行字段更新。
`Unlink()`	执行字段取消链接。

另请参阅

Aspose.Words for .NET — Enterprise API Reference