TDBGrid export support

The dbGridHotPDFExport add-on unit (Lib\addons\DBGrid) writes the visible columns and all rows of a TDBGrid dataset to a PDF table. It creates, fills and saves its own THotPDF document, so the grid is the only input it needs

Entry points

• DBGridHotPDFExportToFile(AGrid, AOutputFileName[, AOptions]) writes the PDF to a file
• DBGridHotPDFExportToStream(AGrid, AOutputStream[, AOptions]) writes it to a stream, through a temporary file in %TEMP%
• DBGridHotPDFDefaultOptions returns a TDBGridHotPDFExportOptions record with the defaults: A4 in points (595 x 842), 36-point margins, 22-point rows, a 24-point header row, Arial 9 with a 14-point title, a clBtnFace header and $00F5F5F5 alternate rows
• TDBGridHotPDFExport is the same export as a component on the HotPDF palette page (registered by dbGridHotPDFDesign): set Grid and OutputFileName, then call ExportToFile or ExportToStream. Each option field is a published property; ResetOptions restores the defaults

What is exported

• Visible grid columns with a field, in grid order, with their title captions, or the visible fields of the dataset when the grid has no columns; column widths keep the grid's proportions across the printable width
• Every record from First to Eof, using each field's DisplayText; a cell text that does not fit is cut and ends in ...
• All text uses FontName, which must have glyphs for the data: the default Arial shows Chinese, Japanese or Korean text as empty boxes, so set a CJK font such as Microsoft YaHei for such data
• A new page starts when the next row would cross the bottom margin, and the header row repeats on every page. The title (Title, else the grid's Name) is drawn once, on the first page, while IncludeTitle is True
• Title, Author, Subject, Keywords, PDFVersion (default pdf17), PDFACompliance, PDFXCompliance and Compression are passed to the document

Dataset state

• The export calls DisableControls while it walks the dataset and EnableControls afterwards, so bound controls do not repaint for each row
• The current record is saved as a bookmark first and restored at the end, also when the export fails
• A nil grid, an empty file name, a grid without a dataset, an inactive dataset or a grid without visible data columns raises an exception instead of returning False

Example

uses
  dbGridHotPDFExport;

var
  Options: TDBGridHotPDFExportOptions;
begin
  Options:= DBGridHotPDFDefaultOptions;
  Options.Title:= 'Customers';
  Options.PageWidth:= 842;   // A4 landscape
  Options.PageHeight:= 595;
  DBGridHotPDFExportToFile(DBGrid1, 'Customers.pdf', Options);
end;

Related APIs

• THotPDF Class
• THPDFPage Class
• HotPDF overview