Aspose::Words::Fields::FieldRef класс

FieldRef class

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

class FieldRef : public Aspose::Words::Fields::Field,
                 public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
                 public Aspose::Words::Fields::IMergeFieldSurrogate

Методы

МетодОписание
get_BookmarkName()Получает или задает имя ссылочной закладки.
get_DisplayResult()Получает текст, представляющий отображаемый результат поля.
get_End() overrideПолучает узел, представляющий конец поля.
get_End() constПолучает узел, представляющий конец поля.
get_FieldEnd() constПолучает узел, представляющий конец поля.
get_FieldStart() constПолучает узел, представляющий начало поля.
get_Format()Получает объект FieldFormat, который предоставляет типизированный доступ к форматированию поля.
get_IncludeNoteOrComment()Получает, следует ли увеличивать номера сносок, концевых сносок и аннотаций, отмеченных закладкой, и вставлять соответствующий текст сноски, концевой сноски и комментария.
get_InsertHyperlink()Получает, следует ли создавать гиперссылку на закладочный абзац.
get_InsertParagraphNumber()Получает, следует ли вставлять номер абзаца ссылочного абзаца точно так, как он отображается в документе.
get_InsertParagraphNumberInFullContext()Получает, следует ли вставлять номер абзаца ссылочного абзаца в полном контексте.
get_InsertParagraphNumberInRelativeContext()Получает, следует ли вставлять номер абзаца ссылочного абзаца в относительном контексте.
get_InsertRelativePosition()Получает, следует ли вставлять относительное положение ссылочного абзаца.
get_IsDirty()Получает или задает, является ли текущий результат поля более некорректным (устаревшим) из‑за других изменений, внесённых в документ.
get_IsLocked()Получает или задает, заблокировано ли поле (не должно пересчитывать свой результат).
get_LocaleId()Получает или задает LCID поля.
get_NumberSeparator()Получает последовательность символов, используемую для разделения номеров последовательностей и номеров страниц.
get_Result()Получает или задает текст, находящийся между разделителем поля и его концом.
get_Separator() overrideПолучает узел, представляющий разделитель поля. Может быть null.
get_Start() overrideПолучает узел, представляющий начало поля.
get_Start() constПолучает узел, представляющий начало поля.
get_SuppressNonDelimiters()Получает, следует ли подавлять символы, не являющиеся разделителями.
virtual get_Type() constПолучает тип поля Microsoft Word.
GetFieldCode()Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует). Включены как код поля, так и результат дочерних полей.
GetFieldCode(bool)Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует).
GetType() const override
Is(const System::TypeInfo&) const override
virtual Remove()Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля является последним дочерним элементом его родительского узла, возвращает родительский абзац. Если поле уже удалено, возвращает null.
set_BookmarkName(const System::String&)Сеттер для Aspose::Words::Fields::FieldRef::get_BookmarkName.
set_IncludeNoteOrComment(bool)Задает, следует ли увеличивать номера сносок, концевых сносок и аннотаций, отмеченных закладкой, и вставлять соответствующий текст сноски, концевой сноски и комментария.
set_InsertHyperlink(bool)Задает, следует ли создавать гиперссылку на закладочный абзац.
set_InsertParagraphNumber(bool)Задает, следует ли вставлять номер абзаца ссылочного абзаца точно так, как он отображается в документе.
set_InsertParagraphNumberInFullContext(bool)Задает, следует ли вставлять номер абзаца ссылочного абзаца в полном контексте.
set_InsertParagraphNumberInRelativeContext(bool)Устанавливает, следует ли вставлять номер абзаца ссылочного абзаца в относительном контексте.
set_InsertRelativePosition(bool)Устанавливает, следует ли вставлять относительное положение ссылочного абзаца.
set_IsDirty(bool)Сеттер для Aspose::Words::Fields::Field::get_IsDirty.
set_IsLocked(bool)Сеттер для Aspose::Words::Fields::Field::get_IsLocked.
set_LocaleId(int32_t)Сеттер для Aspose::Words::Fields::Field::get_LocaleId.
set_NumberSeparator(const System::String&)Устанавливает последовательность символов, используемую для разделения номеров последовательностей и номеров страниц.
set_Result(const System::String&)Сеттер для Aspose::Words::Fields::Field::get_Result.
set_SuppressNonDelimiters(bool)Устанавливает, следует ли подавлять неделительные символы.
static Type()
Unlink()Выполняет отсоединение поля.
Update()Выполняет обновление поля. Вызывает исключение, если поле уже обновляется.
Update(bool)Выполняет обновление поля. Выбрасывает исключение, если поле уже обновляется.

Примеры

Показывает, как создать текст с закладкой с помощью поля SET, а затем отобразить его в документе с помощью поля REF.

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

// Назовите текст с закладкой с помощью поля SET.
// Это поле ссылается на \"bookmark\", а не на структуру закладки, которая появляется в тексте, а на именованную переменную.
auto fieldSet = System::ExplicitCast<Aspose::Words::Fields::FieldSet>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldSet, false));
fieldSet->set_BookmarkName(u"MyBookmark");
fieldSet->set_BookmarkText(u"Hello world!");
fieldSet->Update();

ASSERT_EQ(u" SET  MyBookmark \"Hello world!\"", fieldSet->GetFieldCode());

// Обратитесь к закладке по имени в поле REF и отобразите её содержимое.
auto fieldRef = System::ExplicitCast<Aspose::Words::Fields::FieldRef>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldRef, true));
fieldRef->set_BookmarkName(u"MyBookmark");
fieldRef->Update();

ASSERT_EQ(u" REF  MyBookmark", fieldRef->GetFieldCode());
ASSERT_EQ(u"Hello world!", fieldRef->get_Result());

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

См. также

Aspose::Words::Fields::FieldRD class Aspose::Words::Fields::FieldRevNum класс