PDFEdit Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecurePDF_PDFEdit

Procedural Interface

 securepdf_pdfedit_open();
 securepdf_pdfedit_close($res);
 securepdf_pdfedit_register_callback($res, $id, $function);
 securepdf_pdfedit_get_last_error($res);
 securepdf_pdfedit_get_last_error_code($res);
 securepdf_pdfedit_set($res, $id, $index, $value);
 securepdf_pdfedit_get($res, $id, $index);
 securepdf_pdfedit_do_addattachment($res, $filename, $description);
 securepdf_pdfedit_do_addbitmap($res, $format, $bitmapbytes, $width, $height);
 securepdf_pdfedit_do_adddrawing($res, $format, $drawingbytes);
 securepdf_pdfedit_do_addtextblock($res, $text);
 securepdf_pdfedit_do_appendpage($res);
 securepdf_pdfedit_do_close($res);
 securepdf_pdfedit_do_config($res, $configurationstring);
 securepdf_pdfedit_do_convert($res, $format);
 securepdf_pdfedit_do_createnew($res);
 securepdf_pdfedit_do_encrypted($res);
 securepdf_pdfedit_do_getdocumentproperty($res, $documentproperty);
 securepdf_pdfedit_do_getdocumenttext($res);
 securepdf_pdfedit_do_getpageproperty($res, $pageindex, $pageproperty);
 securepdf_pdfedit_do_getpagetext($res, $pageindex);
 securepdf_pdfedit_do_insertpage($res, $pageindex);
 securepdf_pdfedit_do_open($res);
 securepdf_pdfedit_do_removeattachment($res, $index);
 securepdf_pdfedit_do_removepage($res, $pageindex);
 securepdf_pdfedit_do_removepages($res, $pageindex, $count);
 securepdf_pdfedit_do_replacedocumenttext($res, $pattern, $value);
 securepdf_pdfedit_do_replacepagetext($res, $pageindex, $pattern, $value);
 securepdf_pdfedit_do_reset($res);
 securepdf_pdfedit_do_saveattachment($res, $index, $filename);
 securepdf_pdfedit_do_savemedia($res, $index, $filename);
 securepdf_pdfedit_do_selectpage($res, $pageindex);
 securepdf_pdfedit_do_setalignment($res, $horizontalalignment, $verticalalignment);
 securepdf_pdfedit_do_setdocumentproperty($res, $documentproperty, $value);
 securepdf_pdfedit_do_setfont($res, $name, $size, $style, $color);
 securepdf_pdfedit_do_setposition($res, $pageindex, $x, $y);
 securepdf_pdfedit_do_settransform($res, $translationx, $translationy, $scalex, $scaley, $rotation, $skewa, $skewb);

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

Use the ReplacePageText and ReplaceDocumentText methods to iterate through the page or document content and replace all the text elements that match the specified pattern with the provided text. The class will fire the ReplaceText event during this operation, providing the flexibility of skipping certain text blocks or updating the replacement string on the fly. For example: pdfedit.InputFile = "invoice.pdf"; pdfedit.OutputFile = "invoice_filled.pdf"; pdfedit.OnReplaceText += (s, e) => { if (e.Substitute == "/n software") { e.Substitute = "my company"; } }; pdfedit.Open(); int occurrences = pdfedit.ReplacePageText(0, "SELLER_NAME", "/n software"); pdfedit.Close(); Additionally, the GetPageText and GetDocumentText methods let you extract all the text residing on a specific page or in the entire document.

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

Document-level operations can be performed with the AppendPage, InsertPage, RemovePage, and RemovePages methods.

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 class with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

AttachmentCount Property (SecurePDF_PDFEdit Class)

The number of records in the Attachment arrays.

Object Oriented Interface

public function getAttachmentCount();
public function setAttachmentCount($value);

Procedural Interface

securepdf_pdfedit_get($res, 1 );
securepdf_pdfedit_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentCreationDate
• AttachmentData
• AttachmentDescription
• AttachmentFileName
• AttachmentModificationDate
• AttachmentName
• AttachmentSize

The array indices start at 0 and end at AttachmentCount - 1.

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (SecurePDF_PDFEdit Class)

The content type of the attachment.

Object Oriented Interface

public function getAttachmentContentType($attachmentindex);
public function setAttachmentContentType($attachmentindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 2 , $attachmentindex);
securepdf_pdfedit_set($res, 2, $value , $attachmentindex);

Default Value

''

Remarks

The content type of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentCreationDate Property (SecurePDF_PDFEdit Class)

The creation date of the attachment.

Object Oriented Interface

public function getAttachmentCreationDate($attachmentindex);
public function setAttachmentCreationDate($attachmentindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 3 , $attachmentindex);
securepdf_pdfedit_set($res, 3, $value , $attachmentindex);

Default Value

''

Remarks

The creation date of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentData Property (SecurePDF_PDFEdit Class)

The raw data of the attachment.

Object Oriented Interface

public function getAttachmentData($attachmentindex);
public function setAttachmentData($attachmentindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 4 , $attachmentindex);
securepdf_pdfedit_set($res, 4, $value , $attachmentindex);

Default Value

''

Remarks

The raw data of the attachment.

If AttachmentOutputStream is not set to a valid stream, the class will write to this property when an empty string is passed to the SaveAttachment method.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

Binary String

AttachmentDescription Property (SecurePDF_PDFEdit Class)

A textual description of the attachment.

Object Oriented Interface

public function getAttachmentDescription($attachmentindex);
public function setAttachmentDescription($attachmentindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 5 , $attachmentindex);
securepdf_pdfedit_set($res, 5, $value , $attachmentindex);

Default Value

''

Remarks

A textual description of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentFileName Property (SecurePDF_PDFEdit Class)

The path and filename of the attachment.

Object Oriented Interface

public function getAttachmentFileName($attachmentindex);
public function setAttachmentFileName($attachmentindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 6 , $attachmentindex);
securepdf_pdfedit_set($res, 6, $value , $attachmentindex);

Default Value

''

Remarks

The path and filename of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentModificationDate Property (SecurePDF_PDFEdit Class)

The date and time of the file's last modification.

Object Oriented Interface

public function getAttachmentModificationDate($attachmentindex);
public function setAttachmentModificationDate($attachmentindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 8 , $attachmentindex);
securepdf_pdfedit_set($res, 8, $value , $attachmentindex);

Default Value

''

Remarks

The date and time of the file's last modification.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (SecurePDF_PDFEdit Class)

The name of the attachment.

Object Oriented Interface

public function getAttachmentName($attachmentindex);
public function setAttachmentName($attachmentindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 9 , $attachmentindex);
securepdf_pdfedit_set($res, 9, $value , $attachmentindex);

Default Value

''

Remarks

The name of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentSize Property (SecurePDF_PDFEdit Class)

The attachment's size in bytes.

Object Oriented Interface

public function getAttachmentSize($attachmentindex);

Procedural Interface

securepdf_pdfedit_get($res, 11 , $attachmentindex);

Default Value

0

Remarks

The attachment's size in bytes.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only and not available at design time.

Data Type

Long64

DecryptionCertEffectiveDate Property (SecurePDF_PDFEdit Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getDecryptionCertEffectiveDate();

Procedural Interface

securepdf_pdfedit_get($res, 12 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertExpirationDate Property (SecurePDF_PDFEdit Class)

The date on which the certificate expires.

Object Oriented Interface

public function getDecryptionCertExpirationDate();

Procedural Interface

securepdf_pdfedit_get($res, 13 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertExtendedKeyUsage Property (SecurePDF_PDFEdit Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getDecryptionCertExtendedKeyUsage();

Procedural Interface

securepdf_pdfedit_get($res, 14 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only and not available at design time.

Data Type

String

DecryptionCertFingerprint Property (SecurePDF_PDFEdit Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getDecryptionCertFingerprint();

Procedural Interface

securepdf_pdfedit_get($res, 15 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only and not available at design time.

Data Type

String

DecryptionCertFingerprintSHA1 Property (SecurePDF_PDFEdit Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getDecryptionCertFingerprintSHA1();

Procedural Interface

securepdf_pdfedit_get($res, 16 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only and not available at design time.

Data Type

String

DecryptionCertFingerprintSHA256 Property (SecurePDF_PDFEdit Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getDecryptionCertFingerprintSHA256();

Procedural Interface

securepdf_pdfedit_get($res, 17 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only and not available at design time.

Data Type

String

DecryptionCertIssuer Property (SecurePDF_PDFEdit Class)

The issuer of the certificate.

Object Oriented Interface

public function getDecryptionCertIssuer();

Procedural Interface

securepdf_pdfedit_get($res, 18 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPrivateKey Property (SecurePDF_PDFEdit Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getDecryptionCertPrivateKey();

Procedural Interface

securepdf_pdfedit_get($res, 19 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The DecryptionCertPrivateKey may be available but not exportable. In this case, DecryptionCertPrivateKey returns an empty string.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPrivateKeyAvailable Property (SecurePDF_PDFEdit Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getDecryptionCertPrivateKeyAvailable();

Procedural Interface

securepdf_pdfedit_get($res, 20 );

Default Value

false

Remarks

Whether a DecryptionCertPrivateKey is available for the selected certificate. If DecryptionCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only and not available at design time.

Data Type

Boolean

DecryptionCertPrivateKeyContainer Property (SecurePDF_PDFEdit Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getDecryptionCertPrivateKeyContainer();

Procedural Interface

securepdf_pdfedit_get($res, 21 );

Default Value

''

Remarks

The name of the DecryptionCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKey Property (SecurePDF_PDFEdit Class)

The public key of the certificate.

Object Oriented Interface

public function getDecryptionCertPublicKey();

Procedural Interface

securepdf_pdfedit_get($res, 22 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKeyAlgorithm Property (SecurePDF_PDFEdit Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getDecryptionCertPublicKeyAlgorithm();

Procedural Interface

securepdf_pdfedit_get($res, 23 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertPublicKeyLength Property (SecurePDF_PDFEdit Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getDecryptionCertPublicKeyLength();

Procedural Interface

securepdf_pdfedit_get($res, 24 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only and not available at design time.

Data Type

Integer

DecryptionCertSerialNumber Property (SecurePDF_PDFEdit Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getDecryptionCertSerialNumber();

Procedural Interface

securepdf_pdfedit_get($res, 25 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertSignatureAlgorithm Property (SecurePDF_PDFEdit Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getDecryptionCertSignatureAlgorithm();

Procedural Interface

securepdf_pdfedit_get($res, 26 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertStore Property (SecurePDF_PDFEdit Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getDecryptionCertStore();
public function setDecryptionCertStore($value);

Procedural Interface

securepdf_pdfedit_get($res, 27 );
securepdf_pdfedit_set($res, 27, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The DecryptionCertStoreType property denotes the type of the certificate store specified by DecryptionCertStore. If the store is password-protected, specify the password in DecryptionCertStorePassword.

DecryptionCertStore is used in conjunction with the DecryptionCertSubject property to specify client certificates. If DecryptionCertStore has a value, and DecryptionCertSubject or DecryptionCertEncoded is set, a search for a certificate is initiated. Please see the DecryptionCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is not available at design time.

Data Type

Binary String

DecryptionCertStorePassword Property (SecurePDF_PDFEdit Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getDecryptionCertStorePassword();
public function setDecryptionCertStorePassword($value);

Procedural Interface

securepdf_pdfedit_get($res, 28 );
securepdf_pdfedit_set($res, 28, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is not available at design time.

Data Type

String

DecryptionCertStoreType Property (SecurePDF_PDFEdit Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getDecryptionCertStoreType();
public function setDecryptionCertStoreType($value);

Procedural Interface

securepdf_pdfedit_get($res, 29 );
securepdf_pdfedit_set($res, 29, $value );

Possible Values

PDFEDIT_DECRYPTIONCERTSTORETYPE_USER(0), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_MACHINE(1), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PFXFILE(2), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PFXBLOB(3), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_JKSFILE(4), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_JKSBLOB(5), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PEMKEY_FILE(6), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PEMKEY_BLOB(7), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_P7BFILE(11), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_P7BBLOB(12), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PPKFILE(14), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PPKBLOB(15), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_XMLFILE(16), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_XMLBLOB(17), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_JWKFILE(18), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_JWKBLOB(19), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_SECURITY_KEY(20), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_BCFKSFILE(21), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_BCFKSBLOB(22), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_PKCS11(23), 
PDFEDIT_DECRYPTIONCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is not available at design time.

Data Type

Integer

DecryptionCertSubjectAltNames Property (SecurePDF_PDFEdit Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getDecryptionCertSubjectAltNames();

Procedural Interface

securepdf_pdfedit_get($res, 30 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertThumbprintMD5 Property (SecurePDF_PDFEdit Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintMD5();

Procedural Interface

securepdf_pdfedit_get($res, 31 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertThumbprintSHA1 Property (SecurePDF_PDFEdit Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintSHA1();

Procedural Interface

securepdf_pdfedit_get($res, 32 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertThumbprintSHA256 Property (SecurePDF_PDFEdit Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getDecryptionCertThumbprintSHA256();

Procedural Interface

securepdf_pdfedit_get($res, 33 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertUsage Property (SecurePDF_PDFEdit Class)

The text description of UsageFlags .

Object Oriented Interface

public function getDecryptionCertUsage();

Procedural Interface

securepdf_pdfedit_get($res, 34 );

Default Value

''

Remarks

The text description of DecryptionCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only and not available at design time.

Data Type

String

DecryptionCertUsageFlags Property (SecurePDF_PDFEdit Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getDecryptionCertUsageFlags();

Procedural Interface

securepdf_pdfedit_get($res, 35 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of DecryptionCertUsageFlags is a combination of the following flags:

Please see the DecryptionCertUsage property for a text representation of DecryptionCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only and not available at design time.

Data Type

Integer

DecryptionCertVersion Property (SecurePDF_PDFEdit Class)

The certificate's version number.

Object Oriented Interface

public function getDecryptionCertVersion();

Procedural Interface

securepdf_pdfedit_get($res, 36 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only and not available at design time.

Data Type

String

DecryptionCertSubject Property (SecurePDF_PDFEdit Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getDecryptionCertSubject();
public function setDecryptionCertSubject($value);

Procedural Interface

securepdf_pdfedit_get($res, 37 );
securepdf_pdfedit_set($res, 37, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is not available at design time.

Data Type

String

DecryptionCertEncoded Property (SecurePDF_PDFEdit Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getDecryptionCertEncoded();
public function setDecryptionCertEncoded($value);

Procedural Interface

securepdf_pdfedit_get($res, 38 );
securepdf_pdfedit_set($res, 38, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The DecryptionCertStore and DecryptionCertSubject properties also may be used to specify a certificate.

When DecryptionCertEncoded is set, a search is initiated in the current DecryptionCertStore for the private key of the certificate. If the key is found, DecryptionCertSubject is updated to reflect the full subject of the selected certificate; otherwise, DecryptionCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

FontColor Property (SecurePDF_PDFEdit Class)

The color of the current font in hexadecimal format.

Object Oriented Interface

public function getFontColor();

Procedural Interface

securepdf_pdfedit_get($res, 39 );

Default Value

'#000000'

Remarks

The color of the current font in hexadecimal format.

This property is read-only and not available at design time.

Data Type

String

FontName Property (SecurePDF_PDFEdit Class)

The name of the current font.

Object Oriented Interface

public function getFontName();

Procedural Interface

securepdf_pdfedit_get($res, 40 );

Default Value

'Arial'

Remarks

The name of the current font.

This property is read-only and not available at design time.

Data Type

String

FontSize Property (SecurePDF_PDFEdit Class)

The size of the current font in points.

Object Oriented Interface

public function getFontSize();

Procedural Interface

securepdf_pdfedit_get($res, 41 );

Default Value

'12'

Remarks

The size of the current font in points.

This property is read-only and not available at design time.

Data Type

String

FontStyle Property (SecurePDF_PDFEdit Class)

The style of the current font.

Object Oriented Interface

public function getFontStyle();

Procedural Interface

securepdf_pdfedit_get($res, 42 );

Default Value

''

Remarks

The style of the current font.

This property is read-only and not available at design time.

Data Type

String

InputData Property (SecurePDF_PDFEdit Class)

A byte array containing the PDF document to process.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

securepdf_pdfedit_get($res, 43 );
securepdf_pdfedit_set($res, 43, $value );

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (SecurePDF_PDFEdit Class)

The PDF file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

securepdf_pdfedit_get($res, 44 );
securepdf_pdfedit_set($res, 44, $value );

Default Value

''

Remarks

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

Data Type

String

MediaCount Property (SecurePDF_PDFEdit Class)

The number of records in the Media arrays.

Object Oriented Interface

public function getMediaCount();
public function setMediaCount($value);

Procedural Interface

securepdf_pdfedit_get($res, 45 );
securepdf_pdfedit_set($res, 45, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MediaContentType
• MediaData
• MediaHeight
• MediaSize
• MediaWidth

The array indices start at 0 and end at MediaCount - 1.

This property is not available at design time.

Data Type

Integer

MediaContentType Property (SecurePDF_PDFEdit Class)

The content type of the media object.

Object Oriented Interface

public function getMediaContentType($mediaindex);

Procedural Interface

securepdf_pdfedit_get($res, 46 , $mediaindex);

Default Value

''

Remarks

The content type of the media object.

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

String

MediaData Property (SecurePDF_PDFEdit Class)

The raw data of the media object.

Object Oriented Interface

public function getMediaData($mediaindex);
public function setMediaData($mediaindex, $value);

Procedural Interface

securepdf_pdfedit_get($res, 47 , $mediaindex);
securepdf_pdfedit_set($res, 47, $value , $mediaindex);

Default Value

''

Remarks

The raw data of the media object.

If MediaOutputStream is not set to a valid stream, the class will write to this property when an empty string is passed to the SaveMedia method.

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is not available at design time.

Data Type

Binary String

MediaHeight Property (SecurePDF_PDFEdit Class)

The height of the media object in pixels (i.

Object Oriented Interface

public function getMediaHeight($mediaindex);

Procedural Interface

securepdf_pdfedit_get($res, 48 , $mediaindex);

Default Value

0

Remarks

The height of the media object in pixels (i.e., its vertical resolution).

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

Integer

MediaSize Property (SecurePDF_PDFEdit Class)

The size of the media in bytes.

Object Oriented Interface

public function getMediaSize($mediaindex);

Procedural Interface

securepdf_pdfedit_get($res, 51 , $mediaindex);

Default Value

0

Remarks

The size of the media in bytes.

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

Long64

MediaWidth Property (SecurePDF_PDFEdit Class)

The width of the media object in pixels (i.

Object Oriented Interface

public function getMediaWidth($mediaindex);

Procedural Interface

securepdf_pdfedit_get($res, 52 , $mediaindex);

Default Value

0

Remarks

The width of the media object in pixels (i.e., its horizontal resolution).

The $mediaindex parameter specifies the index of the item in the array. The size of the array is controlled by the MediaCount property.

This property is read-only and not available at design time.

Data Type

Integer

NewPageHandle Property (SecurePDF_PDFEdit Class)

A handle, a unique identifier of the underlying property object.

Object Oriented Interface

public function getNewPageHandle();
public function setNewPageHandle($value);

Procedural Interface

securepdf_pdfedit_get($res, 53 );
securepdf_pdfedit_set($res, 53, $value );

Default Value

0

Remarks

A handle, a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When a handle of one object is passed to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such an operation.

Example: dest.setNewPageHandle(src.getSelectedPageHandle());

This property is not available at design time.

Data Type

Long64

NewPageHeight Property (SecurePDF_PDFEdit Class)

The height of the page in points.

Object Oriented Interface

public function getNewPageHeight();

Procedural Interface

securepdf_pdfedit_get($res, 54 );

Default Value

'0'

Remarks

The height of the page in points. Both integer and decimal values are supported.

This property is read-only and not available at design time.

Data Type

String

NewPageRotate Property (SecurePDF_PDFEdit Class)

The rotation angle of the page in degrees.

Object Oriented Interface

public function getNewPageRotate();

Procedural Interface

securepdf_pdfedit_get($res, 55 );

Default Value

0

Remarks

The rotation angle of the page in degrees.

This property is read-only and not available at design time.

Data Type

Integer

NewPageWidth Property (SecurePDF_PDFEdit Class)

The width of the page in points.

Object Oriented Interface

public function getNewPageWidth();

Procedural Interface

securepdf_pdfedit_get($res, 56 );

Default Value

'0'

Remarks

The width of the page in points. Both integer and decimal values are supported.

This property is read-only and not available at design time.

Data Type

String

OutputData Property (SecurePDF_PDFEdit Class)

A byte array containing the PDF document after processing.

Object Oriented Interface

public function getOutputData();

Procedural Interface

securepdf_pdfedit_get($res, 57 );

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 and not available at design time.

Data Type

Byte Array

OutputFile Property (SecurePDF_PDFEdit Class)

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

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

securepdf_pdfedit_get($res, 58 );
securepdf_pdfedit_set($res, 58, $value );

Default Value

''

Remarks

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

Data Type

String

Overwrite Property (SecurePDF_PDFEdit Class)

Whether or not the class should overwrite files.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

securepdf_pdfedit_get($res, 59 );
securepdf_pdfedit_set($res, 59, $value );

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.

Data Type

Boolean

Password Property (SecurePDF_PDFEdit Class)

The password to decrypt the document with.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

securepdf_pdfedit_get($res, 60 );
securepdf_pdfedit_set($res, 60, $value );

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.

Data Type

String

PositionPageIndex Property (SecurePDF_PDFEdit Class)

The index of the current page in the PDF document.

Object Oriented Interface

public function getPositionPageIndex();

Procedural Interface

securepdf_pdfedit_get($res, 61 );

Default Value

0

Remarks

The index of the current page in the PDF document.

This property is read-only and not available at design time.

Data Type

Integer

PositionX Property (SecurePDF_PDFEdit Class)

The X coordinate of the current position on the page.

Object Oriented Interface

public function getPositionX();

Procedural Interface

securepdf_pdfedit_get($res, 62 );

Default Value

'0'

Remarks

The X coordinate of the current position on the page.

This property is read-only and not available at design time.

Data Type

String

PositionY Property (SecurePDF_PDFEdit Class)

The Y coordinate of the current position on the page.

Object Oriented Interface

public function getPositionY();

Procedural Interface

securepdf_pdfedit_get($res, 63 );

Default Value

'0'

Remarks

The Y coordinate of the current position on the page.

This property is read-only and not available at design time.

Data Type

String

SelectedPageHandle Property (SecurePDF_PDFEdit Class)

A handle, a unique identifier of the underlying property object.

Object Oriented Interface

public function getSelectedPageHandle();

Procedural Interface

securepdf_pdfedit_get($res, 64 );

Default Value

0

Remarks

A handle, a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When a handle of one object is passed to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such an operation.

Example: dest.setNewPageHandle(src.getSelectedPageHandle());

This property is read-only and not available at design time.

Data Type

Long64

SelectedPageHeight Property (SecurePDF_PDFEdit Class)

The height of the page in points.

Object Oriented Interface

public function getSelectedPageHeight();

Procedural Interface

securepdf_pdfedit_get($res, 65 );

Default Value

'0'

Remarks

The height of the page in points. Both integer and decimal values are supported.

This property is read-only and not available at design time.

Data Type

String

SelectedPageRotate Property (SecurePDF_PDFEdit Class)

The rotation angle of the page in degrees.

Object Oriented Interface

public function getSelectedPageRotate();

Procedural Interface

securepdf_pdfedit_get($res, 66 );

Default Value

0

Remarks

The rotation angle of the page in degrees.

This property is read-only and not available at design time.

Data Type

Integer

SelectedPageWidth Property (SecurePDF_PDFEdit Class)

The width of the page in points.

Object Oriented Interface

public function getSelectedPageWidth();

Procedural Interface

securepdf_pdfedit_get($res, 67 );

Default Value

'0'

Remarks

The width of the page in points. Both integer and decimal values are supported.

This property is read-only and not available at design time.

Data Type

String

AddAttachment Method (SecurePDF_PDFEdit Class)

Adds an attachment to the document.

Object Oriented Interface

public function doAddAttachment($filename, $description);

Procedural Interface

securepdf_pdfedit_do_addattachment($res, $filename, $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 (SecurePDF_PDFEdit Class)

Adds a bitmap image to the document.

Object Oriented Interface

public function doAddBitmap($format, $bitmapbytes, $width, $height);

Procedural Interface

securepdf_pdfedit_do_addbitmap($res, $format, $bitmapbytes, $width, $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 Width and Height parameters specify the original width and height of the bitmap in pixels.

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 (SecurePDF_PDFEdit Class)

Adds a vector drawing to the document.

Object Oriented Interface

public function doAddDrawing($format, $drawingbytes);

Procedural Interface

securepdf_pdfedit_do_adddrawing($res, $format, $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 (SecurePDF_PDFEdit Class)

Adds a block of text to the document.

Object Oriented Interface

public function doAddTextBlock($text);

Procedural Interface

securepdf_pdfedit_do_addtextblock($res, $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 (SecurePDF_PDFEdit Class)

Appends a page to the end of the document.

Object Oriented Interface

public function doAppendPage();

Procedural Interface

securepdf_pdfedit_do_appendpage($res);

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 (SecurePDF_PDFEdit Class)

Closes the opened document.

Object Oriented Interface

public function doClose();

Procedural Interface

securepdf_pdfedit_do_close($res);

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 (SecurePDF_PDFEdit Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

securepdf_pdfedit_do_config($res, $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 (SecurePDF_PDFEdit Class)

Converts the document to a different format.

Object Oriented Interface

public function doConvert($format);

Procedural Interface

securepdf_pdfedit_do_convert($res, $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 (SecurePDF_PDFEdit Class)

Creates a new PDF document.

Object Oriented Interface

public function doCreateNew();

Procedural Interface

securepdf_pdfedit_do_createnew($res);

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 (SecurePDF_PDFEdit Class)

Checks whether the document is encrypted.

Object Oriented Interface

public function doEncrypted();

Procedural Interface

securepdf_pdfedit_do_encrypted($res);

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 (SecurePDF_PDFEdit Class)

Returns the value of a document property.

Object Oriented Interface

public function doGetDocumentProperty($documentproperty);

Procedural Interface

securepdf_pdfedit_do_getdocumentproperty($res, $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 (SecurePDF_PDFEdit Class)

Returns the entire text content contained in the document.

Object Oriented Interface

public function doGetDocumentText();

Procedural Interface

securepdf_pdfedit_do_getdocumenttext($res);

Remarks

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

GetPageProperty Method (SecurePDF_PDFEdit Class)

Returns the value of a page property.

Object Oriented Interface

public function doGetPageProperty($pageindex, $pageproperty);

Procedural Interface

securepdf_pdfedit_do_getpageproperty($res, $pageindex, $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 (SecurePDF_PDFEdit Class)

Returns the text content residing on a specific page.

Object Oriented Interface

public function doGetPageText($pageindex);

Procedural Interface

securepdf_pdfedit_do_getpagetext($res, $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 (SecurePDF_PDFEdit Class)

Inserts a page into the document.

Object Oriented Interface

public function doInsertPage($pageindex);

Procedural Interface

securepdf_pdfedit_do_insertpage($res, $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 (SecurePDF_PDFEdit Class)

Opens the document for processing.

Object Oriented Interface

public function doOpen();

Procedural Interface

securepdf_pdfedit_do_open($res);

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 (SecurePDF_PDFEdit Class)

Removes an attachment from the document.

Object Oriented Interface

public function doRemoveAttachment($index);

Procedural Interface

securepdf_pdfedit_do_removeattachment($res, $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 (SecurePDF_PDFEdit Class)

Removes a page from the document.

Object Oriented Interface

public function doRemovePage($pageindex);

Procedural Interface

securepdf_pdfedit_do_removepage($res, $pageindex);

Remarks

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

RemovePages Method (SecurePDF_PDFEdit Class)

Removes a subset of pages from the document.

Object Oriented Interface

public function doRemovePages($pageindex, $count);

Procedural Interface

securepdf_pdfedit_do_removepages($res, $pageindex, $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 (SecurePDF_PDFEdit Class)

Replaces text in the document.

Object Oriented Interface

public function doReplaceDocumentText($pattern, $value);

Procedural Interface

securepdf_pdfedit_do_replacedocumenttext($res, $pattern, $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 (SecurePDF_PDFEdit Class)

Replaces text on a page.

Object Oriented Interface

public function doReplacePageText($pageindex, $pattern, $value);

Procedural Interface

securepdf_pdfedit_do_replacepagetext($res, $pageindex, $pattern, $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 (SecurePDF_PDFEdit Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

securepdf_pdfedit_do_reset($res);

Remarks

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

SaveAttachment Method (SecurePDF_PDFEdit Class)

Saves a PDF attachment to a file.

Object Oriented Interface

public function doSaveAttachment($index, $filename);

Procedural Interface

securepdf_pdfedit_do_saveattachment($res, $index, $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 (SecurePDF_PDFEdit Class)

Saves a media object to a file.

Object Oriented Interface

public function doSaveMedia($index, $filename);

Procedural Interface

securepdf_pdfedit_do_savemedia($res, $index, $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 (SecurePDF_PDFEdit Class)

Selects a page.

Object Oriented Interface

public function doSelectPage($pageindex);

Procedural Interface

securepdf_pdfedit_do_selectpage($res, $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 (SecurePDF_PDFEdit Class)

Sets the object alignment for subsequent insertion operations.

Object Oriented Interface

public function doSetAlignment($horizontalalignment, $verticalalignment);

Procedural Interface

securepdf_pdfedit_do_setalignment($res, $horizontalalignment, $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 (SecurePDF_PDFEdit Class)

Sets the value of a document property.

Object Oriented Interface

public function doSetDocumentProperty($documentproperty, $value);

Procedural Interface

securepdf_pdfedit_do_setdocumentproperty($res, $documentproperty, $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 (SecurePDF_PDFEdit Class)

Sets the font properties to be applied to text.

Object Oriented Interface

public function doSetFont($name, $size, $style, $color);

Procedural Interface

securepdf_pdfedit_do_setfont($res, $name, $size, $style, $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

If only one transparency figure is provided, it applies to both pen and brush.

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 (SecurePDF_PDFEdit Class)

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

Object Oriented Interface

public function doSetPosition($pageindex, $x, $y);

Procedural Interface

securepdf_pdfedit_do_setposition($res, $pageindex, $x, $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 (SecurePDF_PDFEdit Class)

Sets the object transformation parameters for subsequent insertion operations.

Object Oriented Interface

public function doSetTransform($translationx, $translationy, $scalex, $scaley, $rotation, $skewa, $skewb);

Procedural Interface

securepdf_pdfedit_do_settransform($res, $translationx, $translationy, $scalex, $scaley, $rotation, $skewa, $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 (SecurePDF_PDFEdit Class)

Fired when the document has been loaded into memory.

Object Oriented Interface

public function fireDocumentInfo($param);

Procedural Interface

securepdf_pdfedit_register_callback($res, 1, array($this, 'fireDocumentInfo'));

Parameter List

 '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 (SecurePDF_PDFEdit Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

securepdf_pdfedit_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 (SecurePDF_PDFEdit Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

securepdf_pdfedit_register_callback($res, 3, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 '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 (SecurePDF_PDFEdit Class)

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

Object Oriented Interface

public function firePassword($param);

Procedural Interface

securepdf_pdfedit_register_callback($res, 4, array($this, 'firePassword'));

Parameter List

 'available'
 '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 (SecurePDF_PDFEdit Class)

Fired for each recipient certificate of the encrypted document.

Object Oriented Interface

public function fireRecipientInfo($param);

Procedural Interface

securepdf_pdfedit_register_callback($res, 5, array($this, 'fireRecipientInfo'));

Parameter List

 'issuer'
 'serialnumber'
 'subjectkeyidentifier'
 'available'
 '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 (SecurePDF_PDFEdit Class)

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

Object Oriented Interface

public function fireReplaceText($param);

Procedural Interface

securepdf_pdfedit_register_callback($res, 6, array($this, 'fireReplaceText'));

Parameter List

 'pageindex'
 'entryindex'
 'offset'
 'pattern'
 'substitute'
 '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.

Config Settings (PDFEdit Class)

The class accepts one or more of the following configuration settings. Configuration 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.

PDFEdit Config Settings

Base Config Settings

Trappable Errors (PDFEdit Class)

PDFEdit Errors

PDF Errors

Parsing Errors