Sections, headers, and footers

A Section is a group of consecutive pages that share a page size, margins, and headers and footers. Every FlowDocument starts with one section, and content added directly to the document goes into the current (last) section.

Headers and footers

Headers and footers are content containers owned by a section. GetOrCreateHeader and GetOrCreateFooter return the existing one or create an empty one; the content of an existing header is preserved.

Section section = doc.GetCurrentSection();

ContentContainer header = section.GetOrCreateHeader(Section.PageGroup.e_odd_pages);
Paragraph headerPara = header.AddParagraph("SYH Supply Co.");
headerPara.SetJustificationMode(Paragraph.TextJustification.e_right);
headerPara.GetTextStyledElement().SetTextColor(120, 120, 120);

ContentContainer footer = section.GetOrCreateFooter(Section.PageGroup.e_odd_pages);
Paragraph footerPara = footer.AddParagraph();
footerPara.SetJustificationMode(Paragraph.TextJustification.e_center);

footerPara.AddText("Page ");
footerPara.AddPageNumber(PageNumber.NumberType.e_current_page);
footerPara.AddText(" of ");
footerPara.AddPageNumber(PageNumber.NumberType.e_total_pages);

Section section = doc.GetCurrentSection();

ContentContainer header = section.GetOrCreateHeader(Section::e_odd_pages);
Paragraph header_para = header.AddParagraph("SYH Supply Co.");
header_para.SetJustificationMode(Paragraph::e_text_justify_right);
header_para.GetTextStyledElement().SetTextColor(120, 120, 120);

ContentContainer footer = section.GetOrCreateFooter(Section::e_odd_pages);
Paragraph footer_para = footer.AddParagraph();
footer_para.SetJustificationMode(Paragraph::e_text_justify_center);

footer_para.AddText("Page ");
footer_para.AddPageNumber(PageNumber::e_current_page);
footer_para.AddText(" of ");
footer_para.AddPageNumber(PageNumber::e_total_pages);

section := doc.GetCurrentSection()

header := section.GetOrCreateHeader(SectionE_odd_pages)
headerPara := header.AddParagraph("SYH Supply Co.")
headerPara.SetJustificationMode(ParagraphE_text_justify_right)
headerPara.GetTextStyledElement().SetTextColor(120, 120, 120)

footer := section.GetOrCreateFooter(SectionE_odd_pages)
footerPara := footer.AddParagraph()
footerPara.SetJustificationMode(ParagraphE_text_justify_center)

footerPara.AddText("Page ")
footerPara.AddPageNumber(PageNumberE_current_page)
footerPara.AddText(" of ")
footerPara.AddPageNumber(PageNumberE_total_pages)

Section section = doc.getCurrentSection();

ContentContainer header = section.getOrCreateHeader(Section.PageGroup.e_odd_pages);
Paragraph headerPara = header.addParagraph("SYH Supply Co.");
headerPara.setJustificationMode(Paragraph.TextJustification.e_text_justify_right);
headerPara.getTextStyledElement().setTextColor(120, 120, 120);

ContentContainer footer = section.getOrCreateFooter(Section.PageGroup.e_odd_pages);
Paragraph footerPara = footer.addParagraph();
footerPara.setJustificationMode(Paragraph.TextJustification.e_text_justify_center);

footerPara.addText("Page ");
footerPara.addPageNumber(PageNumber.NumberType.e_current_page);
footerPara.addText(" of ");
footerPara.addPageNumber(PageNumber.NumberType.e_total_pages);

const section = await doc.getCurrentSection();

const header = await section.getOrCreateHeader(PDFNet.Section.PageGroup.e_odd_pages);
const headerPara = await header.addParagraphWithText('SYH Supply Co.');
headerPara.setJustificationMode(PDFNet.Paragraph.TextJustification.e_text_justify_right);
(await headerPara.getTextStyledElement()).setTextColor(120, 120, 120);

const footer = await section.getOrCreateFooter(PDFNet.Section.PageGroup.e_odd_pages);
const footerPara = await footer.addParagraph();
footerPara.setJustificationMode(PDFNet.Paragraph.TextJustification.e_text_justify_center);

await footerPara.addText('Page ');
await footerPara.addPageNumber(PDFNet.PageNumber.NumberType.e_current_page);
await footerPara.addText(' of ');
await footerPara.addPageNumber(PDFNet.PageNumber.NumberType.e_total_pages);

PTSection* section = [doc GetCurrentSection];

PTContentContainer* header = [section GetOrCreateHeader:e_ptsection_odd_pages];
PTParagraph* header_para = [header AddParagraphWithText:@"SYH Supply Co."];
[header_para SetJustificationMode:e_ptpara_text_justify_right];
[[header_para GetTextStyledElement] SetTextColor:120 green:120 blue:120];

PTContentContainer* footer = [section GetOrCreateFooter:e_ptsection_odd_pages];
PTParagraph* footer_para = [footer AddParagraph];
[footer_para SetJustificationMode:e_ptpara_text_justify_center];

[footer_para AddText:@"Page "];
[footer_para AddPageNumber:e_ptpagenumber_current_page];
[footer_para AddText:@" of "];
[footer_para AddPageNumber:e_ptpagenumber_total_pages];

$section = $doc->GetCurrentSection();

$header = $section->GetOrCreateHeader(Section::e_odd_pages);
$header_para = $header->AddParagraph("SYH Supply Co.");
$header_para->SetJustificationMode(Paragraph::e_text_justify_right);
$header_para->GetTextStyledElement()->SetTextColor(120, 120, 120);

$footer = $section->GetOrCreateFooter(Section::e_odd_pages);
$footer_para = $footer->AddParagraph();
$footer_para->SetJustificationMode(Paragraph::e_text_justify_center);

$footer_para->AddText("Page ");
$footer_para->AddPageNumber(PageNumber::e_current_page);
$footer_para->AddText(" of ");
$footer_para->AddPageNumber(PageNumber::e_total_pages);

section = doc.GetCurrentSection()

header = section.GetOrCreateHeader(Section.e_odd_pages)
header_para = header.AddParagraph("SYH Supply Co.")
header_para.SetJustificationMode(Paragraph.e_text_justify_right)
header_para.GetTextStyledElement().SetTextColor(120, 120, 120)

footer = section.GetOrCreateFooter(Section.e_odd_pages)
footer_para = footer.AddParagraph()
footer_para.SetJustificationMode(Paragraph.e_text_justify_center)

footer_para.AddText("Page ")
footer_para.AddPageNumber(PageNumber.e_current_page)
footer_para.AddText(" of ")
footer_para.AddPageNumber(PageNumber.e_total_pages)

section = doc.GetCurrentSection()

header = section.GetOrCreateHeader(Section::E_odd_pages)
header_para = header.AddParagraph("SYH Supply Co.")
header_para.SetJustificationMode(Paragraph::E_text_justify_right)
header_para.GetTextStyledElement().SetTextColor(120, 120, 120)

footer = section.GetOrCreateFooter(Section::E_odd_pages)
footer_para = footer.AddParagraph()
footer_para.SetJustificationMode(Paragraph::E_text_justify_center)

footer_para.AddText("Page ")
footer_para.AddPageNumber(PageNumber::E_current_page)
footer_para.AddText(" of ")
footer_para.AddPageNumber(PageNumber::E_total_pages)

Example of a section with page numbering, body text, and company name

Page groups

Each header and footer applies to one group of pages, so a section can have up to three of each.

Page group values include:

Value

Applies to

e_first_page

The first page of the section.

e_even_pages

Even numbered pages.

e_odd_pages

Odd numbered pages.

To use the same footer everywhere, create one for each group.

Section.PageGroup[] groups = {
    Section.PageGroup.e_first_page,
    Section.PageGroup.e_even_pages,
    Section.PageGroup.e_odd_pages };

foreach (Section.PageGroup group in groups)
{
    Paragraph para = section.GetOrCreateFooter(group).AddParagraph();
    para.SetJustificationMode(Paragraph.TextJustification.e_center);
    para.AddPageNumber(PageNumber.NumberType.e_current_page);
}

Section::PageGroup const groups[] = {
    Section::e_first_page, Section::e_even_pages, Section::e_odd_pages };

for (int i = 0; i < 3; ++i)
{
    Paragraph para = section.GetOrCreateFooter(groups[i]).AddParagraph();
    para.SetJustificationMode(Paragraph::e_text_justify_center);
    para.AddPageNumber(PageNumber::e_current_page);
}

groups := []int{SectionE_first_page, SectionE_even_pages, SectionE_odd_pages}

for _, group := range groups {
    para := section.GetOrCreateFooter(group).AddParagraph()
    para.SetJustificationMode(ParagraphE_text_justify_center)
    para.AddPageNumber(PageNumberE_current_page)
}

Section.PageGroup[] groups = {
        Section.PageGroup.e_first_page,
        Section.PageGroup.e_even_pages,
        Section.PageGroup.e_odd_pages };

for (Section.PageGroup group : groups) {
    Paragraph para = section.getOrCreateFooter(group).addParagraph();
    para.setJustificationMode(Paragraph.TextJustification.e_text_justify_center);
    para.addPageNumber(PageNumber.NumberType.e_current_page);
}

const groups = [
    PDFNet.Section.PageGroup.e_first_page,
    PDFNet.Section.PageGroup.e_even_pages,
    PDFNet.Section.PageGroup.e_odd_pages];

for (const group of groups) {
    const para = await (await section.getOrCreateFooter(group)).addParagraph();
    para.setJustificationMode(PDFNet.Paragraph.TextJustification.e_text_justify_center);
    await para.addPageNumber(PDFNet.PageNumber.NumberType.e_current_page);
}

PTPageGroup groups[] = {
    e_ptsection_first_page, e_ptsection_even_pages, e_ptsection_odd_pages };

for (int i = 0; i < 3; ++i)
{
    PTParagraph* para = [[section GetOrCreateFooter:groups[i]] AddParagraph];
    [para SetJustificationMode:e_ptpara_text_justify_center];
    [para AddPageNumber:e_ptpagenumber_current_page];
}

$groups = array(Section::e_first_page, Section::e_even_pages, Section::e_odd_pages);

foreach ($groups as $group) {
    $para = $section->GetOrCreateFooter($group)->AddParagraph();
    $para->SetJustificationMode(Paragraph::e_text_justify_center);
    $para->AddPageNumber(PageNumber::e_current_page);
}

groups = [Section.e_first_page, Section.e_even_pages, Section.e_odd_pages]

for group in groups:
    para = section.GetOrCreateFooter(group).AddParagraph()
    para.SetJustificationMode(Paragraph.e_text_justify_center)
    para.AddPageNumber(PageNumber.e_current_page)

groups = [Section::E_first_page, Section::E_even_pages, Section::E_odd_pages]

groups.each do |group|
  para = section.GetOrCreateFooter(group).AddParagraph()
  para.SetJustificationMode(Paragraph::E_text_justify_center)
  para.AddPageNumber(PageNumber::E_current_page)
end

The first-page group is how you suppress a header on a title page: create an empty header for it and a populated one for the even and odd groups. Use RemoveHeader or RemoveFooter to drop one entirely.

Page numbers

AddPageNumber inserts a dynamic field that is resolved during pagination, so counts stay correct when content shifts. Use the current-page type for the page itself and the total-pages type for the document total.

SetNumberFormat changes the numbering system - lower roman for front matter, for example. A large set of formats is supported, including:

e_upper_roman
e_lower_letter
e_upper_letter
e_ordinal
e_cardinal_text
e_decimal_zero
e_arabic_alpha
e_japanese_counting
e_korean_counting
e_hebrew_1
e_hindi_numbers
e_russian_lower

PageNumber number = para.AddPageNumber(PageNumber.NumberType.e_current_page);
number.SetNumberFormat(PageNumber.NumberFormat.e_lower_roman);

PageNumber number = para.AddPageNumber(PageNumber::e_current_page);
number.SetNumberFormat(PageNumber::e_lower_roman);

number := para.AddPageNumber(PageNumberE_current_page)
number.SetNumberFormat(PageNumberE_lower_roman)

PageNumber number = para.addPageNumber(PageNumber.NumberType.e_current_page);
number.setNumberFormat(PageNumber.NumberFormat.e_lower_roman);

const number = await para.addPageNumber(PDFNet.PageNumber.NumberType.e_current_page);
number.setNumberFormat(PDFNet.PageNumber.NumberFormat.e_lower_roman);

PTPageNumber* number = [para AddPageNumber:e_ptpagenumber_current_page];
[number SetNumberFormat:e_ptpagenumber_lower_roman];

$number = $para->AddPageNumber(PageNumber::e_current_page);
$number->SetNumberFormat(PageNumber::e_lower_roman);

number = para.AddPageNumber(PageNumber.e_current_page)
number.SetNumberFormat(PageNumber.e_lower_roman)

number = para.AddPageNumber(PageNumber::E_current_page)
number.SetNumberFormat(PageNumber::E_lower_roman)

Page numbers are not restricted to footers. They work in any paragraph, including cross-references in body text.

Multiple sections

AddSection appends a section and makes it current, so subsequent content goes into it. A section always starts on a new page, and can override the document defaults for page size and margins - which is how a landscape page is mixed into a portrait document.

FlowDocument doc = new FlowDocument();
doc.SetDefaultPageSize(300, 200);
doc.SetDefaultMargins(18, 18, 18, 18);

doc.AddParagraph("Section 1 uses the document default portrait page.");

// A new section starts on a new page and can override the page setup.
Section landscape = doc.AddSection();
landscape.SetPageSize(400, 200);
landscape.SetMargins(18, 18, 18, 18);

doc.AddParagraph("Section 2 overrides the page size and margins.");

FlowDocument doc;
doc.SetDefaultPageSize(300, 200);
doc.SetDefaultMargins(18, 18, 18, 18);

doc.AddParagraph("Section 1 uses the document default portrait page.");

// A new section starts on a new page and can override the page setup.
Section landscape = doc.AddSection();
landscape.SetPageSize(400, 200);
landscape.SetMargins(18, 18, 18, 18);

doc.AddParagraph("Section 2 overrides the page size and margins.");

doc := NewFlowDocument()
doc.SetDefaultPageSize(300, 200)
doc.SetDefaultMargins(18, 18, 18, 18)

doc.AddParagraph("Section 1 uses the document default portrait page.")

// A new section starts on a new page and can override the page setup.
landscape := doc.AddSection()
landscape.SetPageSize(400, 200)
landscape.SetMargins(18, 18, 18, 18)

doc.AddParagraph("Section 2 overrides the page size and margins.")

FlowDocument doc = new FlowDocument();
doc.setDefaultPageSize(300, 200);
doc.setDefaultMargins(18, 18, 18, 18);

doc.addParagraph("Section 1 uses the document default portrait page.");

// A new section starts on a new page and can override the page setup.
Section landscape = doc.addSection();
landscape.setPageSize(400, 200);
landscape.setMargins(18, 18, 18, 18);

doc.addParagraph("Section 2 overrides the page size and margins.");

const doc = await PDFNet.FlowDocument.create();
doc.setDefaultPageSize(300, 200);
doc.setDefaultMargins(18, 18, 18, 18);

await doc.addParagraphWithText('Section 1 uses the document default portrait page.');

// A new section starts on a new page and can override the page setup.
const landscape = await doc.addSection();
landscape.setPageSize(400, 200);
landscape.setMargins(18, 18, 18, 18);

await doc.addParagraphWithText('Section 2 overrides the page size and margins.');

PTFlowDocument* doc = [[PTFlowDocument alloc] init];
[doc SetDefaultPageSize:300 height:200];
[doc SetDefaultMargins:18 top:18 right:18 bottom:18];

[doc AddParagraphWithText:@"Section 1 uses the document default portrait page."];

// A new section starts on a new page and can override the page setup.
PTSection* landscape = [doc AddSection];
[landscape SetPageSize:400 height:200];
[landscape SetMargins:18 top:18 right:18 bottom:18];

[doc AddParagraphWithText:@"Section 2 overrides the page size and margins."];

$doc = new FlowDocument();
$doc->SetDefaultPageSize(300, 200);
$doc->SetDefaultMargins(18, 18, 18, 18);

$doc->AddParagraph("Section 1 uses the document default portrait page.");

// A new section starts on a new page and can override the page setup.
$landscape = $doc->AddSection();
$landscape->SetPageSize(400, 200);
$landscape->SetMargins(18, 18, 18, 18);

$doc->AddParagraph("Section 2 overrides the page size and margins.");

doc = FlowDocument()
doc.SetDefaultPageSize(300, 200)
doc.SetDefaultMargins(18, 18, 18, 18)

doc.AddParagraph("Section 1 uses the document default portrait page.")

# A new section starts on a new page and can override the page setup.
landscape = doc.AddSection()
landscape.SetPageSize(400, 200)
landscape.SetMargins(18, 18, 18, 18)

doc.AddParagraph("Section 2 overrides the page size and margins.")

doc = FlowDocument.new()
doc.SetDefaultPageSize(300, 200)
doc.SetDefaultMargins(18, 18, 18, 18)

doc.AddParagraph("Section 1 uses the document default portrait page.")

# A new section starts on a new page and can override the page setup.
landscape = doc.AddSection()
landscape.SetPageSize(400, 200)
landscape.SetMargins(18, 18, 18, 18)

doc.AddParagraph("Section 2 overrides the page size and margins.")

Section settings cascade. A section only overrides the document defaults where you explicitly set a page size or margins. Headers and footers are not inherited; each section defines its own.

You can also add content to a section directly rather than through the document, which is clearer when maintaining several sections.

Headers and footers

Page groups

Page numbers

Multiple sections

Further Reading