PDFEdit Module

Properties   Methods   Events   Config Settings   Errors  

The PDFEdit module provides text and document editing capabilities for PDFs.

Syntax

SecurePDF.PDFEdit

Remarks

The PDFEdit class can be used to automate search and replace operations, text extraction, content composition, and document merging and splitting.

To begin, provide the input document as a file (InputFile), byte array (InputData), or stream (SetInputStream) and call the Open method. When finished editing the document, call the Close method to close it and save the changes to either OutputFile, OutputData, or the stream set in SetOutputStream.

Search, Replace, and Extract Text

Content Composition

With PDFEdit, you can also create documents from scratch or add text or images to existing documents using the editing API. This consists of the following four methods:

• CreateNew creates a blank PDF document.
• AddTextBlock adds a block of text.
• AddBitmap adds an image (JPEG, BMP, or PNG).
• AddDrawing adds a vector drawing.

The above methods are complemented by a set of formatting methods that let you choose the parameters of the added text or image (where, what color, how big, or how skewed):

• SetPosition sets the page to work with and places the cursor at a specific position on the page.
• SetFont sets the font to use, including its size, style, and color.
• SetAlignment sets the block alignment (left/center/right, top/center/bottom).
• SetTransform sets the transformation matrix, which alters positioning, scaling, rotation angle, and skew.

Document Merging and Splitting

To copy pages from one document to another, open each document in an individual PDFEdit object. Then, using the SelectPage method, select the page of document 1 that you want to add to document 2, and assign the PDFPage object populated in its SelectedPage property to the NewPage property of the recipient document. Finally, commit the page to the recipient document using the AppendPage or InsertPage method. dest.InputFile = "recipient.pdf"; dest.Open(); src.InputFile = "donor.pdf"; src.Open(); src.SelectPage(0); dest.NewPage = src.SelectedPage; dest.AppendPage(); dest.Close(); src.Close(); To split the document in two, use the RemovePages method to remove the respective subsets of pages from the document, then save each remaining part. For example: pdfedit.InputFile = "input_4_pages.pdf"; pdfedit.Open(); // Remove the pages after page 1, and save the first part (pages 0-1) pdfedit.OutputFile = "input_first.pdf"; pdfedit.RemovePages(2, 2); pdfedit.Close(); // Remove the pages up to and including page 1, and save the second part (pages 2-3) pdfedit.OutputFile = "input_second.pdf"; pdfedit.Open(); pdfedit.RemovePages(0, 2); pdfedit.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 (PDFEdit 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*)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;

Default Value

"0"

Remarks

This property is used to access the details of all the attached files identified in the document. Use the AddAttachment, RemoveAttachment, and SaveAttachment methods to add, remove, and save attachments to/from this properties respectively.

This property is read-only.

DecryptionCert Property (PDFEdit 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;
 

Default Value

"0"

Remarks

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

This property is read-only.

Font Property (PDFEdit Module)

The currently set font.

Syntax

• Swift
• Objective-C

public var font: PDFFont {
  get {...}
}

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

- (NSString*)fontColor;

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

- (NSString*)fontName;

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

- (NSString*)fontSize;

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

- (NSString*)fontStyle;

 

Default Value

"0"

Remarks

This property is used to access the font details specified using the SetFont method.

This property is read-only.

InputData Property (PDFEdit 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 (PDFEdit 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 (PDFEdit 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;

Default Value

"0"

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 the AddBitmap method to add images to this properties, and use the SaveMedia method to extract the embedded media object to a local file.

This property is read-only.

NewPage Property (PDFEdit Module)

A placeholder for a page object to be added to the document.

Syntax

• Swift
• Objective-C

public var newPage: PDFPage {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=newPageHandle,setter=setNewPageHandle:) long long newPageHandle;

- (long long)newPageHandle;
- (void)setNewPageHandle :(long long)newNewPageHandle;

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

- (NSString*)newPageHeight;

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

- (int)newPageRotate;

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

- (NSString*)newPageWidth;

 

Default Value

"0"

Remarks

This property is used to specify a page object from another document to be added to the current document using the AppendPage or InsertPage methods.

This property is read-only.

OutputData Property (PDFEdit Module)

A byte array containing the PDF document after processing.

Syntax

• Swift
• Objective-C

public var outputData: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=outputData) NSData* outputData;

- (NSData*)outputData;

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via OutputFile and SetOutputStream respectively.

This property is read-only.

OutputFile Property (PDFEdit Module)

The path to a local file where the output will be written.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile;

- (NSString*)outputFile;
- (void)setOutputFile :(NSString*)newOutputFile;

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document will be saved after the operation has completed.

Overwrite Property (PDFEdit Module)

Whether or not the module should overwrite files.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

This property indicates whether or not the class will overwrite OutputFile, OutputData, or the stream set in SetOutputStream. If set to false, an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Password Property (PDFEdit 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.

Position Property (PDFEdit Module)

The currently set position.

Syntax

• Swift
• Objective-C

public var position: PDFPagePosition {
  get {...}
}

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

- (int)positionPageIndex;

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

- (NSString*)positionX;

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

- (NSString*)positionY;

 

Default Value

"0"

Remarks

This property is used to access the position details specified using the SetPosition method.

This property is read-only.

SelectedPage Property (PDFEdit Module)

The currently selected page.

Syntax

• Swift
• Objective-C

public var selectedPage: PDFPage {
  get {...}
}

@property (nonatomic,readonly,assign,getter=selectedPageHandle) long long selectedPageHandle;

- (long long)selectedPageHandle;

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

- (NSString*)selectedPageHeight;

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

- (int)selectedPageRotate;

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

- (NSString*)selectedPageWidth;

 

Default Value

"0"

Remarks

This property is used to access the page object that corresponds to the page selected using the SelectPage method. Use page selection to copy a page from one document to another.

This property is read-only.

AddAttachment Method (PDFEdit Module)

Adds an attachment to the document.

Syntax

• Swift
• Objective-C

public func addAttachment(fileName: String, description_: String) throws -> Void

- (void)addAttachment:(NSString*)fileName :(NSString*)description;

Remarks

This method is used to add an attachment (embedded file) to the document and to the Attachments properties.

The FileName and Description parameters specify the filename and description of the attachment respectively.

Example: component.InputFile = "input.pdf"; component.OutputFile = "input_with_attachment.pdf"; component.Open(); component.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; component.Attachments.Add(attachment); // Or using one of the constructors: component.Attachments.Add(new PDFAttachment("foo.txt", "desc")); component.Close(); The full list of attachments is contained in the Attachments properties.

NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

AddBitmap Method (PDFEdit Module)

Adds a bitmap image to the document.

Syntax

• Swift
• Objective-C

public func addBitmap(format: String, bitmapBytes: Data, width: Int32, height: Int32) throws -> Void

- (void)addBitmap:(NSString*)format :(NSData*)bitmapBytes :(int)width :(int)height;

Remarks

This method is used to add a bitmap image to the document at the current Position and to the Media properties.

The Format and BitmapBytes parameters specify the format and raw data of the serialized image respectively. The former can take one of the following values:

• JPEG2000
• JPEG
• Custom

The full list of images is contained in the Media properties. Use the following methods to adjust new image parameters:

• SetAlignment
• SetPosition
• SetTransform

AddDrawing Method (PDFEdit Module)

Adds a vector drawing to the document.

Syntax

• Swift
• Objective-C

public func addDrawing(format: String, drawingBytes: Data) throws -> Void

- (void)addDrawing:(NSString*)format :(NSData*)drawingBytes;

Remarks

This method is used to add a vector drawing to the document at the current Position.

The Format and DrawingBytes parameters specify the format and raw data (as an encoded PDF appearance stream) of the drawing respectively. The former is reserved for future use.

AddTextBlock Method (PDFEdit Module)

Adds a block of text to the document.

Syntax

• Swift
• Objective-C

public func addTextBlock(text: String) throws -> Void

- (void)addTextBlock:(NSString*)text;

Remarks

This method is used to insert a block of Text into the document at the current Position. Use the following methods to adjust new text block parameters:

• SetAlignment
• SetFont
• SetPosition
• SetTransform

AppendPage Method (PDFEdit Module)

Appends a page to the end of the document.

Syntax

• Swift
• Objective-C

public func appendPage() throws -> Void

- (void)appendPage;

Remarks

This method is used to append the page specified in the NewPage property to the end of the opened document. If NewPage is not set, the class will append a new blank page.

Note that when this method returns, the Position will not be automatically moved to the newly appended page.

Close Method (PDFEdit 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 the Open method.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); If any changes are made to the document, they will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (PDFEdit 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 class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Convert Method (PDFEdit Module)

Converts the document to a different format.

Syntax

• Swift
• Objective-C

public func convert(format: String) throws -> Void

- (void)convert:(NSString*)format;

Remarks

This method is used to convert the document to the format specified by the Format parameter, which can take one of the following values:

CreateNew Method (PDFEdit Module)

Creates a new PDF document.

Syntax

• Swift
• Objective-C

public func createNew() throws -> Void

- (void)createNew;

Remarks

This method is used to create a blank PDF document with one empty page. Use the DefaultPageWidth and DefaultPageHeight configuration settings to adjust the new page dimensions. Having created the baseline document, use the class's methods to add objects to it.

Encrypted Method (PDFEdit 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 or not the document is encrypted. It will return 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 will open it, perform the operation, then close it.

GetDocumentProperty Method (PDFEdit 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. Together with SetDocumentProperty, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

The DocumentProperty parameter specifies the document property to read and can take one of the following values:

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

GetDocumentText Method (PDFEdit 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 (PDFEdit 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.

The PageIndex parameter specifies the page to read information about (with a valid range from 0 to PageCount - 1), and the PageProperty parameter specifies the page property to read. The latter can take one of the following values:

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 will open it, perform the operation, then close it.

GetPageText Method (PDFEdit 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 the PageIndex parameter (zero-based).

InsertPage Method (PDFEdit Module)

Inserts a page into the document.

Syntax

• Swift
• Objective-C

public func insertPage(pageIndex: Int32) throws -> Void

- (void)insertPage:(int)pageIndex;

Remarks

This method is used to insert the page specified in the NewPage property into the opened document at the position specified by the PageIndex parameter (zero-based). If NewPage is not set, the class will insert a new blank page.

Note that when this method returns, the Position will not be automatically moved to the newly inserted page.

Open Method (PDFEdit 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, InputData, or SetInputStream 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.

RemoveAttachment Method (PDFEdit Module)

Removes an attachment from the document.

Syntax

• Swift
• Objective-C

public func removeAttachment(index: Int32) throws -> Void

- (void)removeAttachment:(int)index;

Remarks

This method is used to remove an attachment from the document and from the Attachments properties.

The Index parameter is the index of the attachment in the Attachments properties to be removed.

Example: pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

RemovePage Method (PDFEdit Module)

Removes a page from the document.

Syntax

• Swift
• Objective-C

public func removePage(pageIndex: Int32) throws -> Void

- (void)removePage:(int)pageIndex;

Remarks

This method is used to remove the page specified by the PageIndex parameter (zero-based) from the opened document.

RemovePages Method (PDFEdit Module)

Removes a subset of pages from the document.

Syntax

• Swift
• Objective-C

public func removePages(pageIndex: Int32, count: Int32) throws -> Void

- (void)removePages:(int)pageIndex :(int)count;

Remarks

This method is used to remove a sequence of Count pages from the opened document starting at the position specified by the PageIndex parameter (zero-based).

ReplaceDocumentText Method (PDFEdit Module)

Replaces text in the document.

Syntax

• Swift
• Objective-C

public func replaceDocumentText(pattern: String, value: String) throws -> Int32

- (int)replaceDocumentText:(NSString*)pattern :(NSString*)value;

Remarks

This method is used to replace all entries of Pattern with Value in the whole document.

The ReplaceText event will fire repeatedly during its work to report every new search entry identified in the document. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

ReplacePageText Method (PDFEdit Module)

Replaces text on a page.

Syntax

• Swift
• Objective-C

public func replacePageText(pageIndex: Int32, pattern: String, value: String) throws -> Int32

- (int)replacePageText:(int)pageIndex :(NSString*)pattern :(NSString*)value;

Remarks

This method is used to replace all entries of Pattern with Value on the page specified by the PageIndex parameter (zero-based).

The ReplaceText event will fire repeatedly during its work to report every new search entry identified on the page. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

Reset Method (PDFEdit Module)

Resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

SaveAttachment Method (PDFEdit 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 Attachments properties's contents.

The Index parameter is the index of the attachment in the Attachments properties to be saved.

The FileName parameter 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(); Example (saving to a stream): component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream property if it's set NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

SaveMedia Method (PDFEdit 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 Media properties's contents.

The Index parameter is the index of the media object in the Media properties to be saved.

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

Example: pdfedit.InputFile = "input_with_pictures.pdf"; pdfedit.Open(); pdfedit.SaveMedia(0, "picture.jpg"); pdfedit.Close(); Example (saving to a stream): pdfedit.InputFile = "input_with_pictures.pdf"; pdfedit.Open(); pdfedit.Media[0].OutputStream = myStream; pdfedit.SaveMedia(0, null); // null means use the OutputStream property if it's set pdfedit.Close();

SelectPage Method (PDFEdit Module)

Selects a page.

Syntax

• Swift
• Objective-C

public func selectPage(pageIndex: Int32) throws -> Void

- (void)selectPage:(int)pageIndex;

Remarks

This method is used to select the page specified by the PageIndex parameter (zero-based) and populate its details in the SelectedPage property. Use page selection to access a page's properties or copy it to another document.

SetAlignment Method (PDFEdit Module)

Sets the object alignment for subsequent insertion operations.

Syntax

• Swift
• Objective-C

public func setAlignment(horizontalAlignment: Int32, verticalAlignment: Int32) throws -> Void

- (void)setAlignment:(int)horizontalAlignment :(int)verticalAlignment;

Remarks

This method is used to set the horizontal and vertical alignment parameters to apply when AddTextBlock or AddBitmap is called. Alignment specifies the position of the newly added text block or image relative to the current Position on the page.

The HorizontalAlignment parameter specifies the horizontal alignment and can be one of the following values:

The VerticalAlignment parameter specifies the vertical alignment and can be one of the following values:

SetDocumentProperty Method (PDFEdit Module)

Sets the value of a document property.

Syntax

• Swift
• Objective-C

public func setDocumentProperty(documentProperty: String, value: String) throws -> Void

- (void)setDocumentProperty:(NSString*)documentProperty :(NSString*)value;

Remarks

This method is used to adjust properties of the opened document. Together with GetDocumentProperty, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

The DocumentProperty and Value parameters specify the document property and value to set respectively. The former can take one of the following values:

Example: pdfedit.InputFile = "input.pdf"; pdfedit.Open(); pdfedit.SetDocumentProperty("Xmp[dc:description]", "My first book draft"); pdfedit.SetDocumentProperty("Xmp", "...xml data here..."); // Use language descriptors for multi-language properties pdfedit.SetDocumentProperty("Xmp[dc:description[es]]", "El primer borrador de mi libro"); pdfedit.Close();

SetFont Method (PDFEdit Module)

Sets the font properties to be applied to text.

Syntax

• Swift
• Objective-C

public func setFont(name: String, size: String, style: String, color: String) throws -> Void

- (void)setFont:(NSString*)name :(NSString*)size :(NSString*)style :(NSString*)color;

Remarks

This method is used to define the font attributes for text.

The Name parameter specifies the font name.

The Size parameter specifies the font size, either as an absolute value (e.g., 12) or relative adjustment (e.g., +2).

The Style parameter specifies the font style. The following syntax is supported:

[B][I][U][bold][italic][underline][##%][##%,##%][0.###][0.###]

For example:

• bold
• bold 50%
• bold italic 50%
• BI 50% 42%
• B 50% italic 0.42

The Color parameter specifies the font color in hash-prefixed hexadecimal format (such as #FF0000 for red). The following HTML color aliases are also supported:

SetPosition Method (PDFEdit Module)

Sets the page and position for new text blocks or images.

Syntax

• Swift
• Objective-C

public func setPosition(pageIndex: Int32, x: String, y: String) throws -> Void

- (void)setPosition:(int)pageIndex :(NSString*)X :(NSString*)Y;

Remarks

This method is used to define the Position where new text blocks or images will be added. The page is identified by the PageIndex parameter (zero-based), the X parameter specifies the horizontal position, and the Y parameter specifies the vertical position.

X and Y values that are absolute, relative to the current position, and relative to the page dimensions are all supported.

Example: // Sets to exact coordinates. pdfedit.SetPosition(0, "100", "20"); // Moves 20 points to the right and 20 points down from the current position. pdfedit.SetPosition(0, "{x}+20", "{y}-20"); // Moves 20 points from the right edge and 120 points from the top edge of the page. pdfedit.SetPosition(0, "{width}-20", "{height}-120"); NOTE: PageIndex set to -1 specifies the last page of the document.

SetTransform Method (PDFEdit Module)

Sets the object transformation parameters for subsequent insertion operations.

Syntax

• Swift
• Objective-C

public func setTransform(translationX: String, translationY: String, scaleX: String, scaleY: String, rotation: String, skewA: String, skewB: String) throws -> Void

- (void)setTransform:(NSString*)translationX :(NSString*)translationY :(NSString*)scaleX :(NSString*)scaleY :(NSString*)rotation :(NSString*)skewA :(NSString*)skewB;

Remarks

This method is used to specify the transformation matrix to apply when AddTextBlock or AddBitmap is called. The transformation matrix defines how the coordinates and content of the newly added text block or image are mapped onto the page.

The TranslationX and TranslationY parameters specify the horizontal and vertical translation of the object in points.

The ScaleX and ScaleY parameters specify the horizontal and vertical scaling of the object (e.g., use 0.5 to scale an image to half its original size).

The Rotation parameter specifies the rotation angle of the object in degrees.

The SkewA and SkewB parameters specify the horizontal and vertical skew angles of the object in degrees (e.g., use 30 and 20 respectively to slant the object by 30 degrees horizontally and 20 degrees vertically).

DocumentInfo Event (PDFEdit 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.

The PageCount parameter reports the number of pages in the document.

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

Error Event (PDFEdit 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 class .

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 (PDFEdit 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 class. The verbosity is controlled by the LogLevel configuration setting.

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

The Message parameter is the log message.

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

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

Password Event (PDFEdit Module)

Fired when the component 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 the Password property.

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

The Cancel parameter determines whether the class will stop firing this event to request a password.

RecipientInfo Event (PDFEdit 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 the DecryptionCert property.

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

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

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

The Cancel parameter determines whether the class 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 will cause its own invocation of this event.

ReplaceText Event (PDFEdit Module)

Fired when a substring in the document is due to be replaced.

Syntax

• Swift
• Objective-C

func onReplaceText(pageIndex: Int32, entryIndex: Int32, offset: Int32, pattern: String, substitute: inout String, skip: inout Bool)

- (void)onReplaceText:(int)pageIndex :(int)entryIndex :(int)offset :(NSString*)pattern :(NSString**)substitute :(int*)skip;

Remarks

This event is fired from within the ReplaceDocumentText and ReplacePageText methods, repeatedly, for each located Pattern string. It may be used to track and, if required, alter individual text substitutions.

The PageIndex parameter contains the page number where the entry is located.

The EntryIndex parameter contains the index number of the entry related to the other entries.

The Offset parameter specifies the offset of the substring from the beginning of the page or document.

The Substitute parameter contains the value that Pattern is going to be replaced with. This value matches the Value parameter passed to the respective ReplaceDocumentText or ReplacePageText call. Adjust it from the event handler if required.

The Skip parameter determines whether the class will skip substituting this entry and proceed to the next one.

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: )

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

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

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.

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

Fields

Constructors

public init()

public init(fileName: )

public init(fileName: , description: )

public init(data: , name: , description: )

PDFFont Type

The font used in the PDF document.

Remarks

This type contains details about the font being applied to text.

• Color
• Name
• Size
• Style

Fields

Constructors

public init()

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: )

PDFPage Type

A container for PDF page details.

Remarks

This type contains general information about a document page, such as its dimensions and rotation.

• Handle
• Height
• Rotate
• Width

Fields

Constructors

public init()

PDFPagePosition Type

The position within a PDF document.

Remarks

This type contains information about the current position on a page.

• PageIndex
• X
• Y

Fields

Constructors

public init()

Config Settings (PDFEdit Module)

PDFEdit Config Settings

Base Config Settings

Trappable Errors (PDFEdit Module)

PDFEdit Errors

PDF Errors

Parsing Errors