CIB pdf toolbox 2 technical documentation
4. Usecases
4.6. Reading and Writing simple PDF information
You can render a PDF document to one or more image types at the same time.
Property |
Meaning |
Type |
CenterWindow |
A flag specifying whether to position the document’s window in the center of the screen. Default value: false. |
Get/Set |
Encrypted |
“1” or “0” depending if the document is encrypted |
Get |
Direction |
The predominant reading order for text:
This entry has no direct effect on the document’s contents or page numbering but may be used to determine the relative positioning of pages when displayed side by side or printed n-up. Default value: L2R. |
Get/Set |
DisplayDocTitle |
A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document. |
Get/Set |
DocInfo |
A JSON-Desciption of all available DocInfo.* properties. |
Get |
DocInfo.* |
Setting or reading of custom metadata properties. |
Get/Set |
DocInfo.Author |
Information about the author of the document |
Get/Set |
DocInfo. CompressProfile |
Information about which compression profile was used, after a compression task was executed on the document before. |
Get |
DocInfo.Creator |
Information about the creating software of the PDF document. |
Get/Set |
DocInfo.CreationDate |
Information about the creation date of the PDF document. |
Get/Set |
DocInfo.Keywords |
The Keywords, which are assigned to this PDF document. |
Get/Set |
DocInfo.ModDate |
The last modification date of the PDF document |
Get/Set |
DocInfo.Producer |
Retrieving Information about the producer of the PDF document. |
Get/Set |
DocInfo.Subject |
Information about the subject of the PDF document. |
Get/Set |
DocInfo.Title |
Information about the title of the PDF document. |
Get/Set |
FitWindow |
A flag specifying whether to resize the document’s window to fit the size of the first displayed page. Default value: false. |
Get/Set |
HasJavascript |
“1” or “0” depending if the document contains JavaScript |
Get |
HideMenubar |
A flag specifying whether to hide the conforming reader’s menu bar when the document is active. Default value: false. |
Get/Set |
HideToolbar |
A flag specifying whether to hide the conforming reader’s tool bars when the document is active. Default value: false. |
Get/Set |
HideWindowUI |
A flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed. Default value: false. |
Get/Set |
ID |
The two ID values of the PDF, separated by a ;. |
Get |
ImageInfo |
Retrieving a description about images inside a PDF in JSON format. |
Get |
NonFullScreenPageMode |
The document’s page mode, specifying how to display the document on exiting full-screen mode:
This entry is meaningful only if the value of the PageMode entry in the Catalog dictionary is FullScreen; it shall be ignored otherwise. Default value: UseNone. |
Get/Set |
PageCount |
The amount of pages the document has. |
Get |
PageInfo.<num> |
The page dimentions of the a requested page index <num>, where 0 represents the first page. |
Get |
PageLayout |
A name object specifying the page layout shall be used when the document is opened:
Default value: SinglePage. |
Get/Set |
PageMode |
A name object specifying how the document shall be displayed when opened:
Default value: UseNone. |
Get/Set |
PdfVersion |
The pdf version of the document, can be following strings:
|
Get/Set |
MinPdfVersion |
Minimum output PDF version. If the input pdf has a version higher than this value, the existing version is kept, otherwise increased to the set value. |
Set |
PdfVersionInfo |
A JSON description about the PDF version, which includes also information about what compliance versions the PDF complies to, e.g. PDF/A or PDF/UA. |
Get |