PDF

The PDF connector enables the user to execute commonly performed tasks within a PDF document. The PDF connector exposes various methods that can be used in a project.

Note

The PDF connector is not a default connector and needs to be added to a project every time required.

Refer to the Plugins section to learn more about adding the PDF conenctor to a project.

How To Use

Once the PDF connector is added to a project, follow the steps to access the PDF connector.

  1. In the Toolbox expand Connectors

    Screenshot

  2. Drag the PDF component and drop it under Global Objects.

    Screenshot

  3. Expand Global Objects.

  4. Double click on the PDF component under Global Objects, to see all the methods for PDF connector available under Object Explorer section.

    Screenshot

Load

Allows user to load an existing PDF document. The load method must be used prior to performing any other operations on a PDF document.

Input: Filepath, Password

Screenshot

Close

Allows user to close a PDF document.

Screenshot

ExportAsImage

Allows user to export the specified page as image. This method accepts the page number as input and returns the specified page as a bitmap image.

Input: PageIndex

Screenshot

ExportAsImages

Allows users to export the image of pages specified in a range. This method accepts the start and end page as inputs and returns output images in a bitmap array.

Input: Frompage, ToPage

Screenshot

ExtractImages

Allows users to extract images from an existing PDF document. users can choose to extract images from a single page, a range of pages, or from the entire document. This method accepts the page index as an optional parameter and returns the images in an array.

Input: PageIndex

Screenshot

ExtractText

Allows users to extract text from a PDF document. users can choose to extract text from a single page, a range of pages, or from the entire document. This method accepts the page index as an optional parameter and returns the text in a string.

Input: PageIndex

Screenshot

FindText

Allows users to search for a text in a specified PDF document. This method accepts text as an input and returns a Boolean value.

Input: Text

Screenshot

GetPageCount

Allows users to return the number of pages in PDF document. This method reads the document specified in the Load method and returns the number of pages in the document as an integer.

Screenshot

IsEncrypted

Allows users to check whether the specified PDF document is encrypted or not. This method returns a Boolean value.

Screenshot

RemovePassword

Allows users to decrypt an existing password protected PDF document. user must first call the Load method to open the PDF document before using the RemovePassword method.

Screenshot

Save

Allows user to save the changes to an existing editable PDF document. user must first call the load method to open the PDF document before using the save method.

Input: Filepath

Screenshot

SetExportImageConfig

Allows user to define the properties for an image that is exported from a PDF document.

Input: Width, Height, Image X axis DPI, Image Y axis DPI, Image Aspect ratio.

Screenshot

SetPassword

Allows user to enable encrypt an existing PDF document with a password. user must first call the load method to open the PDF document before use the SetPassword method.

Input: Password

Screenshot