API Reference
Class
FooterSegment
A segment of header or footer content, either literal text, styled text, or a page token.
Inheritance
- Object
- FooterSegment
Usage
Explore 7 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 7
- Method FooterSegment.DocumentPages
- Method FooterSegment.PageNumber
- Method FooterSegment.RichText
- Method FooterSegment.TotalPages
- Property PdfOptions.EvenPageFooterSegments
- Property PdfOptions.FirstPageFooterSegments
- Property PdfOptions.FooterSegments
Constructors
Methods
public static FooterSegment DocumentPages(PdfTextRun style) #Returns:
FooterSegmentCreates a document-wide page-count token using the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.PdfTextRun
- Text run whose visual styling is applied; its text is ignored.
public static FooterSegment PageNumber(PdfTextRun style) #Returns:
FooterSegmentCreates a current-page token using the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.PdfTextRun
- Text run whose visual styling is applied; its text is ignored.
public static FooterSegment RichText(PdfTextRun run) #Returns:
FooterSegmentCreates a styled literal text segment.
Parameters
- run OfficeIMO.Pdf.PdfTextRun
- Visual text run to render.
public static FooterSegment TotalPages(PdfTextRun style) #Returns:
FooterSegmentCreates a total-pages token using the supplied visual text style.
Parameters
- style OfficeIMO.Pdf.PdfTextRun
- Text run whose visual styling is applied; its text is ignored.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String? Text { get; } #Literal text used when FooterSegment.Kind is FooterSegmentKind.Text.