PDFText Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

pdfsdk.PDFText

Remarks

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

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AttachmentCount Property (PDFText Component)

The number of records in the Attachment arrays.

Syntax

func (obj *PDFText) AttachmentCount() (int32, error)
func (obj *PDFText) SetAttachmentCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

int32

AttachmentAFRelationship Property (PDFText Component)

The value of the AFRelationship key for the attachment, for example Alternative or Source .

Syntax

func (obj *PDFText) AttachmentAFRelationship(AttachmentIndex int32) (string, error)
func (obj *PDFText) SetAttachmentAFRelationship(AttachmentIndex int32, value string) error

Default Value

""

Remarks

The value of the AFRelationship key for the attachment, for example Alternative or Source.

This key in the file specification dictionary expresses the relationship between the attachment and the document, and it must be set for each attachment added to PDF/A-3 documents.

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

Data Type

string

AttachmentType Property (PDFText Component)

The type of the attachment.

Syntax

func (obj *PDFText) AttachmentType(AttachmentIndex int32) (int32, error)

Possible Values

0   // Generic
1   // ElectronicInvoice

Default Value

0

Remarks

The type of the attachment.

Possible values are:

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.

Data Type

int32

AttachmentContentType Property (PDFText Component)

The content type of the attachment.

Syntax

func (obj *PDFText) AttachmentContentType(AttachmentIndex int32) (string, error)
func (obj *PDFText) SetAttachmentContentType(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentCreationDate Property (PDFText Component)

The creation date of the attachment.

Syntax

func (obj *PDFText) AttachmentCreationDate(AttachmentIndex int32) (string, error)
func (obj *PDFText) SetAttachmentCreationDate(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentData Property (PDFText Component)

The raw data of the attachment.

Syntax

func (obj *PDFText) AttachmentData(AttachmentIndex int32) ([]byte, error)
func (obj *PDFText) SetAttachmentData(AttachmentIndex int32, value []byte) error

Default Value

""

Remarks

The raw data 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.

Data Type

[]byte

AttachmentDescription Property (PDFText Component)

A textual description of the attachment.

Syntax

func (obj *PDFText) AttachmentDescription(AttachmentIndex int32) (string, error)
func (obj *PDFText) SetAttachmentDescription(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentFileName Property (PDFText Component)

The path and filename of the attachment.

Syntax

func (obj *PDFText) AttachmentFileName(AttachmentIndex int32) (string, error)
func (obj *PDFText) SetAttachmentFileName(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentModificationDate Property (PDFText Component)

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

Syntax

func (obj *PDFText) AttachmentModificationDate(AttachmentIndex int32) (string, error)
func (obj *PDFText) SetAttachmentModificationDate(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentName Property (PDFText Component)

The name of the attachment.

Syntax

func (obj *PDFText) AttachmentName(AttachmentIndex int32) (string, error)
func (obj *PDFText) SetAttachmentName(AttachmentIndex int32, value string) error

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.

Data Type

string

AttachmentSize Property (PDFText Component)

The attachment's size in bytes.

Syntax

func (obj *PDFText) AttachmentSize(AttachmentIndex int32) (int64, error)

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.

Data Type

int64

DecryptionCertEffectiveDate Property (PDFText Component)

The date on which this certificate becomes valid.

Syntax

func (obj *PDFText) DecryptionCertEffectiveDate() (string, error)

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.

Data Type

string

DecryptionCertExpirationDate Property (PDFText Component)

The date on which the certificate expires.

Syntax

func (obj *PDFText) DecryptionCertExpirationDate() (string, error)

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.

Data Type

string

DecryptionCertExtendedKeyUsage Property (PDFText Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *PDFText) DecryptionCertExtendedKeyUsage() (string, error)

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.

Data Type

string

DecryptionCertFingerprint Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertFingerprint() (string, error)

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.

Data Type

string

DecryptionCertFingerprintSHA1 Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertFingerprintSHA1() (string, error)

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.

Data Type

string

DecryptionCertFingerprintSHA256 Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertFingerprintSHA256() (string, error)

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.

Data Type

string

DecryptionCertIssuer Property (PDFText Component)

The issuer of the certificate.

Syntax

func (obj *PDFText) DecryptionCertIssuer() (string, error)

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.

Data Type

string

DecryptionCertPrivateKey Property (PDFText Component)

The private key of the certificate (if available).

Syntax

func (obj *PDFText) DecryptionCertPrivateKey() (string, error)

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.

Data Type

string

DecryptionCertPrivateKeyAvailable Property (PDFText Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *PDFText) DecryptionCertPrivateKeyAvailable() (bool, error)

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.

Data Type

bool

DecryptionCertPrivateKeyContainer Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertPrivateKeyContainer() (string, error)

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.

Data Type

string

DecryptionCertPublicKey Property (PDFText Component)

The public key of the certificate.

Syntax

func (obj *PDFText) DecryptionCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

DecryptionCertPublicKeyAlgorithm Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertPublicKeyAlgorithm() (string, error)

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.

Data Type

string

DecryptionCertPublicKeyLength Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertPublicKeyLength() (int32, error)

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.

Data Type

int32

DecryptionCertSerialNumber Property (PDFText Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *PDFText) DecryptionCertSerialNumber() (string, error)

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.

Data Type

string

DecryptionCertSignatureAlgorithm Property (PDFText Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *PDFText) DecryptionCertSignatureAlgorithm() (string, error)

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.

Data Type

string

DecryptionCertStore Property (PDFText Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *PDFText) DecryptionCertStore() ([]byte, error)
func (obj *PDFText) SetDecryptionCertStore(value []byte) error

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

Data Type

[]byte

DecryptionCertStorePassword Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertStorePassword() (string, error)
func (obj *PDFText) SetDecryptionCertStorePassword(value string) error

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.

Data Type

string

DecryptionCertStoreType Property (PDFText Component)

The type of certificate store for this certificate.

Syntax

func (obj *PDFText) DecryptionCertStoreType() (int32, error)
func (obj *PDFText) SetDecryptionCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

DecryptionCertSubjectAltNames Property (PDFText Component)

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

Syntax

func (obj *PDFText) DecryptionCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

DecryptionCertThumbprintMD5 Property (PDFText Component)

The MD5 hash of the certificate.

Syntax

func (obj *PDFText) DecryptionCertThumbprintMD5() (string, error)

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.

Data Type

string

DecryptionCertThumbprintSHA1 Property (PDFText Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *PDFText) DecryptionCertThumbprintSHA1() (string, error)

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.

Data Type

string

DecryptionCertThumbprintSHA256 Property (PDFText Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *PDFText) DecryptionCertThumbprintSHA256() (string, error)

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.

Data Type

string

DecryptionCertUsage Property (PDFText Component)

The text description of UsageFlags .

Syntax

func (obj *PDFText) DecryptionCertUsage() (string, error)

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.

Data Type

string

DecryptionCertUsageFlags Property (PDFText Component)

The flags that show intended use for the certificate.

Syntax

func (obj *PDFText) DecryptionCertUsageFlags() (int32, error)

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.

Data Type

int32

DecryptionCertVersion Property (PDFText Component)

The certificate's version number.

Syntax

func (obj *PDFText) DecryptionCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

DecryptionCertSubject Property (PDFText Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *PDFText) DecryptionCertSubject() (string, error)
func (obj *PDFText) SetDecryptionCertSubject(value string) error

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.

Data Type

string

DecryptionCertEncoded Property (PDFText Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *PDFText) DecryptionCertEncoded() ([]byte, error)
func (obj *PDFText) SetDecryptionCertEncoded(value []byte) error

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.

Data Type

[]byte

InputData Property (PDFText Component)

A byte array containing the PDF document to process.

Syntax

func (obj *PDFText) InputData() ([]byte, error)
func (obj *PDFText) SetInputData(value []byte) error

Remarks

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

Data Type

[]byte

InputFile Property (PDFText Component)

The PDF file to process.

Syntax

func (obj *PDFText) InputFile() (string, error)
func (obj *PDFText) SetInputFile(value string) error

Default Value

""

Remarks

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

Data Type

string

MediaCount Property (PDFText Component)

The number of records in the Media arrays.

Syntax

func (obj *PDFText) MediaCount() (int32, error)
func (obj *PDFText) SetMediaCount(value int32) error

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.

Data Type

int32

MediaContentType Property (PDFText Component)

The content type of the media object.

Syntax

func (obj *PDFText) MediaContentType(MediaIndex int32) (string, error)

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.

Data Type

string

MediaData Property (PDFText Component)

The raw data of the media object.

Syntax

func (obj *PDFText) MediaData(MediaIndex int32) ([]byte, error)
func (obj *PDFText) SetMediaData(MediaIndex int32, value []byte) error

Default Value

""

Remarks

The raw data 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.

Data Type

[]byte

MediaHeight Property (PDFText Component)

The height of the media object in pixels (i.

Syntax

func (obj *PDFText) MediaHeight(MediaIndex int32) (int32, error)

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.

Data Type

int32

MediaSize Property (PDFText Component)

The size of the media in bytes.

Syntax

func (obj *PDFText) MediaSize(MediaIndex int32) (int64, error)

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.

Data Type

int64

MediaWidth Property (PDFText Component)

The width of the media object in pixels (i.

Syntax

func (obj *PDFText) MediaWidth(MediaIndex int32) (int32, error)

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.

Data Type

int32

Password Property (PDFText Component)

The password to decrypt the document with.

Syntax

func (obj *PDFText) Password() (string, error)
func (obj *PDFText) SetPassword(value string) error

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

PDFAConformanceLevel Property (PDFText Component)

The PDF/A conformance level of the document.

Syntax

func (obj *PDFText) PDFAConformanceLevel() (int32, error)
func (obj *PDFText) SetPDFAConformanceLevel(value int32) error

Possible Values

0   // None
1   // A1a
2   // A1b
3   // A2a
4   // A2b
5   // A2u
6   // A3a
7   // A3b
8   // A3u
9   // A4
10   // A4e
11   // A4f

Default Value

0

Remarks

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

Possible values are:

Data Type

int32

Close Method (PDFText Component)

Closes the opened document.

Syntax

func (obj *PDFText) Close() error

Remarks

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

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

Config Method (PDFText Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *PDFText) Config(ConfigurationString string) (string, error)

Remarks

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

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

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

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

Encrypted Method (PDFText Component)

Checks whether the document is encrypted.

Syntax

func (obj *PDFText) Encrypted() (bool, error)

Remarks

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

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

GetDocumentProperty Method (PDFText Component)

Returns the value of a document property.

Syntax

func (obj *PDFText) GetDocumentProperty(DocumentProperty string) (string, error)

Remarks

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

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

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

GetDocumentText Method (PDFText Component)

Returns the entire text content contained in the document.

Syntax

func (obj *PDFText) GetDocumentText() (string, error)

Remarks

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

GetPageProperty Method (PDFText Component)

Returns the value of a page property.

Syntax

func (obj *PDFText) GetPageProperty(PageIndex int32, PageProperty string) (string, error)

Remarks

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

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

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

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

GetPageText Method (PDFText Component)

Returns the text content residing on a specific page.

Syntax

func (obj *PDFText) GetPageText(PageIndex int32) (string, error)

Remarks

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

Open Method (PDFText Component)

Opens the document for processing.

Syntax

func (obj *PDFText) Open() error

Remarks

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

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

Reset Method (PDFText Component)

Resets the class.

Syntax

func (obj *PDFText) Reset() error

Remarks

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

SaveAttachment Method (PDFText Component)

Saves a PDF attachment to a file.

Syntax

func (obj *PDFText) SaveAttachment(Index int32, FileName string) error

Remarks

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

Index is the index of the attachment in the Attachment* properties to be saved.

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

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

SaveMedia Method (PDFText Component)

Saves a media object to a file.

Syntax

func (obj *PDFText) SaveMedia(Index int32, FileName string) error

Remarks

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

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

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

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

DocumentInfo Event (PDFText Component)

Fired when the document has been loaded into memory.

Syntax

// PDFTextDocumentInfoEventArgs carries the PDFText DocumentInfo event's parameters.
type PDFTextDocumentInfoEventArgs struct {...}

func (args *PDFTextDocumentInfoEventArgs) PageCount() int32

// PDFTextDocumentInfoEvent defines the signature of the PDFText DocumentInfo event's handler function.
type PDFTextDocumentInfoEvent func(sender *PDFText, args *PDFTextDocumentInfoEventArgs)

func (obj *PDFText) GetOnDocumentInfoHandler() PDFTextDocumentInfoEvent
func (obj *PDFText) SetOnDocumentInfoHandler(handlerFunc PDFTextDocumentInfoEvent)

Remarks

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

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

PageCount reports the number of pages in the document.

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

Error Event (PDFText Component)

Fired when information is available about errors during data delivery.

Syntax

// PDFTextErrorEventArgs carries the PDFText Error event's parameters.
type PDFTextErrorEventArgs struct {...}

func (args *PDFTextErrorEventArgs) ErrorCode() int32
func (args *PDFTextErrorEventArgs) Description() string

// PDFTextErrorEvent defines the signature of the PDFText Error event's handler function.
type PDFTextErrorEvent func(sender *PDFText, args *PDFTextErrorEventArgs)

func (obj *PDFText) GetOnErrorHandler() PDFTextErrorEvent
func (obj *PDFText) SetOnErrorHandler(handlerFunc PDFTextErrorEvent)

Remarks

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

Fired once for each log message.

Syntax

// PDFTextLogEventArgs carries the PDFText Log event's parameters.
type PDFTextLogEventArgs struct {...}

func (args *PDFTextLogEventArgs) LogLevel() int32
func (args *PDFTextLogEventArgs) Message() string
func (args *PDFTextLogEventArgs) LogType() string

// PDFTextLogEvent defines the signature of the PDFText Log event's handler function.
type PDFTextLogEvent func(sender *PDFText, args *PDFTextLogEventArgs)

func (obj *PDFText) GetOnLogHandler() PDFTextLogEvent
func (obj *PDFText) SetOnLogHandler(handlerFunc PDFTextLogEvent)

Remarks

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

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

Message is the log message.

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

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

Password Event (PDFText Component)

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

Syntax

// PDFTextPasswordEventArgs carries the PDFText Password event's parameters.
type PDFTextPasswordEventArgs struct {...}

func (args *PDFTextPasswordEventArgs) Available() bool
func (args *PDFTextPasswordEventArgs) Cancel() bool
func (args *PDFTextPasswordEventArgs) SetCancel(value bool)

// PDFTextPasswordEvent defines the signature of the PDFText Password event's handler function.
type PDFTextPasswordEvent func(sender *PDFText, args *PDFTextPasswordEventArgs)

func (obj *PDFText) GetOnPasswordHandler() PDFTextPasswordEvent
func (obj *PDFText) SetOnPasswordHandler(handlerFunc PDFTextPasswordEvent)

Remarks

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

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

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

RecipientInfo Event (PDFText Component)

Fired for each recipient certificate of the encrypted document.

Syntax

// PDFTextRecipientInfoEventArgs carries the PDFText RecipientInfo event's parameters.
type PDFTextRecipientInfoEventArgs struct {...}

func (args *PDFTextRecipientInfoEventArgs) Issuer() string
func (args *PDFTextRecipientInfoEventArgs) SerialNumber() string
func (args *PDFTextRecipientInfoEventArgs) SubjectKeyIdentifier() string
func (args *PDFTextRecipientInfoEventArgs) Available() bool
func (args *PDFTextRecipientInfoEventArgs) Cancel() bool
func (args *PDFTextRecipientInfoEventArgs) SetCancel(value bool)

// PDFTextRecipientInfoEvent defines the signature of the PDFText RecipientInfo event's handler function.
type PDFTextRecipientInfoEvent func(sender *PDFText, args *PDFTextRecipientInfoEventArgs)

func (obj *PDFText) GetOnRecipientInfoHandler() PDFTextRecipientInfoEvent
func (obj *PDFText) SetOnRecipientInfoHandler(handlerFunc PDFTextRecipientInfoEvent)

Remarks

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

Issuer specifies the subject of the issuer certificate.

SerialNumber specifies the serial number of the encryption certificate.

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

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

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

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

Config Settings (PDFText Component)

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

PDFText Config Settings

Base Config Settings

Trappable Errors (PDFText Component)

PDF Errors

Parsing Errors