To view the functions, open the Direct.PDFLibrary.dll under Project > References > Library References.
To view the business entities, see Business Entities > Library Types > PDF Objects. The PDF Library adds the following business entities:
-
PDF Document
-
PDF Form Field
|
Function / Event |
Return Value |
Description |
Syntax |
| PDF Document | |||
| Close | Boolean | Closes the PDF file. | Load of <PDF Document> |
| Get Active Page Image | Image | Gets the active page image. | Get Active Page Image of <PDF Document> |
| Get Form Field by Point | PDF Form Field | Gets the form field. Uses the point parameters (X and Y) to locate the form. | Get Form Field by Point of <PDF Document> <Select X> , <Select Y> |
| Get Form Fields | List of PDF Form Field | Get a list of PDF form fields. | Get Form Fields of <PDF Document> |
| Get Form Fields by Name | List of PDF Form Field | Get a list of PDF form fields. Uses the Name parameter to locate the form fields. | Get Form Fields by Name of <PDF Document> <Select Name> |
| Get Form Fields by Rectangle | List of PDF Form Field | Get a list of PDF form fields. Uses the Rectangle parameter (of type Screen Element Rectangle) to locate the form fields. | Get Form Fields by Rectangle of <PDF Document> <Select Rectangle> |
| Get Text | Text | Gets all text from the active page of the PDF. | Get Text of <PDF Document> |
| Get Text by Point | Text | Gets the text using the point parameters (X and Y) to locate the text. | Get Text by Point of <PDF Document> <Select X> , <Select Y> |
| Get Text by Rectangle | Text | Get the text using the Rectangle parameter (of type Screen Element Rectangle) to locate the text. | Get Text by Rectangle of <PDF Document> <Select Rectangle> |
| Load | Boolean | Loads the PDF in the specified Path. | Load of <PDF Document> <Select Path> |
| Load with password | Boolean | Loads the PDF in the specified Path using the Password. | Load with Password of <PDF Document> <Select Path>, <Select Password> |
| Remove Page | Boolean | Removes the page (specified by the Index parameter) from the PDF. | Remove Page of <PDF Document> <Select Index> |
| Save Active Page to Image | Boolean | Saves the active page to an image in the specified Path. | Save Active Page to Image of <PDF Document> <Select Path> |
| Save as | Boolean | Saves the PDF to the specified Path. | Save as of <PDF Document> <Select Path> |
| Save as Flat Copy | Boolean | Saves the flattened PDF to the specified Path. | Save as Flat Copy of <PDF Document> <Select Path> |
| Search | List of Screen Element Rectangles | Returns a list of screen element rectangles with the specified Text. Can optionally specify whether to be Case Sensitive and search for Whole Word only. | |
| PDF Form Field | |||
| Clear Selection | Boolean | Clears the selection. | Clear Selection of <PDF Form FIeld> |
| Select Items | Boolean | Selects the list of items (specified as a List of Text Items). | Select Items of <PDF Form FIeld> [<Add items>] |
| Set Checked | Boolean | Sets the item (to the Checked parameter value). | Set Checked of <PDF Form FIeld> <Select Checked> |
| Set Text | Boolean | Sets the text (to the Text parameter value). | Set Text of <PDF Form FIeld> <Select Text> |
| Unselect Items | Boolean | Unselects the list of items (specified as a List of Text Items). | Unselect Items of <PDF Form FIeld> [<Add items>] |
