PDFText Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

PDFText

Remarks

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

Start with providing the document that you want to extract information from as a file (InputFile), byte array (InputData), or stream (SetInputStream) 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Attachments Property (PDFText Class)

A collection of all attached files found in the document.

Syntax

• C++
• C
• Qt

PDFSDKList<PDFSDKPDFAttachment>* GetAttachments();
int SetAttachments(PDFSDKList<PDFSDKPDFAttachment>* val);

int pdfsdk_pdftext_getattachmentcount(void* lpObj);
int pdfsdk_pdftext_setattachmentcount(void* lpObj, int iAttachmentCount);

char* pdfsdk_pdftext_getattachmentafrelationship(void* lpObj, int attachmentindex);
int pdfsdk_pdftext_setattachmentafrelationship(void* lpObj, int attachmentindex, const char* lpszAttachmentAFRelationship);

int pdfsdk_pdftext_getattachmenttype(void* lpObj, int attachmentindex);

char* pdfsdk_pdftext_getattachmentcontenttype(void* lpObj, int attachmentindex);
int pdfsdk_pdftext_setattachmentcontenttype(void* lpObj, int attachmentindex, const char* lpszAttachmentContentType);

char* pdfsdk_pdftext_getattachmentcreationdate(void* lpObj, int attachmentindex);
int pdfsdk_pdftext_setattachmentcreationdate(void* lpObj, int attachmentindex, const char* lpszAttachmentCreationDate);

int pdfsdk_pdftext_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int pdfsdk_pdftext_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);

char* pdfsdk_pdftext_getattachmentdescription(void* lpObj, int attachmentindex);
int pdfsdk_pdftext_setattachmentdescription(void* lpObj, int attachmentindex, const char* lpszAttachmentDescription);

char* pdfsdk_pdftext_getattachmentfilename(void* lpObj, int attachmentindex);
int pdfsdk_pdftext_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFileName);

char* pdfsdk_pdftext_getattachmentmodificationdate(void* lpObj, int attachmentindex);
int pdfsdk_pdftext_setattachmentmodificationdate(void* lpObj, int attachmentindex, const char* lpszAttachmentModificationDate);

char* pdfsdk_pdftext_getattachmentname(void* lpObj, int attachmentindex);
int pdfsdk_pdftext_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);

int64 pdfsdk_pdftext_getattachmentsize(void* lpObj, int attachmentindex);

int getAttachmentCount();
int setAttachmentCount(int iAttachmentCount);

QString getAttachmentAFRelationship(int iAttachmentIndex);
int setAttachmentAFRelationship(int iAttachmentIndex, QString qsAttachmentAFRelationship);

int getAttachmentType(int iAttachmentIndex);

QString getAttachmentContentType(int iAttachmentIndex);
int setAttachmentContentType(int iAttachmentIndex, QString qsAttachmentContentType);

QString getAttachmentCreationDate(int iAttachmentIndex);
int setAttachmentCreationDate(int iAttachmentIndex, QString qsAttachmentCreationDate);

QByteArray getAttachmentData(int iAttachmentIndex);
int setAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData);

QString getAttachmentDescription(int iAttachmentIndex);
int setAttachmentDescription(int iAttachmentIndex, QString qsAttachmentDescription);

QString getAttachmentFileName(int iAttachmentIndex);
int setAttachmentFileName(int iAttachmentIndex, QString qsAttachmentFileName);

QString getAttachmentModificationDate(int iAttachmentIndex);
int setAttachmentModificationDate(int iAttachmentIndex, QString qsAttachmentModificationDate);

QString getAttachmentName(int iAttachmentIndex);
int setAttachmentName(int iAttachmentIndex, QString qsAttachmentName);

qint64 getAttachmentSize(int iAttachmentIndex);

Remarks

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

This property is not available at design time.

Data Type

PDFSDKPDFAttachment

DecryptionCert Property (PDFText Class)

The decryption certificate.

Syntax

• C++
• C
• Qt

PDFSDKCertificate* GetDecryptionCert();
int SetDecryptionCert(PDFSDKCertificate* val);

char* pdfsdk_pdftext_getdecryptioncerteffectivedate(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertexpirationdate(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertextendedkeyusage(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertfingerprint(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertfingerprintsha1(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertfingerprintsha256(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertissuer(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertprivatekey(void* lpObj);

int pdfsdk_pdftext_getdecryptioncertprivatekeyavailable(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertprivatekeycontainer(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertpublickey(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertpublickeyalgorithm(void* lpObj);

int pdfsdk_pdftext_getdecryptioncertpublickeylength(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertserialnumber(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertsignaturealgorithm(void* lpObj);

int pdfsdk_pdftext_getdecryptioncertstore(void* lpObj, char** lpDecryptionCertStore, int* lenDecryptionCertStore);
int pdfsdk_pdftext_setdecryptioncertstore(void* lpObj, const char* lpDecryptionCertStore, int lenDecryptionCertStore);

char* pdfsdk_pdftext_getdecryptioncertstorepassword(void* lpObj);
int pdfsdk_pdftext_setdecryptioncertstorepassword(void* lpObj, const char* lpszDecryptionCertStorePassword);

int pdfsdk_pdftext_getdecryptioncertstoretype(void* lpObj);
int pdfsdk_pdftext_setdecryptioncertstoretype(void* lpObj, int iDecryptionCertStoreType);

char* pdfsdk_pdftext_getdecryptioncertsubjectaltnames(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertthumbprintmd5(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertthumbprintsha1(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertthumbprintsha256(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertusage(void* lpObj);

int pdfsdk_pdftext_getdecryptioncertusageflags(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertversion(void* lpObj);

char* pdfsdk_pdftext_getdecryptioncertsubject(void* lpObj);
int pdfsdk_pdftext_setdecryptioncertsubject(void* lpObj, const char* lpszDecryptionCertSubject);

int pdfsdk_pdftext_getdecryptioncertencoded(void* lpObj, char** lpDecryptionCertEncoded, int* lenDecryptionCertEncoded);
int pdfsdk_pdftext_setdecryptioncertencoded(void* lpObj, const char* lpDecryptionCertEncoded, int lenDecryptionCertEncoded);

QString getDecryptionCertEffectiveDate();

QString getDecryptionCertExpirationDate();

QString getDecryptionCertExtendedKeyUsage();

QString getDecryptionCertFingerprint();

QString getDecryptionCertFingerprintSHA1();

QString getDecryptionCertFingerprintSHA256();

QString getDecryptionCertIssuer();

QString getDecryptionCertPrivateKey();

bool getDecryptionCertPrivateKeyAvailable();

QString getDecryptionCertPrivateKeyContainer();

QString getDecryptionCertPublicKey();

QString getDecryptionCertPublicKeyAlgorithm();

int getDecryptionCertPublicKeyLength();

QString getDecryptionCertSerialNumber();

QString getDecryptionCertSignatureAlgorithm();

QByteArray getDecryptionCertStore();
int setDecryptionCertStore(QByteArray qbaDecryptionCertStore);

QString getDecryptionCertStorePassword();
int setDecryptionCertStorePassword(QString qsDecryptionCertStorePassword);

int getDecryptionCertStoreType();
int setDecryptionCertStoreType(int iDecryptionCertStoreType);

QString getDecryptionCertSubjectAltNames();

QString getDecryptionCertThumbprintMD5();

QString getDecryptionCertThumbprintSHA1();

QString getDecryptionCertThumbprintSHA256();

QString getDecryptionCertUsage();

int getDecryptionCertUsageFlags();

QString getDecryptionCertVersion();

QString getDecryptionCertSubject();
int setDecryptionCertSubject(QString qsDecryptionCertSubject);

QByteArray getDecryptionCertEncoded();
int setDecryptionCertEncoded(QByteArray qbaDecryptionCertEncoded);

Remarks

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

This property is not available at design time.

Data Type

PDFSDKCertificate

InputData Property (PDFText Class)

A byte array containing the PDF document to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputData(char* &lpInputData, int &lenInputData);
int SetInputData(const char* lpInputData, int lenInputData);

Unicode (Windows)
INT GetInputData(LPSTR &lpInputData, INT &lenInputData);
INT SetInputData(LPCSTR lpInputData, INT lenInputData);

int pdfsdk_pdftext_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int pdfsdk_pdftext_setinputdata(void* lpObj, const char* lpInputData, int lenInputData);

QByteArray getInputData();
int setInputData(QByteArray qbaInputData);

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

The PDF file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* pdfsdk_pdftext_getinputfile(void* lpObj);
int pdfsdk_pdftext_setinputfile(void* lpObj, const char* lpszInputFile);

QString getInputFile();
int setInputFile(QString qsInputFile);

Default Value

""

Remarks

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

Data Type

String

Media Property (PDFText Class)

A collection of all media objects found in the document.

Syntax

• C++
• C
• Qt

PDFSDKList<PDFSDKPDFMedia>* GetMedia();
int SetMedia(PDFSDKList<PDFSDKPDFMedia>* val);

int pdfsdk_pdftext_getmediacount(void* lpObj);
int pdfsdk_pdftext_setmediacount(void* lpObj, int iMediaCount);

char* pdfsdk_pdftext_getmediacontenttype(void* lpObj, int mediaindex);

int pdfsdk_pdftext_getmediadata(void* lpObj, int mediaindex, char** lpMediaData, int* lenMediaData);
int pdfsdk_pdftext_setmediadata(void* lpObj, int mediaindex, const char* lpMediaData, int lenMediaData);

int pdfsdk_pdftext_getmediaheight(void* lpObj, int mediaindex);

int64 pdfsdk_pdftext_getmediasize(void* lpObj, int mediaindex);

int pdfsdk_pdftext_getmediawidth(void* lpObj, int mediaindex);

int getMediaCount();
int setMediaCount(int iMediaCount);

QString getMediaContentType(int iMediaIndex);

QByteArray getMediaData(int iMediaIndex);
int setMediaData(int iMediaIndex, QByteArray qbaMediaData);

int getMediaHeight(int iMediaIndex);

qint64 getMediaSize(int iMediaIndex);

int getMediaWidth(int iMediaIndex);

Remarks

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

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

This property is not available at design time.

Data Type

PDFSDKPDFMedia

Password Property (PDFText Class)

The password to decrypt the document with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* pdfsdk_pdftext_getpassword(void* lpObj);
int pdfsdk_pdftext_setpassword(void* lpObj, const char* lpszPassword);

QString getPassword();
int setPassword(QString qsPassword);

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

The PDF/A conformance level of the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPDFAConformanceLevel();
int SetPDFAConformanceLevel(int iPDFAConformanceLevel);

Unicode (Windows)
INT GetPDFAConformanceLevel();
INT SetPDFAConformanceLevel(INT iPDFAConformanceLevel);

PACL_NONE(0), 
PACL_A1A(1), 
PACL_A1B(2), 
PACL_A2A(3), 
PACL_A2B(4), 
PACL_A2U(5), 
PACL_A3A(6), 
PACL_A3B(7), 
PACL_A3U(8), 
PACL_A4(9), 
PACL_A4E(10), 
PACL_A4F(11)

int pdfsdk_pdftext_getpdfaconformancelevel(void* lpObj);
int pdfsdk_pdftext_setpdfaconformancelevel(void* lpObj, int iPDFAConformanceLevel);

int getPDFAConformanceLevel();
int setPDFAConformanceLevel(int iPDFAConformanceLevel);

Default Value

0

Remarks

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

Possible values are:

Data Type

Integer

Close Method (PDFText Class)

Closes the opened document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int pdfsdk_pdftext_close(void* lpObj);

int close();

Remarks

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (PDFText Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* pdfsdk_pdftext_config(void* lpObj, const char* lpszConfigurationString);

QString config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value ; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Encrypted Method (PDFText Class)

Checks whether the document is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool Encrypted();

Unicode (Windows)
bool Encrypted();

bool pdfsdk_pdftext_encrypted(void* lpObj);

bool encrypted();

Remarks

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

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

Error Handling (C++)

This method returns a Boolean value ; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetDocumentProperty Method (PDFText Class)

Returns the value of a document property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentProperty(const char* lpszDocumentProperty);

Unicode (Windows)
LPWSTR GetDocumentProperty(LPCWSTR lpszDocumentProperty);

char* pdfsdk_pdftext_getdocumentproperty(void* lpObj, const char* lpszDocumentProperty);

QString getDocumentProperty(const QString& qsDocumentProperty);

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.

Error Handling (C++)

This method returns a String value ; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetDocumentText Method (PDFText Class)

Returns the entire text content contained in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentText();

Unicode (Windows)
LPWSTR GetDocumentText();

char* pdfsdk_pdftext_getdocumenttext(void* lpObj);

QString getDocumentText();

Remarks

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

Error Handling (C++)

This method returns a String value ; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetPageProperty Method (PDFText Class)

Returns the value of a page property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPageProperty(int iPageIndex, const char* lpszPageProperty);

Unicode (Windows)
LPWSTR GetPageProperty(INT iPageIndex, LPCWSTR lpszPageProperty);

char* pdfsdk_pdftext_getpageproperty(void* lpObj, int iPageIndex, const char* lpszPageProperty);

QString getPageProperty(int iPageIndex, const QString& qsPageProperty);

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.

Error Handling (C++)

This method returns a String value ; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetPageText Method (PDFText Class)

Returns the text content residing on a specific page.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPageText(int iPageIndex);

Unicode (Windows)
LPWSTR GetPageText(INT iPageIndex);

char* pdfsdk_pdftext_getpagetext(void* lpObj, int iPageIndex);

QString getPageText(int iPageIndex);

Remarks

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

Error Handling (C++)

This method returns a String value ; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Open Method (PDFText Class)

Opens the document for processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int pdfsdk_pdftext_open(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (PDFText Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int pdfsdk_pdftext_reset(void* lpObj);

int reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SaveAttachment Method (PDFText Class)

Saves a PDF attachment to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveAttachment(int iIndex, const char* lpszFileName);

Unicode (Windows)
INT SaveAttachment(INT iIndex, LPCWSTR lpszFileName);

int pdfsdk_pdftext_saveattachment(void* lpObj, int iIndex, const char* lpszFileName);

int saveAttachment(int iIndex, const QString& qsFileName);

Remarks

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

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

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

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); 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 field if it's set NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SaveMedia Method (PDFText Class)

Saves a media object to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveMedia(int iIndex, const char* lpszFileName);

Unicode (Windows)
INT SaveMedia(INT iIndex, LPCWSTR lpszFileName);

int pdfsdk_pdftext_savemedia(void* lpObj, int iIndex, const char* lpszFileName);

int saveMedia(int iIndex, const QString& qsFileName);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (PDFText Class)

Sets the stream containing the PDF document to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(PDFSDKStream* sInputStream);

Unicode (Windows)
INT SetInputStream(PDFSDKStream* sInputStream);

int pdfsdk_pdftext_setinputstream(void* lpObj, PDFSDKStream* sInputStream);

int setInputStream(PDFSDKStream* sInputStream);

Remarks

This method is used to set the stream from which the class reads the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class reads the data from the input stream instead of from the InputFile or InputData properties.

NOTE: It may be useful to additionally set CloseInputStreamAfterProcessing to true when using input streams.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DocumentInfo Event (PDFText Class)

Fired when the document has been loaded into memory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDocumentInfo(PDFTextDocumentInfoEventParams *e);

typedef struct {
  int PageCount;
  int reserved;
} PDFTextDocumentInfoEventParams;


Unicode (Windows)
virtual INT FireDocumentInfo(PDFTextDocumentInfoEventParams *e);

typedef struct {
  INT PageCount;
  INT reserved;
} PDFTextDocumentInfoEventParams;

#define EID_PDFTEXT_DOCUMENTINFO 1

virtual INT PDFSDK_CALL FireDocumentInfo(int &iPageCount);

class PDFTextDocumentInfoEventParams {
public:
  int pageCount();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass PDFText and override this emitter function.
virtual int fireDocumentInfo(PDFTextDocumentInfoEventParams *e) {...}
// Or, connect one or more slots to this signal.
void documentInfo(PDFTextDocumentInfoEventParams *e);

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

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PDFTextErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char* Description;
  int reserved;
} PDFTextErrorEventParams;


Unicode (Windows)
virtual INT FireError(PDFTextErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PDFTextErrorEventParams;

#define EID_PDFTEXT_ERROR 2

virtual INT PDFSDK_CALL FireError(int &iErrorCode, char* &lpszDescription);

class PDFTextErrorEventParams {
public:
  int errorCode();

  const QString& description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass PDFText and override this emitter function.
virtual int fireError(PDFTextErrorEventParams *e) {...}
// Or, connect one or more slots to this signal.
void error(PDFTextErrorEventParams *e);

Remarks

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

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

Log Event (PDFText Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(PDFTextLogEventParams *e);

typedef struct {
  int LogLevel;
  const char* Message;
  const char* LogType;
  int reserved;
} PDFTextLogEventParams;


Unicode (Windows)
virtual INT FireLog(PDFTextLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} PDFTextLogEventParams;

#define EID_PDFTEXT_LOG 3

virtual INT PDFSDK_CALL FireLog(int &iLogLevel, char* &lpszMessage, char* &lpszLogType);

class PDFTextLogEventParams {
public:
  int logLevel();

  const QString& message();

  const QString& logType();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass PDFText and override this emitter function.
virtual int fireLog(PDFTextLogEventParams *e) {...}
// Or, connect one or more slots to this signal.
void log(PDFTextLogEventParams *e);

Remarks

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePassword(PDFTextPasswordEventParams *e);

typedef struct {
  int Available;
  int Cancel;
  int reserved;
} PDFTextPasswordEventParams;


Unicode (Windows)
virtual INT FirePassword(PDFTextPasswordEventParams *e);

typedef struct {
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFTextPasswordEventParams;

#define EID_PDFTEXT_PASSWORD 4

virtual INT PDFSDK_CALL FirePassword(int &bAvailable, int &bCancel);

class PDFTextPasswordEventParams {
public:
  bool available();

  bool cancel();
  void setCancel(bool bCancel);

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass PDFText and override this emitter function.
virtual int firePassword(PDFTextPasswordEventParams *e) {...}
// Or, connect one or more slots to this signal.
void password(PDFTextPasswordEventParams *e);

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

RecipientInfo Event (PDFText Class)

Fired for each recipient certificate of the encrypted document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientInfo(PDFTextRecipientInfoEventParams *e);

typedef struct {
  const char* Issuer;
  const char* SerialNumber;
  const char* SubjectKeyIdentifier;
  int Available;
  int Cancel;
  int reserved;
} PDFTextRecipientInfoEventParams;


Unicode (Windows)
virtual INT FireRecipientInfo(PDFTextRecipientInfoEventParams *e);

typedef struct {
  LPCWSTR Issuer;
  LPCWSTR SerialNumber;
  LPCWSTR SubjectKeyIdentifier;
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFTextRecipientInfoEventParams;

#define EID_PDFTEXT_RECIPIENTINFO 5

virtual INT PDFSDK_CALL FireRecipientInfo(char* &lpszIssuer, char* &lpszSerialNumber, char* &lpszSubjectKeyIdentifier, int &bAvailable, int &bCancel);

class PDFTextRecipientInfoEventParams {
public:
  const QString& issuer();

  const QString& serialNumber();

  const QString& subjectKeyIdentifier();

  bool available();

  bool cancel();
  void setCancel(bool bCancel);

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass PDFText and override this emitter function.
virtual int fireRecipientInfo(PDFTextRecipientInfoEventParams *e) {...}
// Or, connect one or more slots to this signal.
void recipientInfo(PDFTextRecipientInfoEventParams *e);

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

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

Certificate Type

This is the digital certificate being used.

Syntax

PDFSDKCertificate (declared in pdfsdk.h)

Remarks

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

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

Fields

Constructors

Certificate()
            

Certificate(const char* lpEncoded, int lenEncoded)
            

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
            

PDFAttachment Type

The file being attached to the PDF document.

Syntax

PDFSDKPDFAttachment (declared in pdfsdk.h)

Remarks

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

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

Fields

Constructors

PDFAttachment()
            

PDFAttachment(const char* lpszFileName)
            

PDFAttachment(const char* lpszFileName, const char* lpszDescription)
            

PDFAttachment(const char* lpszFileName, const char* lpszDescription, int iAttachmentType)
            

PDFAttachment(const char* lpData, int lenData, const char* lpszName, const char* lpszDescription)
            

PDFAttachment(const char* lpData, int lenData, const char* lpszName, const char* lpszDescription, int iAttachmentType)
            

PDFMedia Type

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

Syntax

PDFSDKPDFMedia (declared in pdfsdk.h)

Remarks

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

• ContentType
• Data
• Height
• Size
• Width

Fields

Constructors

PDFMedia()
            

PDFMedia(const char* lpData, int lenData)
            

PDFSDKList Type

Syntax

PDFSDKList<T> (declared in pdfsdk.h)

Remarks

PDFSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the PDFText class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

PDFSDKStream Type

Syntax

PDFSDKStream (declared in pdfsdk.h)

Remarks

The PDFText class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the PDFSDKStream interface and pass the PDFText class an instance of that concrete class.

When implementing the PDFSDKStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (PDFText Class)

PDFText Config Settings

Base Config Settings

Trappable Errors (PDFText Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PDF Errors

Parsing Errors