Aspose::Words::Fields::FieldComments class
Содержание
[
Скрывать
]FieldComments class
Реализует поле COMMENTS. Чтобы узнать больше, посетите статью документации Working with Fields.
class FieldComments : 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 | Получает узел, представляющий начало поля. |
| get_Text() | Получает или задает текст комментариев. |
| virtual get_Type() const | Получает тип поля Microsoft Word. |
| 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_Text(const System::String&) | Сеттер для Aspose::Words::Fields::FieldComments::get_Text. |
| static Type() | |
| Unlink() | Выполняет отсоединение поля. |
| Update() | Выполняет обновление поля. Вызывает исключение, если поле уже обновляется. |
| Update(bool) | Выполняет обновление поля. Выбрасывает исключение, если поле уже обновляется. |
Примеры
Показывает, как использовать поле COMMENTS.
auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);
// Установите значение встроенного свойства документа "Comments".
doc->get_BuiltInDocumentProperties()->set_Comments(u"My comment.");
// Создайте поле COMMENTS, чтобы отобразить значение этого встроенного свойства.
auto field = System::ExplicitCast<Aspose::Words::Fields::FieldComments>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldComments, true));
field->Update();
ASSERT_EQ(u" COMMENTS ", field->GetFieldCode());
ASSERT_EQ(u"My comment.", field->get_Result());
// Если мы зададим значение свойства Text поля COMMENTS и обновим его, поле будет
// перезаписывать текущее значение встроенного свойства "Comments" значением его свойства Text,
// а затем отображать новое значение.
field->set_Text(u"My overriding comment.");
field->Update();
ASSERT_EQ(u" COMMENTS \"My overriding comment.\"", field->GetFieldCode());
ASSERT_EQ(u"My overriding comment.", field->get_Result());
doc->Save(get_ArtifactsDir() + u"Field.COMMENTS.docx");
См. также
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++
