Класс Aspose::Words::Fields::FieldNumPages
Содержание
[
Скрывать
]FieldNumPages class
Реализует поле NUMPAGES. Чтобы узнать больше, посетите статью документации Working with Fields.
class FieldNumPages : 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. |
| 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. |
| static Type() | |
| Unlink() | Выполняет отсоединение поля. |
| Update() | Выполняет обновление поля. Вызывает исключение, если поле уже обновляется. |
| Update(bool) | Выполняет обновление поля. Выбрасывает исключение, если поле уже обновляется. |
Примеры
Показывает, как использовать поля NUMCHARS, NUMWORDS, NUMPAGES и PAGE для отслеживания размера наших документов.
auto doc = System::MakeObject<Aspose::Words::Document>(get_MyDir() + u"Paragraphs.docx");
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);
builder->MoveToHeaderFooter(Aspose::Words::HeaderFooterType::FooterPrimary);
builder->get_ParagraphFormat()->set_Alignment(Aspose::Words::ParagraphAlignment::Center);
// Ниже представлены три типа полей, которые мы можем использовать для отслеживания размера наших документов.
// 1 - Отслеживайте количество символов с помощью поля NUMCHARS:
auto fieldNumChars = System::ExplicitCast<Aspose::Words::Fields::FieldNumChars>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldNumChars, true));
builder->Writeln(u" characters");
// 2 - Отслеживайте количество слов с помощью поля NUMWORDS:
auto fieldNumWords = System::ExplicitCast<Aspose::Words::Fields::FieldNumWords>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldNumWords, true));
builder->Writeln(u" words");
// 3 - Используйте поля PAGE и NUMPAGES вместе, чтобы отобразить, на какой странице находится поле,
// и общее количество страниц в документе:
builder->get_ParagraphFormat()->set_Alignment(Aspose::Words::ParagraphAlignment::Right);
builder->Write(u"Page ");
auto fieldPage = System::ExplicitCast<Aspose::Words::Fields::FieldPage>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldPage, true));
builder->Write(u" of ");
auto fieldNumPages = System::ExplicitCast<Aspose::Words::Fields::FieldNumPages>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldNumPages, true));
ASSERT_EQ(u" NUMCHARS ", fieldNumChars->GetFieldCode());
ASSERT_EQ(u" NUMWORDS ", fieldNumWords->GetFieldCode());
ASSERT_EQ(u" NUMPAGES ", fieldNumPages->GetFieldCode());
ASSERT_EQ(u" PAGE ", fieldPage->GetFieldCode());
// Эти поля не будут поддерживать точные значения в реальном времени
// пока мы редактируем документ программно с помощью Aspose.Words или в Microsoft Word.
// Нам нужно обновлять их каждый раз, когда требуется увидеть актуальное значение.
doc->UpdateFields();
doc->Save(get_ArtifactsDir() + u"Field.NUMCHARS.NUMWORDS.NUMPAGES.PAGE.docx");
См. также
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++