Get Started

API Reference

Class

HeaderTextBuilder

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Compose/HeaderTextBuilder.cs:12

Builder for header text segments and page tokens.

Inheritance

  • Object
  • HeaderTextBuilder

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

Accepted by parameters

Methods

CurrentPage 2 overloads
public HeaderTextBuilder CurrentPage() #
OfficeIMO.Pdf/Compose/HeaderTextBuilder.cs:29
Returns: HeaderTextBuilder

Adds a token that renders the current page number.

Returns

The same builder for chaining.

public HeaderTextBuilder CurrentPage(TextRun style) #
OfficeIMO.Pdf/Compose/HeaderTextBuilder.cs:37
Returns: HeaderTextBuilder

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

Parameters

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

Returns

The same builder for chaining.

public HeaderTextBuilder Run(TextRun run) #
OfficeIMO.Pdf/Compose/HeaderTextBuilder.cs:21
Returns: HeaderTextBuilder

Adds a visually styled text run to the header.

Parameters

run OfficeIMO.Pdf.TextRun 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) #
OfficeIMO.Pdf/Compose/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() #
OfficeIMO.Pdf/Compose/HeaderTextBuilder.cs:45
Returns: HeaderTextBuilder

Adds a token that renders the total number of pages.

Returns

The same builder for chaining.

public HeaderTextBuilder TotalPages(TextRun style) #
OfficeIMO.Pdf/Compose/HeaderTextBuilder.cs:53
Returns: HeaderTextBuilder

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

Parameters

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

Returns

The same builder for chaining.