PDFText Module

Properties   Methods   Events   Config Settings   Errors  

The PDFText module provides text and media extraction capabilities for PDF documents.

Syntax

PDFSDK.PDFText

Remarks

The PDFText module automates text and image extraction from PDF documents.

Start with providing the document that you want to extract information from as a file (InputFile) or byte array (InputData) and calling Open. Once the document is opened, call the GetDocumentText or GetPageText methods to extract text content to a string. Use SaveMedia to extract images: pdftext.InputFile = "othello.pdf"; pdftext.Open(); string text = pdftext.GetDocumentText(); pdftext.SaveMedia(0, "picture.jpg"); pdftext.Close();

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

Attachments Property (PDFText Module)

A collection of all attached files found in the document.

Syntax

• Swift
• Objective-C

public var attachments: Array<PDFAttachment> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=attachmentCount,setter=setAttachmentCount:) int attachmentCount;

- (int)attachmentCount;
- (void)setAttachmentCount :(int)newAttachmentCount;

- (NSString*)attachmentAFRelationship:(int)attachmentIndex;
- (void)setAttachmentAFRelationship:(int)attachmentIndex :(NSString*)newAttachmentAFRelationship;

- (int)attachmentType:(int)attachmentIndex;

- (NSString*)attachmentContentType:(int)attachmentIndex;
- (void)setAttachmentContentType:(int)attachmentIndex :(NSString*)newAttachmentContentType;

- (NSString*)attachmentCreationDate:(int)attachmentIndex;
- (void)setAttachmentCreationDate:(int)attachmentIndex :(NSString*)newAttachmentCreationDate;

- (NSString*)attachmentData:(int)attachmentIndex;
- (void)setAttachmentData:(int)attachmentIndex :(NSString*)newAttachmentData;

- (NSData*)attachmentDataB:(int)attachmentIndex;
- (void)setAttachmentDataB:(int)attachmentIndex :(NSData*)newAttachmentData;

- (NSString*)attachmentDescription:(int)attachmentIndex;
- (void)setAttachmentDescription:(int)attachmentIndex :(NSString*)newAttachmentDescription;

- (NSString*)attachmentFileName:(int)attachmentIndex;
- (void)setAttachmentFileName:(int)attachmentIndex :(NSString*)newAttachmentFileName;

- (NSString*)attachmentModificationDate:(int)attachmentIndex;
- (void)setAttachmentModificationDate:(int)attachmentIndex :(NSString*)newAttachmentModificationDate;

- (NSString*)attachmentName:(int)attachmentIndex;
- (void)setAttachmentName:(int)attachmentIndex :(NSString*)newAttachmentName;

- (long long)attachmentSize:(int)attachmentIndex;

Remarks

This property is used to access the details of all the attached files identified in the document. Use SaveAttachment to save attachments from this collection.

DecryptionCert Property (PDFText Module)

The decryption certificate.

Syntax

• Swift
• Objective-C

public var decryptionCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=decryptionCertEffectiveDate) NSString* decryptionCertEffectiveDate;

- (NSString*)decryptionCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=decryptionCertExpirationDate) NSString* decryptionCertExpirationDate;

- (NSString*)decryptionCertExpirationDate;

@property (nonatomic,readonly,assign,getter=decryptionCertExtendedKeyUsage) NSString* decryptionCertExtendedKeyUsage;

- (NSString*)decryptionCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=decryptionCertFingerprint) NSString* decryptionCertFingerprint;

- (NSString*)decryptionCertFingerprint;

@property (nonatomic,readonly,assign,getter=decryptionCertFingerprintSHA1) NSString* decryptionCertFingerprintSHA1;

- (NSString*)decryptionCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=decryptionCertFingerprintSHA256) NSString* decryptionCertFingerprintSHA256;

- (NSString*)decryptionCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=decryptionCertIssuer) NSString* decryptionCertIssuer;

- (NSString*)decryptionCertIssuer;

@property (nonatomic,readonly,assign,getter=decryptionCertPrivateKey) NSString* decryptionCertPrivateKey;

- (NSString*)decryptionCertPrivateKey;

@property (nonatomic,readonly,assign,getter=decryptionCertPrivateKeyAvailable) BOOL decryptionCertPrivateKeyAvailable;

- (BOOL)decryptionCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=decryptionCertPrivateKeyContainer) NSString* decryptionCertPrivateKeyContainer;

- (NSString*)decryptionCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=decryptionCertPublicKey) NSString* decryptionCertPublicKey;

- (NSString*)decryptionCertPublicKey;

@property (nonatomic,readonly,assign,getter=decryptionCertPublicKeyAlgorithm) NSString* decryptionCertPublicKeyAlgorithm;

- (NSString*)decryptionCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=decryptionCertPublicKeyLength) int decryptionCertPublicKeyLength;

- (int)decryptionCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=decryptionCertSerialNumber) NSString* decryptionCertSerialNumber;

- (NSString*)decryptionCertSerialNumber;

@property (nonatomic,readonly,assign,getter=decryptionCertSignatureAlgorithm) NSString* decryptionCertSignatureAlgorithm;

- (NSString*)decryptionCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=decryptionCertStore,setter=setDecryptionCertStore:) NSString* decryptionCertStore;

- (NSString*)decryptionCertStore;
- (void)setDecryptionCertStore :(NSString*)newDecryptionCertStore;

@property (nonatomic,readwrite,assign,getter=decryptionCertStoreB,setter=setDecryptionCertStoreB:) NSData* decryptionCertStoreB;

- (NSData*)decryptionCertStoreB;
- (void)setDecryptionCertStoreB :(NSData*)newDecryptionCertStore;

@property (nonatomic,readwrite,assign,getter=decryptionCertStorePassword,setter=setDecryptionCertStorePassword:) NSString* decryptionCertStorePassword;

- (NSString*)decryptionCertStorePassword;
- (void)setDecryptionCertStorePassword :(NSString*)newDecryptionCertStorePassword;

@property (nonatomic,readwrite,assign,getter=decryptionCertStoreType,setter=setDecryptionCertStoreType:) int decryptionCertStoreType;

- (int)decryptionCertStoreType;
- (void)setDecryptionCertStoreType :(int)newDecryptionCertStoreType;

@property (nonatomic,readonly,assign,getter=decryptionCertSubjectAltNames) NSString* decryptionCertSubjectAltNames;

- (NSString*)decryptionCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=decryptionCertThumbprintMD5) NSString* decryptionCertThumbprintMD5;

- (NSString*)decryptionCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=decryptionCertThumbprintSHA1) NSString* decryptionCertThumbprintSHA1;

- (NSString*)decryptionCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=decryptionCertThumbprintSHA256) NSString* decryptionCertThumbprintSHA256;

- (NSString*)decryptionCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=decryptionCertUsage) NSString* decryptionCertUsage;

- (NSString*)decryptionCertUsage;

@property (nonatomic,readonly,assign,getter=decryptionCertUsageFlags) int decryptionCertUsageFlags;

- (int)decryptionCertUsageFlags;

@property (nonatomic,readonly,assign,getter=decryptionCertVersion) NSString* decryptionCertVersion;

- (NSString*)decryptionCertVersion;

@property (nonatomic,readwrite,assign,getter=decryptionCertSubject,setter=setDecryptionCertSubject:) NSString* decryptionCertSubject;

- (NSString*)decryptionCertSubject;
- (void)setDecryptionCertSubject :(NSString*)newDecryptionCertSubject;

@property (nonatomic,readwrite,assign,getter=decryptionCertEncoded,setter=setDecryptionCertEncoded:) NSString* decryptionCertEncoded;

- (NSString*)decryptionCertEncoded;
- (void)setDecryptionCertEncoded :(NSString*)newDecryptionCertEncoded;

@property (nonatomic,readwrite,assign,getter=decryptionCertEncodedB,setter=setDecryptionCertEncodedB:) NSData* decryptionCertEncodedB;

- (NSData*)decryptionCertEncodedB;
- (void)setDecryptionCertEncodedB :(NSData*)newDecryptionCertEncoded;

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

InputData Property (PDFText Module)

A byte array containing the PDF document to process.

Syntax

• Swift
• Objective-C

public var inputData: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputData,setter=setInputData:) NSData* inputData;

- (NSData*)inputData;
- (void)setInputData :(NSData*)newInputData;

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

InputFile Property (PDFText Module)

The PDF file to process.

Syntax

• Swift
• Objective-C

public var inputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

This property is used to provide a path to the PDF document to be processed.

Media Property (PDFText Module)

A collection of all media objects found in the document.

Syntax

• Swift
• Objective-C

public var media: Array<PDFMedia> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=mediaCount,setter=setMediaCount:) int mediaCount;

- (int)mediaCount;
- (void)setMediaCount :(int)newMediaCount;

- (NSString*)mediaContentType:(int)mediaIndex;

- (NSString*)mediaData:(int)mediaIndex;
- (void)setMediaData:(int)mediaIndex :(NSString*)newMediaData;

- (NSData*)mediaDataB:(int)mediaIndex;
- (void)setMediaDataB:(int)mediaIndex :(NSData*)newMediaData;

- (int)mediaHeight:(int)mediaIndex;

- (long long)mediaSize:(int)mediaIndex;

- (int)mediaWidth:(int)mediaIndex;

Remarks

This property is used to access the details of all the media objects identified in the document. The only media type that is currently supported is bitmap (a fixed-size image).

Use SaveMedia to extract the embedded media object to a local file.

Password Property (PDFText Module)

The password to decrypt the document with.

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

PDFAConformanceLevel Property (PDFText Module)

The PDF/A conformance level of the document.

Syntax

• Swift
• Objective-C

public var pdfaConformanceLevel: PDFTextPDFAConformanceLevels {
  get {...}
  set {...}
}

public enum PDFTextPDFAConformanceLevels: Int32 {
  case paclNone = 0
  case paclA1a = 1
  case paclA1b = 2
  case paclA2a = 3
  case paclA2b = 4
  case paclA2u = 5
  case paclA3a = 6
  case paclA3b = 7
  case paclA3u = 8
  case paclA4 = 9
  case paclA4e = 10
  case paclA4f = 11
}

@property (nonatomic,readwrite,assign,getter=PDFAConformanceLevel,setter=setPDFAConformanceLevel:) int PDFAConformanceLevel;

- (int)PDFAConformanceLevel;
- (void)setPDFAConformanceLevel :(int)newPDFAConformanceLevel;

Default Value

0

Remarks

This property is used to specify the desired PDF/A conformance level the module attempts to apply when operating on the document.

Possible values are:

Close Method (PDFText Module)

Closes the opened document.

Syntax

• Swift
• Objective-C

public func close() throws -> Void

- (void)close;

Remarks

This method is used to close the previously opened document. It should always be preceded by a call to Open.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close();

Config Method (PDFText Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config :(NSString*)configurationString;

Remarks

Config is a generic method available in every module. It is used to set and retrieve configuration settings for the module.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the module, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Encrypted Method (PDFText Module)

Checks whether the document is encrypted.

Syntax

• Swift
• Objective-C

public func encrypted() throws -> Bool

- (BOOL)encrypted;

Remarks

This method is used to determine whether the document is encrypted. It returns false if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

GetDocumentProperty Method (PDFText Module)

Returns the value of a document property.

Syntax

• Swift
• Objective-C

public func getDocumentProperty(documentProperty: String) throws -> String

- (NSString*)getDocumentProperty :(NSString*)documentProperty;

Remarks

This method is used to obtain the value of a document property. The list of settings below may be extended in the future.

DocumentProperty specifies the document property to read. Possible values are:

Example: pdftext.InputFile = "input.pdf"; pdftext.Open(); string description = pdftext.GetDocumentProperty("Xmp[dc:description]"); string metadataXml = pdftext.GetDocumentProperty("Xmp"); // Use language descriptors for multi-language properties string descriptionEs = pdftext.GetDocumentProperty("Xmp[dc:description[es]]"); pdftext.Close(); NOTE: Each document property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

GetDocumentText Method (PDFText Module)

Returns the entire text content contained in the document.

Syntax

• Swift
• Objective-C

public func getDocumentText() throws -> String

- (NSString*)getDocumentText;

Remarks

This method is used to obtain the whole body of text from the opened document.

GetPageProperty Method (PDFText Module)

Returns the value of a page property.

Syntax

• Swift
• Objective-C

public func getPageProperty(pageIndex: Int32, pageProperty: String) throws -> String

- (NSString*)getPageProperty :(int)pageIndex :(NSString*)pageProperty;

Remarks

This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details.

PageIndex specifies the page to read information about (with a valid range from 0 to PageCount - 1), and PageProperty specifies the page property to read. Possible values are:

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); NOTE: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

GetPageText Method (PDFText Module)

Returns the text content residing on a specific page.

Syntax

• Swift
• Objective-C

public func getPageText(pageIndex: Int32) throws -> String

- (NSString*)getPageText :(int)pageIndex;

Remarks

This method is used to obtain a part of the document text residing on the page specified by PageIndex (zero-based).

Open Method (PDFText Module)

Opens the document for processing.

Syntax

• Swift
• Objective-C

public func open() throws -> Void

- (void)open;

Remarks

This method is used to open the document specified in InputFile or InputData before performing some operation on it, such as extracting, editing, or replacing text. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

Reset Method (PDFText Module)

Resets the module.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method is used to reset the module's properties and configuration settings to their default values.

SaveAttachment Method (PDFText Module)

Saves a PDF attachment to a file.

Syntax

• Swift
• Objective-C

public func saveAttachment(index: Int32, fileName: String) throws -> Void

- (void)saveAttachment :(int)index :(NSString*)fileName;

Remarks

This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the Attachments collection.

Index is the index of the attachment in the Attachments collection to be saved.

FileName specifies the filename that the attachment will be saved to.

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

SaveMedia Method (PDFText Module)

Saves a media object to a file.

Syntax

• Swift
• Objective-C

public func saveMedia(index: Int32, fileName: String) throws -> Void

- (void)saveMedia :(int)index :(NSString*)fileName;

Remarks

This method is used to retrieve the contents of a media object from the document and save it to a file. It does not modify the contents of the Media collection.

Index is the index of the media object in the Media collection to be saved.

FileName specifies the filename that the media object will be saved to.

Example: pdftext.InputFile = "input_with_pictures.pdf"; pdftext.Open(); pdftext.SaveMedia(0, "picture.jpg"); pdftext.Close();

DocumentInfo Event (PDFText Module)

Fired when the document has been loaded into memory.

Syntax

• Swift
• Objective-C

func onDocumentInfo(pageCount: Int32)

- (void)onDocumentInfo :(int)pageCount;

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details.

PageCount reports the number of pages in the document.

This event is fired when Open is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFText Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError :(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the module .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (PDFText Module)

Fired once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog :(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event is fired once for each log message generated by the module. The verbosity is controlled by the LogLevel configuration setting.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFText Module)

Fired when the module detects that the document is encrypted with a password.

Syntax

• Swift
• Objective-C

func onPassword(available: Bool, cancel: inout Bool)

- (void)onPassword :(BOOL)available :(int*)cancel;

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to Password.

Available indicates whether the decryption password is already available to the module or still needs to be set. If this parameter is false, the correct password must be provided for the decryption attempt to succeed.

Cancel determines whether the module will stop firing this event to request a password.

RecipientInfo Event (PDFText Module)

Fired for each recipient certificate of the encrypted document.

Syntax

• Swift
• Objective-C

func onRecipientInfo(issuer: String, serialNumber: String, subjectKeyIdentifier: String, available: Bool, cancel: inout Bool)

- (void)onRecipientInfo :(NSString*)issuer :(NSString*)serialNumber :(NSString*)subjectKeyIdentifier :(BOOL)available :(int*)cancel;

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to DecryptionCert.

Issuer specifies the subject of the issuer certificate.

SerialNumber specifies the serial number of the encryption certificate.

SubjectKeyIdentifier specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

Available indicates whether the decryption certificate is already available to the module or still needs to be set. If this parameter is false, the correct certificate must be provided for the decryption attempt to succeed.

Cancel determines whether the module will stop firing this event to request a certificate.

NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate causes its own invocation of this event.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

public init()

public init(encoded: Data)

public init(storeType: CertStoreTypes, store: String, storePassword: String, subject: String)

public init(storeType: CertStoreTypes, store: Data, storePassword: String, subject: String)

PDFAttachment Type

The file being attached to the PDF document.

Remarks

This type contains information about the file that is being attached to the document.

• AFRelationship
• AttachmentType
• ContentType
• CreationDate
• Data
• Description
• FileName
• ModificationDate
• Name
• Size

Fields

Constructors

public init()

public init(fileName: String)

public init(fileName: String, description_: String)

public init(data: Data, name: String, description_: String)

PDFMedia Type

The media object that is included as part of the PDF document.

Remarks

This type contains information about the media object (such as an image) that is included in the document.

• ContentType
• Data
• Height
• Size
• Width

Fields

Constructors

public init()

public init(data: Data)

Config Settings (PDFText Module)

PDFText Config Settings

Base Config Settings

Trappable Errors (PDFText Module)

PDF Errors

Parsing Errors