Класс Aspose::Words::Fields::FieldDocVariable
Содержание
[
Скрывать
]FieldDocVariable class
Реализует поле DOCVARIABLE. Чтобы узнать больше, посетите статью документации Working with Fields .
class FieldDocVariable : public Aspose::Words::Fields::Field
Методы
| Метод | Описание |
|---|---|
| get_DisplayResult() | Получает текст, представляющий отображаемый результат поля. |
| get_End() const | Получает узел, представляющий конец поля. |
| get_FieldEnd() const | Получает узел, представляющий конец поля. |
| get_FieldStart() const | Получает узел, представляющий начало поля. |
| get_Format() | Получает объект FieldFormat, который предоставляет типизированный доступ к форматированию поля. |
| get_IsDirty() | Получает или задает, является ли текущий результат поля более некорректным (устаревшим) из‑за других изменений, внесённых в документ. |
| get_IsLocked() | Получает или задает, заблокировано ли поле (не должно пересчитывать свой результат). |
| get_LocaleId() | Получает или задает LCID поля. |
| get_Result() | Получает или задает текст, находящийся между разделителем поля и его концом. |
| get_Separator() | Получает узел, представляющий разделитель поля. Может быть null. |
| get_Start() const | Получает узел, представляющий начало поля. |
| virtual get_Type() const | Получает тип поля Microsoft Word. |
| get_VariableName() | Получает или задает имя переменной документа для получения. |
| GetFieldCode() | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует). Включены как код поля, так и результат дочерних полей. |
| GetFieldCode(bool) | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует). |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| virtual Remove() | Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля является последним дочерним элементом его родительского узла, возвращает родительский абзац. Если поле уже удалено, возвращает null. |
| 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_Result(const System::String&) | Сеттер для Aspose::Words::Fields::Field::get_Result. |
| set_VariableName(const System::String&) | Сеттер для Aspose::Words::Fields::FieldDocVariable::get_VariableName. |
| static Type() | |
| Unlink() | Выполняет отсоединение поля. |
| Update() | Выполняет обновление поля. Вызывает исключение, если поле уже обновляется. |
| Update(bool) | Выполняет обновление поля. Выбрасывает исключение, если поле уже обновляется. |
Примеры
Показывает, как использовать поля DOCPROPERTY для отображения свойств документа и переменных.
auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);
// Ниже представлены два способа использования полей DOCPROPERTY.
// 1 - Показать встроенное свойство:
// Установите пользовательское значение для встроенного свойства "Category", затем вставьте поле DOCPROPERTY, которое ссылается на него.
doc->get_BuiltInDocumentProperties()->set_Category(u"My category");
auto fieldDocProperty = System::ExplicitCast<Aspose::Words::Fields::FieldDocProperty>(builder->InsertField(u" DOCPROPERTY Category "));
fieldDocProperty->Update();
ASSERT_EQ(u" DOCPROPERTY Category ", fieldDocProperty->GetFieldCode());
ASSERT_EQ(u"My category", fieldDocProperty->get_Result());
builder->InsertParagraph();
// 2 - Показать пользовательскую переменную документа:
// Определите пользовательскую переменную, затем ссылаться на неё с помощью поля DOCPROPERTY.
ASSERT_EQ(0, doc->get_Variables()->get_Count());
doc->get_Variables()->Add(u"My variable", u"My variable's value");
auto fieldDocVariable = System::ExplicitCast<Aspose::Words::Fields::FieldDocVariable>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldDocVariable, true));
fieldDocVariable->set_VariableName(u"My Variable");
fieldDocVariable->Update();
ASSERT_EQ(u" DOCVARIABLE \"My Variable\"", fieldDocVariable->GetFieldCode());
ASSERT_EQ(u"My variable's value", fieldDocVariable->get_Result());
doc->Save(get_ArtifactsDir() + u"Field.DOCPROPERTY.DOCVARIABLE.docx");
См. также
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++
