Aspose::Words::ParagraphFormat::get_PageBreakBefore method

ParagraphFormat::get_PageBreakBefore method

True if a page break is forced before the paragraph.

bool Aspose::Words::ParagraphFormat::get_PageBreakBefore()

Examples

Shows how to create paragraphs with page breaks at the beginning.

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

// Set this flag to "true" to apply a page break to each paragraph's beginning
// that the document builder will create under this ParagraphFormat configuration.
// The first paragraph will not receive a page break.
// Leave this flag as "false" to start each new paragraph on the same page
// as the previous, provided there is sufficient space.
builder->get_ParagraphFormat()->set_PageBreakBefore(pageBreakBefore);

builder->Writeln(u"Paragraph 1.");
builder->Writeln(u"Paragraph 2.");

auto layoutCollector = MakeObject<LayoutCollector>(doc);
SharedPtr<ParagraphCollection> paragraphs = doc->get_FirstSection()->get_Body()->get_Paragraphs();

if (pageBreakBefore)
{
    ASSERT_EQ(1, layoutCollector->GetStartPageIndex(paragraphs->idx_get(0)));
    ASSERT_EQ(2, layoutCollector->GetStartPageIndex(paragraphs->idx_get(1)));
}
else
{
    ASSERT_EQ(1, layoutCollector->GetStartPageIndex(paragraphs->idx_get(0)));
    ASSERT_EQ(1, layoutCollector->GetStartPageIndex(paragraphs->idx_get(1)));
}

doc->Save(ArtifactsDir + u"ParagraphFormat.PageBreakBefore.docx");

See Also

Aspose::Words::ParagraphFormat::get_OutlineLevel method Aspose::Words::ParagraphFormat::get_RightIndent method