FieldSymbol

FieldSymbol class

实现 SYMBOL 字段。

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

public class FieldSymbol : Field

构造函数

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

特性

姓名描述
CharacterCode { get; set; }获取或设置字符的十进制或十六进制代码点值。
DisplayResult { get; }获取表示显示的字段结果的文本。
DontAffectsLineSpacing { get; set; }获取或设置字段检索的字符是否影响段落的行距。
End { get; }获取表示字段结束的节点。
FontName { get; set; }获取或设置字段检索的字符的字体名称。
FontSize { get; set; }获取或设置字段检索的字符的字体大小（以磅为单位）。
Format { get; }获得FieldFormat提供对字段格式的类型化访问的对象。
IsAnsi { get; set; }获取或设置是否将字符代码解释为 ANSI 字符的值。
IsDirty { get; set; }获取或设置字段的当前结果是否由于对文档进行的其他修改而不再正确（陈旧）。
IsLocked { get; set; }获取或设置字段是否被锁定（不应重新计算其结果）。
IsShiftJis { get; set; }获取或设置是否将字符代码解释为 SHIFT-JIS 字符的值。
IsUnicode { get; set; }获取或设置是否将字符代码解释为 Unicode 字符的值。
LocaleId { get; set; }获取或设置字段的 LCID。
Result { get; set; }获取或设置字段分隔符和字段结束之间的文本。
Separator { get; }获取表示字段分隔符的节点。可无效的.
Start { get; }获取表示字段开始的节点。
virtual Type { get; }获取 Microsoft Word 字段类型。

方法

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

评论

检索其代码点值以十进制或十六进制指定的字符。

例子

显示如何使用 SYMBOL 字段。

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

// 下面是使用 SYMBOL 字段显示单个字符的三种方法。
// 1 - 添加一个 SYMBOL 字段，用于显示由 ANSI 字符代码指定的 ©（版权）符号：
FieldSymbol field = (FieldSymbol)builder.InsertField(FieldType.FieldSymbol, true);

// ANSI 字符代码“U+00A9”，或整数形式的“169”，是为版权符号保留的。
field.CharacterCode = 0x00a9.ToString();
field.IsAnsi = true;

Assert.AreEqual(" SYMBOL  169 \\a", field.GetFieldCode());

builder.Writeln(" Line 1");

// 2 - 添加一个显示 Infinity 符号的 SYMBOL 字段，并修改其外观：
field = (FieldSymbol)builder.InsertField(FieldType.FieldSymbol, true);

// 在Unicode中，无穷大符号占据“221E”代码。
field.CharacterCode = 0x221E.ToString();
field.IsUnicode = true;

// 使用 Windows 字符映射表后更改符号的字体
// 确保字体可以代表该符号。
field.FontName = "Calibri";
field.FontSize = "24";

// 我们可以为高符号设置此标志，以使它们不会向下推其行上的其余文本。
field.DontAffectsLineSpacing = true;

Assert.AreEqual(" SYMBOL  8734 \\u \\f Calibri \\s 24 \\h", field.GetFieldCode());

builder.Writeln("Line 2");

// 3 - 添加一个显示 あ 字符的 SYMBOL 字段，
// 使用支持 Shift-JIS (Windows-932) 代码页的字体：
field = (FieldSymbol)builder.InsertField(FieldType.FieldSymbol, true);
field.FontName = "MS Gothic";
field.CharacterCode = 0x82A0.ToString();
field.IsShiftJis = true;

Assert.AreEqual(" SYMBOL  33440 \\f \"MS Gothic\" \\j", field.GetFieldCode());

builder.Write("Line 3");

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

也可以看看

FieldSubject Class FieldTA Class