FieldTC
内容
[
隐藏
]
FieldTC class
实现 TC 字段。
public sealed class FieldTC : Field
构造函数
姓名 | 描述 |
---|---|
FieldTC() | 默认构造函数。 |
特性
姓名 | 描述 |
---|---|
DisplayResult { get; } | 获取表示显示字段结果的文本。 |
End { get; } | 获取代表字段end的节点。 |
EntryLevel { get; set; } | 获取或设置条目的级别。 |
Format { get; } | 得到一个FieldFormat 提供对字段格式的类型化访问的对象。 |
IsDirty { get; set; } | 获取或设置字段的当前结果是否由于对文档的其他修改而不再正确(陈旧)。 |
IsLocked { get; set; } | 获取或设置字段是否被锁定(不应重新计算其结果)。 |
LocaleId { get; set; } | 获取或设置字段的LCID。 |
OmitPageNumber { get; set; } | 获取或设置此字段是否应省略 TOC 中的页码。 |
Result { get; set; } | 获取或设置字段分隔符和字段结尾之间的文本。 |
Separator { get; } | 获取表示字段分隔符的节点。可以为空。 |
Start { get; } | 获取表示字段开始的节点。 |
Text { get; set; } | 获取或设置条目的文本。 |
virtual Type { get; } | 获取 Microsoft Word 字段类型。 |
TypeIdentifier { get; set; } | 获取或设置该字段的类型标识符(通常是字母)。 |
方法
姓名 | 描述 |
---|---|
GetFieldCode() | 返回字段开始和字段分隔符之间的文本(或字段结束,如果没有分隔符)。 包括子字段的字段代码和字段结果。 |
GetFieldCode(bool) | 返回字段开始和字段分隔符之间的文本(如果没有分隔符,则返回字段结束)。 |
Remove() | 从文档中删除字段。在字段之后返回一个节点。如果字段的结尾是其父节点的最后一个 child ,则返回其父段落。如果该字段已被删除,则返回 无效的. |
Unlink() | 执行字段取消链接。 |
Update() | 执行字段更新。如果该字段已被更新,则抛出。 |
Update(bool) | 执行字段更新。如果该字段已被更新,则抛出。 |
评论
定义目录(包括图表)条目的文本和页码, 由 TOC 字段使用。
例子
展示如何插入一个 TOC 字段,并过滤哪些 TC 字段最终成为条目。
{
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// 插入一个 TOC 字段,这会将所有 TC 字段编译成一个目录。
FieldToc fieldToc = (FieldToc)builder.InsertField(FieldType.FieldTOC, true);
// 配置该字段只获取“A”类型的TC条目,以及1到3之间的条目级别。
fieldToc.EntryIdentifier = "A";
fieldToc.EntryLevelRange = "1-3";
Assert.AreEqual(" TOC \\f A \\l 1-3", fieldToc.GetFieldCode());
// 这两个条目将出现在表格中。
builder.InsertBreak(BreakType.PageBreak);
InsertTocEntry(builder, "TC field 1", "A", "1");
InsertTocEntry(builder, "TC field 2", "A", "2");
Assert.AreEqual(" TC \"TC field 1\" \\n \\f A \\l 1", doc.Range.Fields[1].GetFieldCode());
// 此条目将从表中省略,因为它的类型与“A”不同。
InsertTocEntry(builder, "TC field 3", "B", "1");
// 此条目将从表中省略,因为它具有 1-3 范围之外的条目级别。
InsertTocEntry(builder, "TC field 4", "A", "5");
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.TC.docx");
/// <summary>
/// 使用文档构建器插入 TC 字段。
/// </summary>
public void InsertTocEntry(DocumentBuilder builder, string text, string typeIdentifier, string entryLevel)
{
FieldTC fieldTc = (FieldTC)builder.InsertField(FieldType.FieldTOCEntry, true);
fieldTc.OmitPageNumber = true;
fieldTc.Text = text;
fieldTc.TypeIdentifier = typeIdentifier;
fieldTc.EntryLevel = entryLevel;
}
也可以看看
- class Field
- 命名空间 Aspose.Words.Fields
- 部件 Aspose.Words