FieldAutoNumLgl

FieldAutoNumLgl class

实现 AUTONUMLGL 字段。

要了解更多信息，请访问使用字段文档文章。

public class FieldAutoNumLgl : Field

构造函数

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

特性

姓名描述
DisplayResult { get; }获取表示显示字段结果的文本。
End { get; }获取代表字段结束的节点。
Format { get; }获得FieldFormat提供对字段格式进行类型化访问的对象。
IsDirty { get; set; }获取或设置字段的当前结果是否由于对文档所做的其他修改而不再正确（陈旧）。
IsLocked { get; set; }获取或设置字段是否被锁定（不应重新计算其结果）。
LocaleId { get; set; }获取或设置字段的 LCID。
RemoveTrailingPeriod { get; set; }获取或设置是否显示不带尾随句点的数字。
Result { get; set; }获取或设置字段分隔符和字段结尾之间的文本。
Separator { get; }获取表示字段分隔符的节点。可以是无效的.
SeparatorCharacter { get; set; }获取或设置要使用的分隔符。
Start { get; }获取表示字段开始的节点。
virtual Type { get; }获取 Microsoft Word 字段类型。

方法

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

评论

插入合法格式的自动编号。

例子

展示如何使用 AUTONUMLGL 字段组织文档。

public void FieldAutoNumLgl()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    const string fillerText = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. " +
                              "\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ";

    // AUTONUMLGL 字段显示一个数字，该数字在其当前标题级别内的每个 AUTONUMLGL 字段处递增。
    // 这些字段为每个标题级别维护单独的计数，
     // 并且每个字段还显示其自身下方所有标题级别的 AUTONUMLGL 字段计数。
    // 更改任何标题级别的计数都会将该级别以上所有级别的计数重置为 1。
    // 这使我们能够以大纲列表的形式组织我们的文档。
    // 这是标题级别为 1 的第一个 AUTONUMLGL 字段，在文档中显示“1。”。
    InsertNumberedClause(builder, "\tHeading 1", fillerText, StyleIdentifier.Heading1);

    // 这是标题级别为 1 的第二个 AUTONUMLGL 字段，因此它将显示“2。”。
    InsertNumberedClause(builder, "\tHeading 2", fillerText, StyleIdentifier.Heading1);

    // 这是标题级别为 2 的第一个 AUTONUMLGL 字段，
    // 并且其下方标题级别的 AUTONUMLGL 计数为“2”，因此它将显示“2.1”。
    InsertNumberedClause(builder, "\tHeading 3", fillerText, StyleIdentifier.Heading2);

     // 这是标题级别为 3 的第一个 AUTONUMLGL 字段。
    // 和上面的字段一样，会显示“2.1.1。”。
    InsertNumberedClause(builder, "\tHeading 4", fillerText, StyleIdentifier.Heading3);

    // 此字段的标题级别为 2，其相应的 AUTONUMLGL 计数为 2，因此该字段将显示“2.2。”。
    InsertNumberedClause(builder, "\tHeading 5", fillerText, StyleIdentifier.Heading2);

    // 增加低于此标题级别的 AUTONUMLGL 计数
    // 已重置此级别的计数，以便此字段将显示“2.2.1”。
    InsertNumberedClause(builder, "\tHeading 6", fillerText, StyleIdentifier.Heading3);

    foreach (FieldAutoNumLgl field in doc.Range.Fields.Where(f => f.Type == FieldType.FieldAutoNumLegal).ToList())
    {
        // 分隔符，出现在字段结果中紧跟在数字之后，
        // 默认为句号。如果我们将此属性保留为空，
        // 我们的最后一个 AUTONUMLGL 字段将在文档中显示“2.2.1。”。
        Assert.IsNull(field.SeparatorCharacter);

        // 设置自定义分隔符并删除尾随句点
        // 将把该字段的外观从“2.2.1.”更改为“2:2:1”。
        // 我们将把它应用到我们创建的所有字段。
        field.SeparatorCharacter = ":";
        field.RemoveTrailingPeriod = true;
        Assert.AreEqual(" AUTONUMLGL  \\s : \\e", field.GetFieldCode());
    }

    doc.Save(ArtifactsDir + "Field.AUTONUMLGL.docx");
}

/// <summary>
/// 使用文档生成器插入由 AUTONUMLGL 字段编号的子句。
/// </summary>
private static void InsertNumberedClause(DocumentBuilder builder, string heading, string contents, StyleIdentifier headingStyle)
{
    builder.InsertField(FieldType.FieldAutoNumLegal, true);
    builder.CurrentParagraph.ParagraphFormat.StyleIdentifier = headingStyle;
    builder.Writeln(heading);

    // 此文本将属于其上方的自动编号合法字段。
    // 当我们单击 Microsoft Word 中相应 AUTONUMLGL 字段旁边的箭头时，它将会折叠。
    builder.CurrentParagraph.ParagraphFormat.StyleIdentifier = StyleIdentifier.BodyText;
    builder.Writeln(contents);
}

也可以看看

FieldAutoNum Class FieldAutoNumOut Class