SequenceName

FieldIndex.SequenceName property

获取或设置页码中包含编号的序列名称。

public string SequenceName { get; set; }

例子

演示如何通过组合 INDEX 和 SEQ 字段将文档拆分为多个部分。

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

// 创建一个 INDEX 字段，它将显示文档中找到的每个 XE 字段的条目。
// 每个条目都会在左侧显示XE字段的Text属性值，
// 以及右侧包含 XE 字段的页码。
// 如果 XE 字段的“Text”属性具有相同的值，
// INDEX 字段会将它们分组为一个条目。
FieldIndex index = (FieldIndex)builder.InsertField(FieldType.FieldIndex, true);

// 在 SequenceName 属性中，命名 SEQ 字段序列。该索引字段的每个条目现在也将显示
// 创建此条目的 XE 字段位置处的序列计数编号。
index.SequenceName = "MySequence";

// 设置围绕序列和页码的文本，以向用户解释它们的含义。
// 使用此配置创建的条目将在其页码处显示类似“MySequence at 1 on page 1”的内容。
// PageNumberSeparator 和 SequenceSeparator 不能超过 15 个字符。
index.PageNumberSeparator = "\tMySequence at ";
index.SequenceSeparator = " on page ";
Assert.IsTrue(index.HasSequenceName);

Assert.AreEqual(" INDEX  \\s MySequence \\e \"\tMySequence at \" \\d \" on page \"", index.GetFieldCode());

// SEQ 字段显示在每个 SEQ 字段处递增的计数。
// 这些字段还为每个唯一的命名序列维护单独的计数
// 由 SEQ 字段的“SequenceIdentifier”属性标识。
// 插入一个 SEQ 字段，将“MySequence”序列移至 1。
// 该字段与普通文档文本没有什么不同。它不会出现在 INDEX 字段的目录中。
builder.InsertBreak(BreakType.PageBreak);
FieldSeq sequenceField = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true);
sequenceField.SequenceIdentifier = "MySequence";

Assert.AreEqual(" SEQ  MySequence", sequenceField.GetFieldCode());

// 插入一个 XE 字段，该字段将在 INDEX 字段中创建一个条目。
// 由于“MySequence”位于 1 并且此 XE 字段位于第 2 页，以及我们上面定义的自定义分隔符，
// 该字段的 INDEX 条目将在左侧显示“Cat”，在右侧显示“MySequence at 1 on page 2”。
FieldXE indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Cat";

Assert.AreEqual(" XE  Cat", indexEntry.GetFieldCode());

// 插入分页符并使用 SEQ 字段将“MySequence”前进到 3。
builder.InsertBreak(BreakType.PageBreak);
sequenceField = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true);
sequenceField.SequenceIdentifier = "MySequence";
sequenceField = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true);
sequenceField.SequenceIdentifier = "MySequence";

// 插入一个与上面具有相同 Text 属性的 XE 字段。
// INDEX 条目会将 XE 字段与“Text”属性中的匹配值分组
// 进入一个条目，而不是为每个 XE 字段创建一个条目。
// 由于我们位于第 2 页，“MySequence”位于第 3 页，因此“, 3 on page 3”将被附加到与上面相同的 INDEX 条目。
// 该 INDEX 条目的页码部分现在将显示“MySequence at 1 on page 2, 3 on page 3”。
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Cat";

// 插入具有新的且唯一的 Text 属性值的 XE 字段。
// 这将添加一个新条目，MySequence 位于第 4 页的 3 处。
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Dog";

doc.UpdatePageLayout();
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.INDEX.XE.Sequence.docx");

也可以看看

FieldIndex.RunSubentriesOnSameLine FieldIndex.SequenceSeparator