FieldAdvance

FieldAdvance class

实现 ADVANCE 字段。

public class FieldAdvance : Field

构造函数

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

特性

姓名 描述
DisplayResult { get; } 获取表示显示字段结果的文本。
DownOffset { get; set; } 获取或设置字段后面的文本应向下移动的点数。
End { get; } 获取代表字段end的节点。
Format { get; } 得到一个FieldFormat提供对字段格式的类型化访问的对象。
HorizontalPosition { get; set; } 获取或设置字段后面的文本应从列、框架或文本框的左边缘水平移动的点数 。
IsDirty { get; set; } 获取或设置字段的当前结果是否由于对文档的其他修改而不再正确（陈旧）。
IsLocked { get; set; } 获取或设置字段是否被锁定（不应重新计算其结果）。
LeftOffset { get; set; } 获取或设置字段后面的文本应向左移动的点数。
LocaleId { get; set; } 获取或设置字段的LCID。
Result { get; set; } 获取或设置字段分隔符和字段结尾之间的文本。
RightOffset { get; set; } 获取或设置字段后面的文本应向右移动的点数。
Separator { get; } 获取表示字段分隔符的节点。可以为空。
Start { get; } 获取表示字段开始的节点。
virtual Type { get; } 获取 Microsoft Word 字段类型。
UpOffset { get; set; } 获取或设置字段后面的文本应该向上移动的点数。
VerticalPosition { get; set; } 获取或设置字段后面的文本应从页面顶部边缘垂直移动的点数 。

方法

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

评论

将在词法上跟随该字段的文本显示的起点向右或向左移动， 向上或向下，或移动到特定的水平或垂直位置。

例子

显示如何插入 ADVANCE 字段并编辑其属性。

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

builder.Write("This text is in its normal place.");

// 下面是使用 ADVANCE 字段调整其后文本位置的两种方法。
// 继续应用 ADVANCE 字段的效果，直到段落结束，
// 或另一个 ADVANCE 字段更新偏移/坐标值。
// 1 - 指定方向偏移：
FieldAdvance field = (FieldAdvance)builder.InsertField(FieldType.FieldAdvance, true);
field.RightOffset = "5";
field.UpOffset = "5";

Assert.AreEqual(" ADVANCE  \\r 5 \\u 5", field.GetFieldCode());

builder.Write("This text will be moved up and to the right.");

field = (FieldAdvance)builder.InsertField(FieldType.FieldAdvance, true);
field.DownOffset = "5";
field.LeftOffset = "100";

Assert.AreEqual(" ADVANCE  \\d 5 \\l 100", field.GetFieldCode());

builder.Writeln("This text is moved down and to the left, overlapping the previous text.");

// 2 - 将文本移动到坐标指定的位置：
field = (FieldAdvance)builder.InsertField(FieldType.FieldAdvance, true);
field.HorizontalPosition = "-100";
field.VerticalPosition = "200";

Assert.AreEqual(" ADVANCE  \\x -100 \\y 200", field.GetFieldCode());

builder.Write("This text is in a custom position.");

doc.Save(ArtifactsDir + "Field.ADVANCE.docx");

也可以看看

FieldAddressBlock FieldArgumentBuilder