Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfFooterSegment

OfficeIMO.Pdf

Namespace
OfficeIMO.Pdf
Assembly
OfficeIMO.Pdf
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

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

Inheritance

  • object
  • PdfFooterSegment

Usage

Explore 9 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.

Accepted by parameters 4

Constructors

public PdfFooterSegment(PdfFooterSegmentKind kind, string? text = null) #

Creates a new footer segment.

Parameters

kind OfficeIMO.Pdf.PdfFooterSegmentKind required
text string? = null optional

Methods

public static PdfFooterSegment DocumentPages(PdfTextRun style) #

Creates a document-wide page-count token using the supplied visual text style.

Parameters

style OfficeIMO.Pdf.PdfTextRun required
Text run whose visual styling is applied; its text is ignored.
public static PdfFooterSegment PageNumber(PdfTextRun style) #

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

Parameters

style OfficeIMO.Pdf.PdfTextRun required
Text run whose visual styling is applied; its text is ignored.
public static PdfFooterSegment RichText(PdfTextRun run) #

Creates a styled literal text segment.

Parameters

run OfficeIMO.Pdf.PdfTextRun required
Visual text run to render.
public static PdfFooterSegment TotalPages(PdfTextRun style) #

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

Parameters

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

Properties

public PdfFooterSegmentKind Kind { get; } #

Segment kind (text or token).

public string? Text { get; } #

Literal text used when PdfFooterSegment.Kind is PdfFooterSegmentKind.Text.

public PdfTextRun? StyledRun { get; } #

Optional visual styling for this segment.