Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfRunningContentContext

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Read-only page information used to compose bounded running header or footer content.

Inheritance

  • Object
  • PdfRunningContentContext

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

public String FormatPageNumber(Int32 number, Nullable<PdfPageNumberStyle> style = null) #
Returns: String

Formats a positive page count using the supplied style or this page's numbering style.

Parameters

number System.Int32 requiredposition: 0
style System.Nullable{OfficeIMO.Pdf.PdfPageNumberStyle} = null optionalposition: 1

Properties

public Int32 PageNumber { get; } #

Current visible page number, including an explicitly restarted numbering sequence.

public Int32 TotalPages { get; } #

Last visible page number in the current numbering sequence, matching the existing {pages} token.

public Int32 DocumentPageNumber { get; } #

Current one-based physical output page number.

public Int32 DocumentPages { get; } #

Total physical pages in the document.

public Int32 SectionPageNumber { get; } #

Current one-based physical page within its page group.

public Int32 SectionPages { get; } #

Physical page count in the current page group, independent of visible numbering and restarts.

public Double ContentWidth { get; } #

Width of the page's content frame in points, including mirrored margins.

public Double PageWidth { get; } #

Physical page width in points.

public Double PageHeight { get; } #

Physical page height in points.

public PdfPageNumberStyle PageNumberStyle { get; } #

Number style selected for this page's visible numbering sequence.