Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

HeaderTextBuilder

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Source HeaderTextBuilder.cs:12
Modifiers sealed

Builder for header text segments and page tokens.

Inheritance

  • Object
  • HeaderTextBuilder

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

Methods

CurrentPage 2 overloads
public HeaderTextBuilder CurrentPage() #
HeaderTextBuilder.cs:29
Returns: HeaderTextBuilder

Adds a token that renders the current page number.

Returns

The same builder for chaining.

public HeaderTextBuilder CurrentPage(PdfTextRun style) #
HeaderTextBuilder.cs:37
Returns: HeaderTextBuilder

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

Parameters

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

Returns

The same builder for chaining.

DocumentPages 2 overloads
public HeaderTextBuilder DocumentPages() #
HeaderTextBuilder.cs:59
Returns: HeaderTextBuilder

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

Returns

The same builder for chaining.

public HeaderTextBuilder DocumentPages(PdfTextRun style) #
HeaderTextBuilder.cs:64
Returns: HeaderTextBuilder

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

Parameters

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

Returns

The same builder for chaining.

public HeaderTextBuilder Run(PdfTextRun run) #
HeaderTextBuilder.cs:21
Returns: HeaderTextBuilder

Adds a visually styled text run to the header.

Parameters

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

Returns

The same builder for chaining.

public HeaderTextBuilder Text(String s) #
HeaderTextBuilder.cs:12
Returns: HeaderTextBuilder

Adds a literal text segment to the header.

Parameters

s System.String requiredposition: 0
Text to render.

Returns

The same builder for chaining.

TotalPages 2 overloads
public HeaderTextBuilder TotalPages() #
HeaderTextBuilder.cs:45
Returns: HeaderTextBuilder

Adds a token that renders the total number of pages.

Returns

The same builder for chaining.

public HeaderTextBuilder TotalPages(PdfTextRun style) #
HeaderTextBuilder.cs:53
Returns: HeaderTextBuilder

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

Parameters

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

Returns

The same builder for chaining.