PDFEdit Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

PDFEdit

Remarks

The PDFEdit control 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 and Replace

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 control will fire the ReplaceText event during this operation, providing the flexibility of skipping certain text blocks or updating the replacement string on the fly.

Text Extraction

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.

To split the document in two, create two copies first. Then remove the respective subsets of pages from each of the copies using the RemovePages method.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AttachmentCount Property (PDFEdit Control)

The number of records in the Attachment arrays.

Syntax

pdfeditcontrol.AttachmentCount[=integer]

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 (PDFEdit Control)

The content type of the attachment.

Syntax

pdfeditcontrol.AttachmentContentType(AttachmentIndex)[=string]

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 (PDFEdit Control)

The creation date of the attachment.

Syntax

pdfeditcontrol.AttachmentCreationDate(AttachmentIndex)[=string]

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 (PDFEdit Control)

The raw data of the attachment.

Syntax

pdfeditcontrol.AttachmentData(AttachmentIndex)[=string]

Default Value

""

Remarks

The raw data of the attachment.

If AttachmentOutputStream is not set to a valid stream, the control 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttachmentDataB.

This property is not available at design time.

Data Type

Binary String

AttachmentDescription Property (PDFEdit Control)

A textual description of the attachment.

Syntax

pdfeditcontrol.AttachmentDescription(AttachmentIndex)[=string]

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 (PDFEdit Control)

The path and filename of the attachment.

Syntax

pdfeditcontrol.AttachmentFileName(AttachmentIndex)[=string]

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.AttachmentModificationDate(AttachmentIndex)[=string]

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 (PDFEdit Control)

The name of the attachment.

Syntax

pdfeditcontrol.AttachmentName(AttachmentIndex)[=string]

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 (PDFEdit Control)

The attachment's size in bytes.

Syntax

pdfeditcontrol.AttachmentSize(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 (PDFEdit Control)

The date on which this certificate becomes valid.

Syntax

pdfeditcontrol.DecryptionCertEffectiveDate

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 (PDFEdit Control)

The date on which the certificate expires.

Syntax

pdfeditcontrol.DecryptionCertExpirationDate

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 (PDFEdit Control)

A comma-delimited list of extended key usage identifiers.

Syntax

pdfeditcontrol.DecryptionCertExtendedKeyUsage

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertFingerprint

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertFingerprintSHA1

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertFingerprintSHA256

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 (PDFEdit Control)

The issuer of the certificate.

Syntax

pdfeditcontrol.DecryptionCertIssuer

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 (PDFEdit Control)

The private key of the certificate (if available).

Syntax

pdfeditcontrol.DecryptionCertPrivateKey

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 (PDFEdit Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

pdfeditcontrol.DecryptionCertPrivateKeyAvailable

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertPrivateKeyContainer

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 (PDFEdit Control)

The public key of the certificate.

Syntax

pdfeditcontrol.DecryptionCertPublicKey

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertPublicKeyAlgorithm

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertPublicKeyLength

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 (PDFEdit Control)

The serial number of the certificate encoded as a string.

Syntax

pdfeditcontrol.DecryptionCertSerialNumber

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 (PDFEdit Control)

The text description of the certificate's signature algorithm.

Syntax

pdfeditcontrol.DecryptionCertSignatureAlgorithm

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 (PDFEdit Control)

The name of the certificate store for the client certificate.

Syntax

pdfeditcontrol.DecryptionCertStore[=string]

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DecryptionCertStoreB.

This property is not available at design time.

Data Type

Binary String

DecryptionCertStorePassword Property (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertStorePassword[=string]

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 (PDFEdit Control)

The type of certificate store for this certificate.

Syntax

pdfeditcontrol.DecryptionCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.DecryptionCertSubjectAltNames

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 (PDFEdit Control)

The MD5 hash of the certificate.

Syntax

pdfeditcontrol.DecryptionCertThumbprintMD5

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 (PDFEdit Control)

The SHA-1 hash of the certificate.

Syntax

pdfeditcontrol.DecryptionCertThumbprintSHA1

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 (PDFEdit Control)

The SHA-256 hash of the certificate.

Syntax

pdfeditcontrol.DecryptionCertThumbprintSHA256

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 (PDFEdit Control)

The text description of UsageFlags .

Syntax

pdfeditcontrol.DecryptionCertUsage

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 (PDFEdit Control)

The flags that show intended use for the certificate.

Syntax

pdfeditcontrol.DecryptionCertUsageFlags

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 (PDFEdit Control)

The certificate's version number.

Syntax

pdfeditcontrol.DecryptionCertVersion

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 (PDFEdit Control)

The subject of the certificate used for client authentication.

Syntax

pdfeditcontrol.DecryptionCertSubject[=string]

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 (PDFEdit Control)

The certificate (PEM/Base64 encoded).

Syntax

pdfeditcontrol.DecryptionCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DecryptionCertEncodedB.

This property is not available at design time.

Data Type

Binary String

FontColor Property (PDFEdit Control)

The color of the current font in hexadecimal format.

Syntax

pdfeditcontrol.FontColor

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 (PDFEdit Control)

The name of the current font.

Syntax

pdfeditcontrol.FontName

Default Value

"Helvetica"

Remarks

The name of the current font.

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

Data Type

String

FontSize Property (PDFEdit Control)

The size of the current font in points.

Syntax

pdfeditcontrol.FontSize

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 (PDFEdit Control)

The style of the current font.

Syntax

pdfeditcontrol.FontStyle

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 (PDFEdit Control)

A byte array containing the PDF document to process.

Syntax

pdfeditcontrol.InputData[=byte array]

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 (PDFEdit Control)

The PDF file to process.

Syntax

pdfeditcontrol.InputFile[=string]

Default Value

""

Remarks

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

Data Type

String

MediaCount Property (PDFEdit Control)

The number of records in the Media arrays.

Syntax

pdfeditcontrol.MediaCount[=integer]

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 (PDFEdit Control)

The content type of the media object.

Syntax

pdfeditcontrol.MediaContentType(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 (PDFEdit Control)

The raw data of the media object.

Syntax

pdfeditcontrol.MediaData(MediaIndex)[=string]

Default Value

""

Remarks

The raw data of the media object.

If MediaOutputStream is not set to a valid stream, the control 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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .MediaDataB.

This property is not available at design time.

Data Type

Binary String

MediaHeight Property (PDFEdit Control)

The height of the media object in pixels (i.

Syntax

pdfeditcontrol.MediaHeight(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 (PDFEdit Control)

The size of the media in bytes.

Syntax

pdfeditcontrol.MediaSize(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 (PDFEdit Control)

The width of the media object in pixels (i.

Syntax

pdfeditcontrol.MediaWidth(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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.NewPageHandle[=long64]

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 (PDFEdit Control)

The height of the page in points.

Syntax

pdfeditcontrol.NewPageHeight

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 (PDFEdit Control)

The rotation angle of the page in degrees.

Syntax

pdfeditcontrol.NewPageRotate

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 (PDFEdit Control)

The width of the page in points.

Syntax

pdfeditcontrol.NewPageWidth

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 (PDFEdit Control)

A byte array containing the PDF document after processing.

Syntax

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

Data Type

Byte Array

OutputFile Property (PDFEdit Control)

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

Syntax

pdfeditcontrol.OutputFile[=string]

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 (PDFEdit Control)

Whether or not the control should overwrite files.

Syntax

pdfeditcontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property indicates whether or not the control 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 (PDFEdit Control)

The password to decrypt the document with.

Syntax

pdfeditcontrol.Password[=string]

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 (PDFEdit Control)

The index of the current page in the PDF document.

Syntax

pdfeditcontrol.PositionPageIndex

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 (PDFEdit Control)

The X coordinate of the current position on the page.

Syntax

pdfeditcontrol.PositionX

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 (PDFEdit Control)

The Y coordinate of the current position on the page.

Syntax

pdfeditcontrol.PositionY

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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.SelectedPageHandle

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 (PDFEdit Control)

The height of the page in points.

Syntax

pdfeditcontrol.SelectedPageHeight

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 (PDFEdit Control)

The rotation angle of the page in degrees.

Syntax

pdfeditcontrol.SelectedPageRotate

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 (PDFEdit Control)

The width of the page in points.

Syntax

pdfeditcontrol.SelectedPageWidth

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 (PDFEdit Control)

Adds an attachment to the document.

Syntax

pdfeditcontrol.AddAttachment 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 (PDFEdit Control)

Adds a bitmap image to the document.

Syntax

pdfeditcontrol.AddBitmap 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 (PDFEdit Control)

Adds a vector drawing to the document.

Syntax

pdfeditcontrol.AddDrawing 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 (PDFEdit Control)

Adds a block of text to the document.

Syntax

pdfeditcontrol.AddTextBlock 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 Control)

Appends a page to the end of the document.

Syntax

pdfeditcontrol.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 control 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 Control)

Closes the opened document.

Syntax

pdfeditcontrol.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 Control)

Sets or retrieves a configuration setting.

Syntax

pdfeditcontrol.Config ConfigurationString

Remarks

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

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

Converts the document to a different format.

Syntax

pdfeditcontrol.Convert 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 Control)

Creates a new PDF document.

Syntax

pdfeditcontrol.CreateNew 

Remarks

This method is used to create a blank PDF document with one empty page. Having created the baseline document, use the control's methods to add objects to it.

Encrypted Method (PDFEdit Control)

Checks whether the document is encrypted.

Syntax

pdfeditcontrol.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 Control)

Returns the value of a document property.

Syntax

pdfeditcontrol.GetDocumentProperty 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 Control)

Returns the entire text content contained in the document.

Syntax

pdfeditcontrol.GetDocumentText 

Remarks

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

GetPageProperty Method (PDFEdit Control)

Returns the value of a page property.

Syntax

pdfeditcontrol.GetPageProperty 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 (PDFEdit Control)

Returns the text content residing on a specific page.

Syntax

pdfeditcontrol.GetPageText 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 Control)

Inserts a page into the document.

Syntax

pdfeditcontrol.InsertPage 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 control 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 Control)

Opens the document for processing.

Syntax

pdfeditcontrol.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 Control)

Removes an attachment from the document.

Syntax

pdfeditcontrol.RemoveAttachment 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 Control)

Removes a page from the document.

Syntax

pdfeditcontrol.RemovePage PageIndex

Remarks

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

RemovePages Method (PDFEdit Control)

Removes a subset of pages from the document.

Syntax

pdfeditcontrol.RemovePages 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 (PDFEdit Control)

Replaces text in the document.

Syntax

pdfeditcontrol.ReplaceDocumentText 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 (PDFEdit Control)

Replaces text on a page.

Syntax

pdfeditcontrol.ReplacePageText 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 (PDFEdit Control)

Resets the control.

Syntax

pdfeditcontrol.Reset 

Remarks

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

SaveAttachment Method (PDFEdit Control)

Saves a PDF attachment to a file.

Syntax

pdfeditcontrol.SaveAttachment 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 (PDFEdit Control)

Saves a media object to a file.

Syntax

pdfeditcontrol.SaveMedia 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 (PDFEdit Control)

Selects a page.

Syntax

pdfeditcontrol.SelectPage 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 Control)

Sets the object alignment for subsequent insertion operations.

Syntax

pdfeditcontrol.SetAlignment 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 (PDFEdit Control)

Sets the value of a document property.

Syntax

pdfeditcontrol.SetDocumentProperty 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 (PDFEdit Control)

Sets the font properties to be applied to text.

Syntax

pdfeditcontrol.SetFont 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 (PDFEdit Control)

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

Syntax

pdfeditcontrol.SetPosition 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 (PDFEdit Control)

Sets the object transformation parameters for subsequent insertion operations.

Syntax

pdfeditcontrol.SetTransform 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 (PDFEdit Control)

Fired when the document has been loaded into memory.

Syntax

Sub pdfeditcontrol_DocumentInfo(PageCount As Integer)

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

Fired when information is available about errors during data delivery.

Syntax

Sub pdfeditcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 (PDFEdit Control)

Fired once for each log message.

Syntax

Sub pdfeditcontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. 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 Control)

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

Syntax

Sub pdfeditcontrol_Password(Available As Boolean, Cancel As Boolean)

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 control 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 control will stop firing this event to request a password.

RecipientInfo Event (PDFEdit Control)

Fired for each recipient certificate of the encrypted document.

Syntax

Sub pdfeditcontrol_RecipientInfo(Issuer As String, SerialNumber As String, SubjectKeyIdentifier As String, Available As Boolean, Cancel As Boolean)

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 control 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 control 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 Control)

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

Syntax

Sub pdfeditcontrol_ReplaceText(PageIndex As Integer, EntryIndex As Integer, Offset As Integer, Pattern As String, Substitute As String, Skip As Boolean)

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 control will skip substituting this entry and proceed to the next one.

Config Settings (PDFEdit Control)

The control 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 control, access to these internal properties is provided through the Config method.

PDFEdit Config Settings

Base Config Settings

Trappable Errors (PDFEdit Control)

PDFEdit Errors

PDF Errors

Parsing Errors