Class FieldSectionPages

FieldSectionPages class

实现 SECTIONPAGES 字段。

public class FieldSectionPages : Field

构造函数

姓名描述
FieldSectionPages()默认构造函数。

特性

姓名描述
DisplayResult { get; }获取表示显示字段结果的文本。
End { get; }获取代表字段end的节点。
Format { get; }得到一个FieldFormat提供对字段格式的类型化访问的对象。
IsDirty { get; set; }获取或设置字段的当前结果是否由于对文档的其他修改而不再正确(陈旧)。
IsLocked { get; set; }获取或设置字段是否被锁定(不应重新计算其结果)。
LocaleId { get; set; }获取或设置字段的LCID。
Result { get; set; }获取或设置字段分隔符和字段结尾之间的文本。
Separator { get; }获取表示字段分隔符的节点。可以为空。
Start { get; }获取表示字段开始的节点。
virtual Type { get; }获取 Microsoft Word 字段类型。

方法

姓名描述
GetFieldCode()返回字段开始和字段分隔符之间的文本(或字段结束,如果没有分隔符)。 包括子字段的字段代码和字段结果。
GetFieldCode(bool)返回字段开始和字段分隔符之间的文本(如果没有分隔符,则返回字段结束)。
Remove()从文档中删除字段。在字段之后返回一个节点。如果字段的结尾是其父节点的最后一个 child ,则返回其父段落。如果该字段已被删除,则返回 无效的.
Unlink()执行字段取消链接。
Update()执行字段更新。如果该字段已被更新,则抛出。
Update(bool)执行字段更新。如果该字段已被更新,则抛出。

评论

检索当前节中当前页的编号。

例子

展示如何使用 SECTION 和 SECTIONPAGES 字段按部分对页面进行编号。

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.ParagraphFormat.Alignment = ParagraphAlignment.Right;

// 一个 SECTION 字段显示它所在的部分的编号。
builder.Write("Section ");
FieldSection fieldSection = (FieldSection)builder.InsertField(FieldType.FieldSection, true);

Assert.AreEqual(" SECTION ", fieldSection.GetFieldCode());

// PAGE 字段显示它所在的页码。
builder.Write("\nPage ");
FieldPage fieldPage = (FieldPage)builder.InsertField(FieldType.FieldPage, true);

Assert.AreEqual(" PAGE ", fieldPage.GetFieldCode());

// 一个 SECTIONPAGES 字段显示它所在的部分跨越的页数。
builder.Write(" of ");
FieldSectionPages fieldSectionPages = (FieldSectionPages)builder.InsertField(FieldType.FieldSectionPages, true);

Assert.AreEqual(" SECTIONPAGES ", fieldSectionPages.GetFieldCode());

// 将页眉移出回到主文档并插入两页。
// 所有这些页面都将在第一部分。我们的字段,每个标题出现一次,
// 将对本节的当前/总页数进行编号。
builder.MoveToDocumentEnd();
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);

// 我们可以像这样使用文档构建器插入一个新部分。
// 这将影响所有即将出现的标题中 SECTION 和 SECTIONPAGES 字段中显示的值。
builder.InsertBreak(BreakType.SectionBreakNewPage);

// PAGE 字段将继续计算整个文档的页数。
// 我们可以在每个部分手动重置其计数,以逐节跟踪页面。
builder.CurrentSection.PageSetup.RestartPageNumbering = true;
builder.InsertBreak(BreakType.PageBreak);

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.SECTION.SECTIONPAGES.docx");

也可以看看