Table of Contents

TTMSFNCPDFLib Class

PDF document generation component; drop on a form to generate PDF files or streams.

API unit family: TMSFNCPDFLib Inherits from: TTMSFNCCustomPDFLib

Syntax

TTMSFNCPDFLib = class(TTMSFNCCustomPDFLib)

Properties

Name Description
ArtBox Art box defining the content area intended for display in points. (inherited from TTMSFNCCustomPDFLib)
Author Author metadata written into the PDF document information dictionary. (inherited from TTMSFNCCustomPDFLib)
BitmapContainer Bitmap container used as the source for named bitmaps drawn on PDF pages. (inherited from TTMSFNCCustomPDFLib)
BleedBox Bleed box defining the clip region for production bleed in points. (inherited from TTMSFNCCustomPDFLib)
Creator Creator metadata written into the PDF document information dictionary. (inherited from TTMSFNCCustomPDFLib)
CropBox Crop box defining the visible page region in a viewer, in points. (inherited from TTMSFNCCustomPDFLib)
EmbedFontType Controls which font data is embedded: full font program or subset. (inherited from TTMSFNCCustomPDFLib)
EmbedFonts When True, fonts used in the document are embedded in the PDF output. (inherited from TTMSFNCCustomPDFLib)
FontFallBackList Ordered list of fallback font names tried when a glyph is not available in the primary font. (inherited from TTMSFNCCustomPDFLib)
Footer Text drawn in the footer area of every page. (inherited from TTMSFNCCustomPDFLib)
FooterAlignment Horizontal alignment of the footer text. Default is gtaCenter. (inherited from TTMSFNCCustomPDFLib)
FooterFont Font used to render the footer text. (inherited from TTMSFNCCustomPDFLib)
FooterMargins Margins around the footer area in points. (inherited from TTMSFNCCustomPDFLib)
FooterSize Height of the footer strip in points. (inherited from TTMSFNCCustomPDFLib)
FormFields Provides access to interactive form fields (text boxes, combo boxes, list boxes, check boxes, radio buttons) on the current page. (inherited from TTMSFNCCustomPDFLib)
Header Text drawn in the header area of every page. (inherited from TTMSFNCCustomPDFLib)
HeaderAlignment Horizontal alignment of the header text. Default is gtaCenter. (inherited from TTMSFNCCustomPDFLib)
HeaderFont Font used to render the header text. (inherited from TTMSFNCCustomPDFLib)
HeaderMargins Margins around the header area in points. (inherited from TTMSFNCCustomPDFLib)
HeaderSize Height of the header strip in points. (inherited from TTMSFNCCustomPDFLib)
Keywords Keywords metadata written into the PDF document information dictionary. (inherited from TTMSFNCCustomPDFLib)
MediaBox Media box defining the full page extent in points. (inherited from TTMSFNCCustomPDFLib)
PageHeight Page height in points; effective only when PageSize is psCustom. (inherited from TTMSFNCCustomPDFLib)
PageNumber Controls automatic page numbering placement. Default is pnNone. (inherited from TTMSFNCCustomPDFLib)
PageNumberAlignment Horizontal alignment of the automatic page number text. Default is gtaCenter. (inherited from TTMSFNCCustomPDFLib)
PageNumberFont Font used to render the automatic page number text. (inherited from TTMSFNCCustomPDFLib)
PageNumberFormat Format string for the automatic page number. Use placeholders supported by the underlying PDF engine (e.g. %d for the page index). (inherited from TTMSFNCCustomPDFLib)
PageNumberMargins Margins around the page-number area in points. (inherited from TTMSFNCCustomPDFLib)
PageNumberSize Height of the page-number strip in points. (inherited from TTMSFNCCustomPDFLib)
PageOrientation Page orientation. Default is poPortrait. (inherited from TTMSFNCCustomPDFLib)
PageSize Standard page size preset. Default is psLetter. Set to psCustom and assign PageWidth/PageHeight for a non-standard size. (inherited from TTMSFNCCustomPDFLib)
PageWidth Page width in points; effective only when PageSize is psCustom. (inherited from TTMSFNCCustomPDFLib)
Subject Subject metadata written into the PDF document information dictionary. (inherited from TTMSFNCCustomPDFLib)
Title Title metadata written into the PDF document information dictionary. (inherited from TTMSFNCCustomPDFLib)
TrimBox Trim box indicating the intended finished page size in points. (inherited from TTMSFNCCustomPDFLib)
Version Returns the component version string. (inherited from TTMSFNCCustomPDFLib)

Methods

Name Description
BeginDocument Starts a new PDF document, optionally writing output directly to a file. (inherited from TTMSFNCCustomPDFLib)
EndDocument Finalises the document and returns its content as a memory stream. (inherited from TTMSFNCCustomPDFLib)
GetFooterRect Returns the bounding rectangle of the footer area on the current page, in points. (inherited from TTMSFNCCustomPDFLib)
GetHeaderRect Returns the bounding rectangle of the header area on the current page, in points. (inherited from TTMSFNCCustomPDFLib)
GetPageCount Returns the total number of pages added to the document so far. (inherited from TTMSFNCCustomPDFLib)
GetPageIndex Returns the zero-based index of the currently active page. (inherited from TTMSFNCCustomPDFLib)
GetPageNumberRect Returns the bounding rectangle of the automatic page-number area on the current page, in points. (inherited from TTMSFNCCustomPDFLib)
Graphics Returns the graphics interface for drawing on the current page. (inherited from TTMSFNCCustomPDFLib)
NewPage Appends a new blank page to the document and makes it the current drawing target. (inherited from TTMSFNCCustomPDFLib)

Events

Name Description
OnAfterDrawFooter Fires after the footer has been drawn on a page; allows overlay drawing. (inherited from TTMSFNCCustomPDFLib)
OnAfterDrawHeader Fires after the header has been drawn on a page; allows overlay drawing. (inherited from TTMSFNCCustomPDFLib)
OnAfterDrawPageNumber Fires after the automatic page number has been drawn; allows overlay drawing. (inherited from TTMSFNCCustomPDFLib)
OnBeforeDrawFooter Fires before the footer is drawn on a page; allows custom rendering or suppression. (inherited from TTMSFNCCustomPDFLib)
OnBeforeDrawHeader Fires before the header is drawn on a page; allows custom rendering or suppression. (inherited from TTMSFNCCustomPDFLib)
OnBeforeDrawPageNumber Fires before the automatic page number is drawn; allows custom rendering or suppression. (inherited from TTMSFNCCustomPDFLib)
OnNewPageStarted Fires when a new page is started via NewPage. (inherited from TTMSFNCCustomPDFLib)

Used by