Class
PdfHeaderTextBuilder
OfficeIMO.Pdf
Builder for header text segments and page tokens.
Inheritance
- object
- PdfHeaderTextBuilder
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.
Returned or exposed by 5
Accepted by parameters 12
- Method PdfHeaderBuilder.EvenPagesStyledZones
- Method PdfHeaderBuilder.EvenPagesStyledZones
- Method PdfHeaderBuilder.EvenPagesStyledZones
- Method PdfHeaderBuilder.EvenPagesText
- Method PdfHeaderBuilder.FirstPageStyledZones
- Method PdfHeaderBuilder.FirstPageStyledZones
- Method PdfHeaderBuilder.FirstPageStyledZones
- Method PdfHeaderBuilder.FirstPageText
- Method PdfHeaderBuilder.StyledZones
- Method PdfHeaderBuilder.StyledZones
- Method PdfHeaderBuilder.StyledZones
- Method PdfHeaderBuilder.Text
Methods
CurrentPage 2 overloads
public PdfHeaderTextBuilder CurrentPage() #Adds a token that renders the current page number.
public PdfHeaderTextBuilder CurrentPage(PdfTextRun style) #Adds a current-page token with the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.PdfTextRun
- Text run whose visual styling is applied; its text is ignored.
DocumentPages 2 overloads
public PdfHeaderTextBuilder DocumentPages() #Adds the page count of the complete document, including all sections.
public PdfHeaderTextBuilder DocumentPages(PdfTextRun style) #Adds a document-wide page-count token with the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.PdfTextRun
- Text run whose visual styling is applied; its text is ignored.
public PdfHeaderTextBuilder Run(PdfTextRun run) #Adds a visually styled text run to the header.
Parameters
- run OfficeIMO.Pdf.PdfTextRun
- Styled text to render. Interactive links, inline visuals, and paragraph tabs are not supported.
public PdfHeaderTextBuilder Text(string s) #Adds a literal text segment to the header.
Parameters
- s string
- Text to render.
TotalPages 2 overloads
public PdfHeaderTextBuilder TotalPages() #Adds a token that renders the total number of pages.
public PdfHeaderTextBuilder TotalPages(PdfTextRun style) #Adds a total-pages token with the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.PdfTextRun
- Text run whose visual styling is applied; its text is ignored.