API Reference
Class
FooterTextBuilder
Builder for footer text segments and tokens.
Inheritance
- Object
- FooterTextBuilder
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method FooterTextBuilder.CurrentPage
- Method FooterTextBuilder.CurrentPage
- Method FooterTextBuilder.Run
- Method FooterTextBuilder.Text
- Method FooterTextBuilder.TotalPages
- Method FooterTextBuilder.TotalPages
Accepted by parameters
- Method PdfFooterCompose.EvenPagesText
- Method PdfFooterCompose.FirstPageText
- Method PdfFooterCompose.Text
Methods
CurrentPage 2 overloads
public FooterTextBuilder CurrentPage() #Returns:
FooterTextBuilderAdds a token that renders the current page number.
Returns
The same builder for chaining.
public FooterTextBuilder CurrentPage(TextRun style) #Returns:
FooterTextBuilderAdds a current-page token with the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.TextRun
- Text run whose visual styling is applied; its text is ignored.
Returns
The same builder for chaining.
public FooterTextBuilder Run(TextRun run) #Returns:
FooterTextBuilderAdds a visually styled text run to the footer.
Parameters
- run OfficeIMO.Pdf.TextRun
- Styled text to render. Interactive links, inline visuals, and paragraph tabs are not supported.
Returns
The same builder for chaining.
public FooterTextBuilder Text(String s) #Returns:
FooterTextBuilderAdds a literal text segment to the footer.
Parameters
- s System.String
- Text to render.
Returns
The same builder for chaining.
TotalPages 2 overloads
public FooterTextBuilder TotalPages() #Returns:
FooterTextBuilderAdds a token that renders the total number of pages.
Returns
The same builder for chaining.
public FooterTextBuilder TotalPages(TextRun style) #Returns:
FooterTextBuilderAdds a total-pages token with the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.TextRun
- Text run whose visual styling is applied; its text is ignored.
Returns
The same builder for chaining.