Get Started

API Reference

Class

FooterSegment

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Options/FooterSegment.cs:14
Modifiers sealed

A segment of header or footer content, either literal text, styled text, or a page token.

Inheritance

  • Object
  • FooterSegment

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

Constructors

public FooterSegment(FooterSegmentKind kind, String text = null) #
OfficeIMO.Pdf/Options/FooterSegment.cs:14

Creates a new footer segment.

Parameters

kind OfficeIMO.Pdf.FooterSegmentKind requiredposition: 0
text System.String = null optionalposition: 1

Methods

public static FooterSegment PageNumber(TextRun style) #
OfficeIMO.Pdf/Options/FooterSegment.cs:46
Returns: FooterSegment

Creates a current-page token using the supplied visual text style.

Parameters

style OfficeIMO.Pdf.TextRun requiredposition: 0
Text run whose visual styling is applied; its text is ignored.
public static FooterSegment RichText(TextRun run) #
OfficeIMO.Pdf/Options/FooterSegment.cs:39
Returns: FooterSegment

Creates a styled literal text segment.

Parameters

run OfficeIMO.Pdf.TextRun requiredposition: 0
Visual text run to render.
public static FooterSegment TotalPages(TextRun style) #
OfficeIMO.Pdf/Options/FooterSegment.cs:53
Returns: FooterSegment

Creates a total-pages token using the supplied visual text style.

Parameters

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

Properties

public FooterSegmentKind Kind { get; } #
OfficeIMO.Pdf/Options/FooterSegment.cs:6

Segment kind (text or token).

public String Text { get; } #
OfficeIMO.Pdf/Options/FooterSegment.cs:8

Literal text used when Kind is Text.

public TextRun StyledRun { get; } #
OfficeIMO.Pdf/Options/FooterSegment.cs:11

Optional visual styling for this segment.