FieldStyleRef

FieldStyleRef class

实现 STYLEREF 字段。

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

public class FieldStyleRef : Field

构造函数

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

特性

姓名描述
DisplayResult { get; }获取表示显示字段结果的文本。
End { get; }获取代表字段结束的节点。
Format { get; }获得FieldFormat提供对字段格式进行类型化访问的对象。
InsertParagraphNumber { get; set; }获取或设置是否插入与文档中显示的完全相同的引用段落的段落编号。
InsertParagraphNumberInFullContext { get; set; }获取或设置是否在完整上下文中插入引用段落的段落编号。
InsertParagraphNumberInRelativeContext { get; set; }获取或设置是否在相对上下文中插入引用段落的段落编号。
InsertRelativePosition { get; set; }获取或设置是否插入引用段落的相对位置。
IsDirty { get; set; }获取或设置字段的当前结果是否由于对文档所做的其他修改而不再正确（陈旧）。
IsLocked { get; set; }获取或设置字段是否被锁定（不应重新计算其结果）。
LocaleId { get; set; }获取或设置字段的 LCID。
Result { get; set; }获取或设置字段分隔符和字段结尾之间的文本。
SearchFromBottom { get; set; }获取或设置是否从当前页面底部搜索，而不是从顶部搜索。
Separator { get; }获取表示字段分隔符的节点。可以是无效的.
Start { get; }获取表示字段开始的节点。
StyleName { get; set; }获取或设置要搜索的文本格式的样式名称。
SuppressNonDelimiters { get; set; }获取或设置是否抑制非分隔符。
virtual Type { get; }获取 Microsoft Word 字段类型。

方法

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

评论

STYLEREF 用于引用文档中用指定样式格式化的文本片段。

例子

展示如何使用 STYLEREF 字段。

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

// 使用 Microsoft Word 列表模板创建列表。
Aspose.Words.Lists.List list = doc.Lists.Add(Aspose.Words.Lists.ListTemplate.NumberDefault);

// 此生成的列表将显示“1.a)”。
 // 括号前的空格是非分隔符，我们可以抑制它。
list.ListLevels[0].NumberFormat = "\x0000.";
list.ListLevels[1].NumberFormat = "\x0001 )";

// 添加文本并应用 STYLEREF 字段将引用的段落样式。
builder.ListFormat.List = list;
builder.ListFormat.ListIndent();
builder.ParagraphFormat.Style = doc.Styles["List Paragraph"];
builder.Writeln("Item 1");
builder.ParagraphFormat.Style = doc.Styles["Quote"];
builder.Writeln("Item 2");
builder.ParagraphFormat.Style = doc.Styles["List Paragraph"];
builder.Writeln("Item 3");
builder.ListFormat.RemoveNumbers();
builder.ParagraphFormat.Style = doc.Styles["Normal"];

// 在标题中放置一个 STYLEREF 字段并显示文档中第一个“列表段落”样式的文本。
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
FieldStyleRef field = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
field.StyleName = "List Paragraph";

// 在页脚中放置一个 STYLEREF 字段，并让它显示最后的文本。
builder.MoveToHeaderFooter(HeaderFooterType.FooterPrimary);
field = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
field.StyleName = "List Paragraph";
field.SearchFromBottom = true;

builder.MoveToDocumentEnd();

// 我们还可以使用 STYLEREF 字段来引用列表的列表编号。
builder.Write("\nParagraph number: ");
field = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
field.StyleName = "Quote";
field.InsertParagraphNumber = true;

builder.Write("\nParagraph number, relative context: ");
field = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
field.StyleName = "Quote";
field.InsertParagraphNumberInRelativeContext = true;

builder.Write("\nParagraph number, full context: ");
field = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
field.StyleName = "Quote";
field.InsertParagraphNumberInFullContext = true;

builder.Write("\nParagraph number, full context, non-delimiter chars suppressed: ");
field = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
field.StyleName = "Quote";
field.InsertParagraphNumberInFullContext = true;
field.SuppressNonDelimiters = true;

doc.UpdatePageLayout();
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.STYLEREF.docx");

也可以看看

FieldStart Class FieldSubject Class