Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfFooterTextBuilder

OfficeIMO.Pdf

Namespace
OfficeIMO.Pdf
Assembly
OfficeIMO.Pdf
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

Builder for footer text segments and tokens.

Inheritance

  • object
  • PdfFooterTextBuilder

Usage

Explore 17 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 12

Methods

CurrentPage 2 overloads
public PdfFooterTextBuilder CurrentPage() #

Adds a token that renders the current page number.

Returns

PdfFooterTextBuilder The same builder for chaining.
public PdfFooterTextBuilder CurrentPage(PdfTextRun style) #

Adds a current-page token with the supplied visual text style.

Parameters

style OfficeIMO.Pdf.PdfTextRun required
Text run whose visual styling is applied; its text is ignored.

Returns

PdfFooterTextBuilder The same builder for chaining.
DocumentPages 2 overloads
public PdfFooterTextBuilder DocumentPages() #

Adds the page count of the complete document, including all sections.

Returns

PdfFooterTextBuilder The same builder for chaining.
public PdfFooterTextBuilder DocumentPages(PdfTextRun style) #

Adds a document-wide page-count token with the supplied visual text style.

Parameters

style OfficeIMO.Pdf.PdfTextRun required
Text run whose visual styling is applied; its text is ignored.

Returns

PdfFooterTextBuilder The same builder for chaining.
public PdfFooterTextBuilder Run(PdfTextRun run) #

Adds a visually styled text run to the footer.

Parameters

run OfficeIMO.Pdf.PdfTextRun required
Styled text to render. Interactive links, inline visuals, and paragraph tabs are not supported.

Returns

PdfFooterTextBuilder The same builder for chaining.
public PdfFooterTextBuilder Text(string s) #

Adds a literal text segment to the footer.

Parameters

s string required
Text to render.

Returns

PdfFooterTextBuilder The same builder for chaining.
TotalPages 2 overloads
public PdfFooterTextBuilder TotalPages() #

Adds a token that renders the total number of pages.

Returns

PdfFooterTextBuilder The same builder for chaining.
public PdfFooterTextBuilder TotalPages(PdfTextRun style) #

Adds a total-pages token with the supplied visual text style.

Parameters

style OfficeIMO.Pdf.PdfTextRun required
Text run whose visual styling is applied; its text is ignored.

Returns

PdfFooterTextBuilder The same builder for chaining.