RenderDocumentToFile
Rendering and printing
Description
Renders certain pages from the selected document to an image file on disk.
By default rendering uses the GDI+ system which is available by default in Windows XP and later. Option 10, TIFF (G4) output, is only available on Windows Vista and Windows Server 2008 and later.
It is also possible to render using Cairo, use the SetCairoFileName and SelectRenderer functions.
Syntax
Delphi
function TPDFlib.RenderDocumentToFile(DPI: Double; StartPage, EndPage, Options: Integer; Const FileName: WideString): Integer;ActiveX
Function PDFlib::RenderDocumentToFile(DPI As Double, StartPage As Long, EndPage As Long, Options As Long, FileName As String) As LongDLL
int DLRenderDocumentToFile(int InstanceID, double DPI, int StartPage, int EndPage, int Options, wchar_t * FileName);Parameters
| DPI | The DPI to use for the rendering. A value of 72 will give the same result as Acrobat when the zoom level is 100%. |
|---|---|
| StartPage | The first page to print |
| EndPage | The last page to print |
| Options | 0 = BMP output 1 = JPEG output 2 = WMF output 3 = EMF output 4 = EPS output 5 = PNG output 6 = GIF output 7 = TIFF output 8 = EMF+ output 9 = HTML5 output 10 = G4 TIFF output The path and filename to use for the file. Each page will be stored in a separate file. If this parameter contains "%p" this will be replaced by the page number, otherwise the page number will be appended to the end of the filename before the extension. For example, if FileName is "output.jpg" and page 10 is rendered the image will be stored in a file called "output10.jpg". If FileName is "page%poutput.bmp" and page 5 is rendered the image will be stored in a file called "page5output.bmp". |
| FileName |
Return values
| 0 | The pages were not rendered successfully. This is usually caused by the StartPage or EndPage parameters being out of range. |
|---|---|
| 1 | The pages were rendered successfully |