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)Выполняет обновление поля. Выдает исключение, если поле уже обновляется.

Примечания

Извлекает символ, значение кодовой точки которого указано в десятичном или шестнадцатеричном формате.

Примеры

Показывает, как использовать поле СИМВОЛ.

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

// Ниже приведены три способа использования поля SYMBOL для отображения одного символа.
// 1 - Добавить поле СИМВОЛ, которое отображает символ © (авторское право), заданный кодом символа 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 - Добавьте поле СИМВОЛ, отображающее символ ∞ (бесконечность), и измените его внешний вид:
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 - Добавить поле СИМВОЛ, которое отображает символ あ,
// со шрифтом, поддерживающим кодовую страницу 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