Aspose::Words::Fields::FieldSectionPages class

FieldSectionPages class

Implements the SECTIONPAGES field. To learn more, visit the Working with Fields documentation article.

class FieldSectionPages : public Aspose::Words::Fields::Field

Methods

Method	Description
get_DisplayResult()	Gets the text that represents the displayed field result.
get_End() const	Gets the node that represents the field end.
get_FieldEnd() const	Gets the node that represents the field end.
get_FieldStart() const	Gets the node that represents the start of the field.
get_Format()	Gets a FieldFormat object that provides typed access to field’s formatting.
get_IsDirty()	Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsLocked()	Gets or sets whether the field is locked (should not recalculate its result).
get_LocaleId()	Gets or sets the LCID of the field.
get_Result()	Gets or sets text that is between the field separator and field end.
get_Separator()	Gets the node that represents the field separator. Can be null.
get_Start() const	Gets the node that represents the start of the field.
virtual get_Type() const	Gets the Microsoft Word field type.
GetFieldCode()	Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
GetFieldCode(bool)	Returns text between field start and field separator (or field end if there is no separator).
GetType() const override
Is(const System::TypeInfo&) const override
Remove()	Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
set_IsDirty(bool)	Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
set_IsLocked(bool)	Setter for Aspose::Words::Fields::Field::get_IsLocked.
set_LocaleId(int32_t)	Setter for Aspose::Words::Fields::Field::get_LocaleId.
set_Result(const System::String&)	Setter for Aspose::Words::Fields::Field::get_Result.
static Type()
Unlink()	Performs the field unlink.
Update()	Performs the field update. Throws if the field is being updated already.
Update(bool)	Performs a field update. Throws if the field is being updated already.

Examples

Shows how to use SECTION and SECTIONPAGES fields to number pages by sections.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);

builder->MoveToHeaderFooter(HeaderFooterType::HeaderPrimary);
builder->get_ParagraphFormat()->set_Alignment(ParagraphAlignment::Right);

// A SECTION field displays the number of the section it is in.
builder->Write(u"Section ");
auto fieldSection = System::ExplicitCast<FieldSection>(builder->InsertField(FieldType::FieldSection, true));

ASSERT_EQ(u" SECTION ", fieldSection->GetFieldCode());

// A PAGE field displays the number of the page it is in.
builder->Write(u"\nPage ");
auto fieldPage = System::ExplicitCast<FieldPage>(builder->InsertField(FieldType::FieldPage, true));

ASSERT_EQ(u" PAGE ", fieldPage->GetFieldCode());

// A SECTIONPAGES field displays the number of pages that the section it is in spans across.
builder->Write(u" of ");
auto fieldSectionPages = System::ExplicitCast<FieldSectionPages>(builder->InsertField(FieldType::FieldSectionPages, true));

ASSERT_EQ(u" SECTIONPAGES ", fieldSectionPages->GetFieldCode());

// Move out of the header back into the main document and insert two pages.
// All these pages will be in the first section. Our fields, which appear once every header,
// will number the current/total pages of this section.
builder->MoveToDocumentEnd();
builder->InsertBreak(BreakType::PageBreak);
builder->InsertBreak(BreakType::PageBreak);

// We can insert a new section with the document builder like this.
// This will affect the values displayed in the SECTION and SECTIONPAGES fields in all upcoming headers.
builder->InsertBreak(BreakType::SectionBreakNewPage);

// The PAGE field will keep counting pages across the whole document.
// We can manually reset its count at each section to keep track of pages section-by-section.
builder->get_CurrentSection()->get_PageSetup()->set_RestartPageNumbering(true);
builder->InsertBreak(BreakType::PageBreak);

doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.SECTION.SECTIONPAGES.docx");

Aspose::Words::Fields::FieldSectionPages class

FieldSectionPages class

Methods

Examples

See Also