Read
The Read function reads text, signatures and form data from Pdf documents.
All passwords entered into this function's properties will be visible in plain text in the Linx solution file and in the compiled .Net assembly.
Properties
PDF file path
Path to the PDF file to read.
Authentication type
Pdf files can be protected using a password or a certificate, this field indicates which type of authentication to attempt when loading the PDF.
- None
The document is unprotected and can be opened immediately. - Password
The document is protected by a password. - Certificate
The document is protected by a certificate.
PDF password
Password required to access the PDF file. (Visible when using "Password" authentication type.)
Certificate source
Source to load the certificate from. (Visible when using "Certificate" authentication type.)
- File
Load a certificate from a .pfx file. - Store
Load a certificate from the windows certificate store.
Certificate file path
Path to a .pfx file containing a certificate. (Visible when using "File" as the certificate source.)
Certificate file password (Optional)
The password required to open the .pfx file. (Visible when using "File" as the certificate source.)
Certificate
Certificate loaded from the windows certificate store. (Visible when using "Store" as the certificate source.)
Read text
Reads the document text, and returns it an output parameter named "Text".
Extraction strategy
Extraction strategy to use when reading the text from the document (visible when "Read text" is checked).
- Location
- Simple
- Top to bottom
Split text
Controls how the document text is split (visible when "Read text" is checked).
- Never
Text is never split, all text in the document is returned as a single string value. - Per page
Text is split per page, and returned in a list or strings with one entry per page.
Read form data
Reads any form data preset in the document.
Return form data as
Controls how the form data is returned. (Visible when "Read form data" is checked.)
- Type
Form data is used to populate an existing Type. - Infer type from a sample PDF
Return type is constructed based on a sample PDF document. - List
Form data is returned as a list of entries.
Form data type
The type used to hold the document's form data. (Visible when 'Type' is selected for the Return form data as field.)
Sample PDF
A sample PDF containing the empty form. (Visible when 'Infer type from a sample PDF' is selected for the Return form data as field.)
Read signatures
Reads any signatures present in the document.