The PDFHandler type exposes the following members.
Constructors
Name | Description | |
---|---|---|
PDFHandler | Overloaded. |
Methods
Name | Description | |
---|---|---|
AsyncBatchStart | In comparison to SyncBatch(String, array<String>[]()[], array<String>[]()[], Boolean, Boolean, PDFHandler..::.BatchOutputType), this method returns after setting up the batch run and does not block until the batch has finished. Creates a batch output file. The input XML files (one for each record) are given as a string array with the file names. It is possible to create a single output file. In this case, the array output names must contain only one file name. It is also possible to create one output file for each record, in which case you can either specify as many output file names as there are record files, or specify just one file name, the rest will be computed with an increasing number automatically. Furthermore, it is possible to output only the variable content (any static PDF background gets removed) or create a PPML + PDF file comination for optimized printing (this is only possible for single file output though). | |
AsyncBatchStop |
For async batch runs (AsyncBatchStart(String, array<String>[]()[], array<String>[]()[], Boolean, Boolean, PDFHandler..::.BatchOutputType)),
this method can be used to stop them before finishing with
all records passed over.
| |
Close |
Close the current document. This must be executed after a successfull
Open call at some point when done using the file.
| |
CombineDocuments |
This method is used to combine multiple PDF files into one.
| |
CreateTemplate |
Creates a InfigoTemplate object for the current open Infigo template.
| |
CreateThumbnails | Overloaded. | |
CreateWatermark | Overloaded. | |
CreateXMLData |
Create the Infigo XML data representing the current open document and
returning it as a string object.
| |
CreateXMLFile |
Create the Infigo XML data representing the current open document and
writing this into a text file.
| |
Dispose |
If open, will close the document
| |
Equals | (Inherited from Object.) | |
ExportAllFiles | Overloaded. | |
ExportEmbeddedFile | Overloaded. | |
Finalize |
Destruction of the PDF Handler object. Will close the file if still open.
(Overrides Object..::.Finalize()()().) | |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
ImportTemplate | Overloaded. | |
ImportXMLData |
Import the Infigo XML data given as string into
the current open document.
| |
ImportXMLFile |
Import the Infigo XML data given in a text file into
the current open document.
| |
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
Open |
Opens a PDF file (can be used for any valid PDF file).
| |
SaveFile |
Saves a infigo template. This does create the final output and is usually
the next step after importing Infigo XML data.
| |
SyncBatch | Creates a batch output file. The input XML files (one for each record) are given as a string array with the file names. It is possible to create a single output file. In this case, the array output names must contain only one file name. It is also possible to create one output file for each record, in which case you can either specify as many output file names as there are record files, or specify just one file name, the rest will be computed with an increasing number automatically. Furthermore, it is possible to output only the variable content (any static PDF background gets removed) or create a PPML + PDF file comination for optimized printing (this is only possible for single file output though). | |
TemplateWithXMLData |
This method provides a simple way to create the output for a given
Infigo template and a given Infigo XML data.
| |
TemplateWithXMLFile |
This method provides a simple way to create the output for a given
Infigo template and a given Infigo XML file.
| |
ToString | (Inherited from Object.) | |
UpdateSimple |
This method can be used to create quickly a preview thumbnail for a certain page.
This method can only be used if CanUseSimpleUpdate returns true.
Otherwise, the results are not predicable.
| |
UpdateThumbnailOnly |
This method can be used to create quickly a preview thumbnail for a certain page.
It requires to be fed with the whole XML data, no matter what items have changed.
It can be used if CanUseSimpleUpdate returns false and therefore
UpdateSimple(String, Int32, Int32, PDFHandler..::.ThumbnailFileType, String) cannot be used.
|
Properties
Name | Description | |
---|---|---|
AsyncBatchFinished |
For async batch runs (AsyncBatchStart(String, array<String>[]()[], array<String>[]()[], Boolean, Boolean, PDFHandler..::.BatchOutputType))
this method returns true, if the batch run has finished
successfully and completely.
| |
AsyncBatchIsRunning |
For async batch runs (AsyncBatchStart(String, array<String>[]()[], array<String>[]()[], Boolean, Boolean, PDFHandler..::.BatchOutputType)),
this method returns true while the batch is still running.
Even after manually stopping the batch via AsyncBatchStop()()(),
it might take a while until the execution of the thread stops.
This method allows to check if the batch is still running or not.
| |
AsyncBatchRecordNumber |
For async batch runs (AsyncBatchStart(String, array<String>[]()[], array<String>[]()[], Boolean, Boolean, PDFHandler..::.BatchOutputType)), this returns
the current record number which does get processed.
| |
CanUseSimpleUpdate |
This member returns true, if working preview thumbnails can be created
via the simple update method (which is faster). This is only
working for certain templates.
| |
FileName |
This member returns the file name of the file currently open.
| |
IsInfigoTemplate |
This member returns true, if the file currently open is an
Infigo template. If it is an ordinary PDF, it will return false.
Please note that some functions will only operate on Infigo template files. | |
IsOpen |
This member returns true if there is a PDF document successfully opened.
| |
LastError |
Returns a description of the last error.
Should be checked if the status of a called function returned false.
| |
NumberOfPages |
Returns the number of pages in the file.
| |
Version |
Returns the version of the Infigo PDF component.
|