FieldSymbol

FieldSymbol class

Реализует поле СИМВОЛ.

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 - Добавьте поле 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 - Добавьте поле СИМВОЛ, которое отображает символ ∞ (бесконечность), и измените его внешний вид:
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");

Смотрите также