Aspose::Words::Fields::FieldSymbol class

FieldSymbol class

Реализует поле SYMBOL. Чтобы узнать больше, посетите статью документации Working with Fields.

class FieldSymbol : public Aspose::Words::Fields::Field,
                    public Aspose::Words::Fields::IFieldCodeTokenInfoProvider

Методы

МетодОписание
get_CharacterCode()Получает или задает значение кодовой точки символа в десятичном или шестнадцатеричном виде.
get_DisplayResult()Получает текст, представляющий отображаемый результат поля.
get_DontAffectsLineSpacing()Получает или задает, влияет ли символ, полученный полем, на межстрочный интервал абзаца.
get_End() constПолучает узел, представляющий конец поля.
get_FieldEnd() constПолучает узел, представляющий конец поля.
get_FieldStart() constПолучает узел, представляющий начало поля.
get_FontName()Получает или задает название шрифта символа, полученного полем.
get_FontSize()Получает или задает размер шрифта символа, полученного полем, в пунктах.
get_Format()Получает объект FieldFormat, который предоставляет типизированный доступ к форматированию поля.
get_IsAnsi()Получает или задает, интерпретируется ли код символа как значение ANSI‑символа.
get_IsDirty()Получает или задает, является ли текущий результат поля более некорректным (устаревшим) из‑за других изменений, внесённых в документ.
get_IsLocked()Получает или задает, заблокировано ли поле (не должно пересчитывать свой результат).
get_IsShiftJis()Получает или задает, интерпретируется ли код символа как значение символа SHIFT-JIS.
get_IsUnicode()Получает или задает, интерпретируется ли код символа как значение Unicode‑символа.
get_LocaleId()Получает или задает LCID поля.
get_Result()Получает или задает текст, находящийся между разделителем поля и его концом.
get_Separator()Получает узел, представляющий разделитель поля. Может быть null.
get_Start() constПолучает узел, представляющий начало поля.
virtual get_Type() constПолучает тип поля Microsoft Word.
GetFieldCode()Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует). Включены как код поля, так и результат дочерних полей.
GetFieldCode(bool)Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует).
GetType() const override
Is(const System::TypeInfo&) const override
virtual Remove()Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля является последним дочерним элементом его родительского узла, возвращает родительский абзац. Если поле уже удалено, возвращает null.
set_CharacterCode(const System::String&)Setter for Aspose::Words::Fields::FieldSymbol::get_CharacterCode.
set_DontAffectsLineSpacing(bool)Setter for Aspose::Words::Fields::FieldSymbol::get_DontAffectsLineSpacing.
set_FontName(const System::String&)Setter for Aspose::Words::Fields::FieldSymbol::get_FontName.
set_FontSize(const System::String&)Setter for Aspose::Words::Fields::FieldSymbol::get_FontSize.
set_IsAnsi(bool)Setter for Aspose::Words::Fields::FieldSymbol::get_IsAnsi.
set_IsDirty(bool)Сеттер для Aspose::Words::Fields::Field::get_IsDirty.
set_IsLocked(bool)Сеттер для Aspose::Words::Fields::Field::get_IsLocked.
set_IsShiftJis(bool)Setter for Aspose::Words::Fields::FieldSymbol::get_IsShiftJis.
set_IsUnicode(bool)Setter for Aspose::Words::Fields::FieldSymbol::get_IsUnicode.
set_LocaleId(int32_t)Сеттер для Aspose::Words::Fields::Field::get_LocaleId.
set_Result(const System::String&)Сеттер для Aspose::Words::Fields::Field::get_Result.
static Type()
Unlink()Выполняет отсоединение поля.
Update()Выполняет обновление поля. Вызывает исключение, если поле уже обновляется.
Update(bool)Выполняет обновление поля. Выбрасывает исключение, если поле уже обновляется.

Примеры

Показывает, как использовать поле SYMBOL.

auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);

// Ниже представлены три способа использования поля SYMBOL для отображения одного символа.
// 1 -  Добавьте поле SYMBOL, которое отображает символ © (Copyright), указанный ANSI-кодом символа:
auto field = System::ExplicitCast<Aspose::Words::Fields::FieldSymbol>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldSymbol, true));

// ANSI-код символа "U+00A9" или "169" в целочисленном виде зарезервирован для символа копирайта.
field->set_CharacterCode(System::Convert::ToString(0x00a9));
field->set_IsAnsi(true);

ASSERT_EQ(u" SYMBOL  169 \\a", field->GetFieldCode());

builder->Writeln(u" Line 1");

// 2 -  Добавьте поле SYMBOL, которое отображает символ ∞ (Infinity), и измените его внешний вид:
field = System::ExplicitCast<Aspose::Words::Fields::FieldSymbol>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldSymbol, true));

// В Unicode символ бесконечности занимает код "221E".
field->set_CharacterCode(System::Convert::ToString(0x221E));
field->set_IsUnicode(true);

// Измените шрифт нашего символа после использования Windows Character Map
// чтобы убедиться, что шрифт может отобразить этот символ.
field->set_FontName(u"Calibri");
field->set_FontSize(u"24");

// Мы можем установить этот флаг для высоких символов, чтобы они не опускали остальной текст в своей строке.
field->set_DontAffectsLineSpacing(true);

ASSERT_EQ(u" SYMBOL  8734 \\u \\f Calibri \\s 24 \\h", field->GetFieldCode());

builder->Writeln(u"Line 2");

// 3 -  Добавьте поле SYMBOL, которое отображает символ あ,
// со шрифтом, поддерживающим кодовую страницу Shift-JIS (Windows-932):
field = System::ExplicitCast<Aspose::Words::Fields::FieldSymbol>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldSymbol, true));
field->set_FontName(u"MS Gothic");
field->set_CharacterCode(System::Convert::ToString(0x82A0));
field->set_IsShiftJis(true);

ASSERT_EQ(u" SYMBOL  33440 \\f \"MS Gothic\" \\j", field->GetFieldCode());

builder->Write(u"Line 3");

doc->Save(get_ArtifactsDir() + u"Field.SYMBOL.docx");

См. также

Класс Aspose::Words::Fields::FieldSubject Aspose::Words::Fields::FieldTA класс