FieldToa
内容
[
隐藏
]FieldToa class
实现 TOA 字段。
要了解更多信息,请访问使用字段文档文章。
public class FieldToa : Field
构造函数
姓名 | 描述 |
---|---|
FieldToa() | 默认构造函数。 |
特性
姓名 | 描述 |
---|---|
BookmarkName { get; set; } | 获取或设置书签的名称,该书签标记用于构建表的文档部分。 |
DisplayResult { get; } | 获取表示显示的字段结果的文本。 |
End { get; } | 获取表示字段结束的节点。 |
EntryCategory { get; set; } | 获取或设置表中包含的条目的完整类别。 |
EntrySeparator { get; set; } | 获取或设置用于分隔规范条目及其页码的字符序列。 |
Format { get; } | 获得FieldFormat 提供对字段格式的类型化访问的对象。 |
IsDirty { get; set; } | 获取或设置字段的当前结果是否由于对文档进行的其他修改而不再正确(陈旧)。 |
IsLocked { get; set; } | 获取或设置字段是否被锁定(不应重新计算其结果)。 |
LocaleId { get; set; } | 获取或设置字段的 LCID。 |
PageNumberListSeparator { get; set; } | 获取或设置用于分隔页码列表中两个页码的字符序列。 |
PageRangeSeparator { get; set; } | 获取或设置用于分隔页面范围的开始和结束的字符序列。 |
RemoveEntryFormatting { get; set; } | 获取或设置是否从权限表中的 条目中删除文档中条目文本的格式。 |
Result { get; set; } | 获取或设置字段分隔符和字段结束之间的文本。 |
Separator { get; } | 获取表示字段分隔符的节点。可无效的 . |
SequenceName { get; set; } | 获取或设置页码中包含编号的序列名称。 |
SequenceSeparator { get; set; } | 获取或设置用于分隔序列号和页码的字符序列。 |
Start { get; } | 获取表示字段开始的节点。 |
virtual Type { get; } | 获取 Microsoft Word 字段类型。 |
UseHeading { get; set; } | 获取或设置是否包含权限表中条目的类别标题。 |
UsePassim { get; set; } | 获取或设置是否将对同一 权威的五个或更多不同页面引用替换为“passim”,用于指示某个单词或段落在引用的作品中频繁出现 。 |
方法
姓名 | 描述 |
---|---|
GetFieldCode() | 返回字段开始和字段分隔符之间的文本(如果没有分隔符,则返回字段结束)。 包括子字段的字段代码和字段结果。 |
GetFieldCode(bool) | 返回字段开始和字段分隔符之间的文本(如果没有分隔符,则返回字段结束)。 |
Remove() | 从文档中删除该字段。返回字段后面的节点。如果字段的结尾是其父节点的最后一个 child ,则返回其父段落。如果该字段已被删除,则返回无效的 . |
Unlink() | 执行字段取消链接。 |
Update() | 执行字段更新。如果该字段已被更新,则抛出异常。 |
Update(bool) | 执行字段更新。如果该字段已被更新,则抛出异常。 |
评论
使用 TA 指定的 条目构建权限表(即法律文档中的引用列表,例如案例、法规和规则的引用 ,以及引用出现的页码)字段.
例子
展示如何使用 TOA 和 TA 字段构建和自定义权限表。
public void FieldTOA()
{
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// 插入一个 TOA 字段,这将为文档中的每个 TA 字段创建一个条目,
// 显示每个条目的长引用和页码。
FieldToa fieldToa = (FieldToa)builder.InsertField(FieldType.FieldTOA, false);
// 设置表的条目类别。此 TOA 现在仅包含 TA 字段
// 在其 EntryCategory 属性中具有匹配值。
fieldToa.EntryCategory = "1";
// 此外,索引 1 处的权限表类别是“案例”,
// 如果我们将此变量设置为 true,它将显示为表格的标题。
fieldToa.UseHeading = true;
// 我们可以通过命名它们需要在 TOA 范围内的书签来进一步过滤 TA 字段。
fieldToa.BookmarkName = "MyBookmark";
// 默认情况下,TA 字段的引文之间会出现一个虚线全页选项卡
// 及其页码。我们可以将其替换为我们在此属性上放置的任何文本。
// 插入制表符将保留原始制表符。
fieldToa.EntrySeparator = " \t p.";
// 如果我们有多个 TA 条目共享相同的长引用,
// 所有它们各自的页码将显示在一行上。
// 我们可以使用此属性来指定一个字符串来分隔它们的页码。
fieldToa.PageNumberListSeparator = " & p. ";
// 我们可以将其设置为 true 以使我们的表格显示单词“passim”
// 如果一行中有五个或更多页码。
fieldToa.UsePassim = true;
// 一个 TA 字段可以引用一系列页面。
// 我们可以在此处指定一个字符串,使其出现在此类范围的起始页码和结束页码之间。
fieldToa.PageRangeSeparator = " to ";
// TA 字段的格式将延续到我们的表中。
// 我们可以通过设置RemoveEntryFormatting 标志来禁用此功能。
fieldToa.RemoveEntryFormatting = true;
builder.Font.Color = Color.Green;
builder.Font.Name = "Arial Black";
Assert.AreEqual(" TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f", fieldToa.GetFieldCode());
builder.InsertBreak(BreakType.PageBreak);
// 该 TA 字段不会作为 TOA 中的条目出现,因为它位于外部
// TOA 的 BookmarkName 属性指定的书签范围。
FieldTA fieldTA = InsertToaEntry(builder, "1", "Source 1");
Assert.AreEqual(" TA \\c 1 \\l \"Source 1\"", fieldTA.GetFieldCode());
// 这个 TA 字段在书签内部,
// 但条目类别与表类别不匹配,因此TA字段不会包含它。
builder.StartBookmark("MyBookmark");
fieldTA = InsertToaEntry(builder, "2", "Source 2");
// 该条目将出现在表中。
fieldTA = InsertToaEntry(builder, "1", "Source 3");
// TOA 表不显示短引用,
// 但我们可以使用它们作为简写来引用多个 TA 字段引用的庞大源名称。
fieldTA.ShortCitation = "S.3";
Assert.AreEqual(" TA \\c 1 \\l \"Source 3\" \\s S.3", fieldTA.GetFieldCode());
// 我们可以使用以下属性将页码格式化为粗体/斜体。
// 如果我们将表格设置为忽略格式,我们仍然会看到这些效果。
fieldTA = InsertToaEntry(builder, "1", "Source 2");
fieldTA.IsBold = true;
fieldTA.IsItalic = true;
Assert.AreEqual(" TA \\c 1 \\l \"Source 2\" \\b \\i", fieldTA.GetFieldCode());
// 我们可以配置 TA 字段以获取其 TOA 条目来引用书签跨越的页面范围。
// 请注意,此条目引用与上面的条目相同的源,以共享表中的一行。
// 该行将包含上面条目的页码和该条目的页范围,
// 用表格的页列表和页码之间的页码范围分隔符。
fieldTA = InsertToaEntry(builder, "1", "Source 3");
fieldTA.PageRangeBookmarkName = "MyMultiPageBookmark";
builder.StartBookmark("MyMultiPageBookmark");
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);
builder.EndBookmark("MyMultiPageBookmark");
Assert.AreEqual(" TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark", fieldTA.GetFieldCode());
// 如果我们启用了表的“Passim”功能,则具有相同源的 5 个或更多 TA 条目将调用它。
for (int i = 0; i < 5; i++)
{
InsertToaEntry(builder, "1", "Source 4");
}
builder.EndBookmark("MyBookmark");
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.TOA.TA.docx");
}
private static FieldTA InsertToaEntry(DocumentBuilder builder, string entryCategory, string longCitation)
{
FieldTA field = (FieldTA)builder.InsertField(FieldType.FieldTOAEntry, false);
field.EntryCategory = entryCategory;
field.LongCitation = longCitation;
builder.InsertBreak(BreakType.PageBreak);
return field;
}
也可以看看
- class Field
- 命名空间 Aspose.Words.Fields
- 部件 Aspose.Words