InsertField

InsertField(FieldType, bool)

将 Word 字段插入文档并选择性地更新字段结果。

public Field InsertField(FieldType fieldType, bool updateField)
范围类型描述
fieldTypeFieldType要附加的字段的类型。
updateFieldBoolean指定是否立即更新字段。

返回值

一个Field代表插入字段的对象。

评论

此方法将字段插入文档。 Aspose.Words 可以更新大多数类型的字段，但并非所有类型均可。更多详情请参阅 InsertField超载。

例子

展示如何使用 FieldType 将字段插入文档。

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

// 插入两个字段，同时传递一个标志，该标志决定在构建器插入它们时是否更新它们。
// 在某些情况下，更新字段可能需要花费大量的计算资源，因此推迟更新可能是一个好主意。
doc.BuiltInDocumentProperties.Author = "John Doe";
builder.Write("This document was written by ");
builder.InsertField(FieldType.FieldAuthor, updateInsertedFieldsImmediately);

builder.InsertParagraph();
builder.Write("\nThis is page ");
builder.InsertField(FieldType.FieldPage, updateInsertedFieldsImmediately);

Assert.AreEqual(" AUTHOR ", doc.Range.Fields[0].GetFieldCode());
Assert.AreEqual(" PAGE ", doc.Range.Fields[1].GetFieldCode());

if (updateInsertedFieldsImmediately)
{
    Assert.AreEqual("John Doe", doc.Range.Fields[0].Result);
    Assert.AreEqual("1", doc.Range.Fields[1].Result);
}
else
{
    Assert.AreEqual(string.Empty, doc.Range.Fields[0].Result);
    Assert.AreEqual(string.Empty, doc.Range.Fields[1].Result);

    // 我们需要使用更新方法手动更新这些字段。
    doc.Range.Fields[0].Update();

    Assert.AreEqual("John Doe", doc.Range.Fields[0].Result);

    doc.UpdateFields();

    Assert.AreEqual("1", doc.Range.Fields[1].Result);
}

也可以看看

InsertField(string)

将 Word 字段插入文档并更新字段结果。

public Field InsertField(string fieldCode)
范围类型描述
fieldCodeString要插入的字段代码（不带花括号）。

返回值

一个Field代表插入字段的对象。

评论

此方法将字段插入文档并立即更新字段结果。 Aspose.Words 可以更新大多数类型的字段，但并非所有类型均可。更多详情请参阅 InsertField超载。

例子

展示如何使用字段代码将字段插入文档。

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

Field field = builder.InsertField("DATE \\@ \"dddd, MMMM dd, yyyy\"");

Assert.AreEqual(FieldType.FieldDate, field.Type);
Assert.AreEqual("DATE \\@ \"dddd, MMMM dd, yyyy\"", field.GetFieldCode());

// InsertField 方法的此重载会自动更新插入的字段。
Assert.True((DateTime.Today - DateTime.Parse(field.Result)).Days <= 1);

展示如何插入字段，并将文档构建器的光标移动到这些字段上。

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.InsertField(@"MERGEFIELD MyMergeField1 \* MERGEFORMAT");
builder.InsertField(@"MERGEFIELD MyMergeField2 \* MERGEFORMAT");

// 将光标移动到第一个 MERGEFIELD。
builder.MoveToMergeField("MyMergeField1", true, false);

// 请注意，光标位于第一个 MERGEFIELD 之后，第二个 MERGEFIELD 之前。
Assert.AreEqual(doc.Range.Fields[1].Start, builder.CurrentNode);
Assert.AreEqual(doc.Range.Fields[0].End, builder.CurrentNode.PreviousSibling);

// 如果我们希望使用构建器编辑字段的字段代码或内容，
// 它的光标需要位于字段内。
// 要将其放置在字段内，我们需要调用文档构建器的 MoveTo 方法
// 并将字段的开始或分隔节点作为参数传递。
builder.Write(" Text between our merge fields. ");

doc.Save(ArtifactsDir + "DocumentBuilder.MergeFields.docx");

也可以看看

InsertField(string, string)

将 Word 字段插入文档而不更新字段结果。

public Field InsertField(string fieldCode, string fieldValue)
范围类型描述
fieldCodeString要插入的字段代码（不带花括号）。
fieldValueString要插入的字段值。传递无效的对于没有值的字段。

返回值

一个Field代表插入字段的对象。

评论

Microsoft Word 文档中的字段由字段代码和字段结果组成。字段代码类似于公式，字段结果类似于公式生成的值。字段代码还可能包含字段开关，这些开关类似于执行特定操作的附加指令。

您可以在 Microsoft Word 文档中，使用键盘快捷键 Alt+F9 在字段代码和结果显示之间切换。字段代码显示在花括号 ( { } ) 之间。

要创建字段，您需要指定字段类型、字段代码和“占位符”字段值。 如果您不确定特定的字段代码语法，请在 Microsoft Word 中首先创建该字段 并切换以查看其字段代码。

Aspose.Words 可以计算大多数字段类型的字段结果，但此方法不会自动更新字段结果。由于字段结果不会自动计算，您需要传递一些字符串值（甚至是空字符串），这些值将插入到字段结果中。此值将作为占位符保留在字段结果中，直到字段更新为止。要更新字段结果，您可以调用Update在字段对象 returned 上给你或UpdateFields更新整个文档中的字段。

例子

显示如何在某一部分设置页码。

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

builder.Writeln("Section 1, page 1.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 1, page 2.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 1, page 3.");
builder.InsertBreak(BreakType.SectionBreakNewPage);
builder.Writeln("Section 2, page 1.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 2, page 2.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 2, page 3.");

// 将文档构建器移动到第一部分的主标题，
// 该部分中的每个页面都将显示。
builder.MoveToSection(0);
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);

// 插入一个 PAGE 字段，它将显示当前页码。
builder.Write("Page ");
builder.InsertField("PAGE", "");

// 配置该部分以使 PAGE 字段显示的页数从 5 开始。
// 另外，配置所有 PAGE 字段以使用大写罗马数字显示其页码。
PageSetup pageSetup = doc.Sections[0].PageSetup;
pageSetup.RestartPageNumbering = true;
pageSetup.PageStartingNumber = 5;
pageSetup.PageNumberStyle = NumberStyle.UppercaseRoman;

// 为第二部分创建另一个主标题，并使用另一个 PAGE 字段。
builder.MoveToSection(1);
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.ParagraphFormat.Alignment = ParagraphAlignment.Center;
builder.Write(" - ");
builder.InsertField("PAGE", "");
builder.Write(" - ");

// 配置该部分以使 PAGE 字段显示的页数从 10 开始。
// 另外，配置所有 PAGE 字段以使用阿拉伯数字显示其页码。
pageSetup = doc.Sections[1].PageSetup;
pageSetup.PageStartingNumber = 10;
pageSetup.RestartPageNumbering = true;
pageSetup.PageNumberStyle = NumberStyle.Arabic;

doc.Save(ArtifactsDir + "PageSetup.PageNumbering.docx");

也可以看看

DocumentBuilder.InsertDocumentInline DocumentBuilder.InsertFootnote