PDFEdit Class

Properties Methods Events Config Settings Errors

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

Syntax

PDFEdit

Remarks

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

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

Search, Replace, and Extract Text

Use the ReplacePageText and ReplaceDocumentText methods to iterate through the page or document content and replace all the text elements that match the specified pattern with the provided text. The class will fire the ReplaceText event during this operation, providing the flexibility of skipping certain text blocks or updating the replacement string on the fly. For example:

pdfedit.InputFile = "invoice.pdf";
pdfedit.OutputFile = "invoice_filled.pdf";

pdfedit.OnReplaceText += (s, e) =>
{
  if (e.Substitute == "/n software")
  {
    e.Substitute = "my company";
  }
};

pdfedit.Open();
int occurrences = pdfedit.ReplacePageText(0, "SELLER_NAME", "/n software");
pdfedit.Close();

Additionally, the GetPageText and GetDocumentText methods let you extract all the text residing on a specific page or in the entire document.

Content Composition

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

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

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

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

Document Merging and Splitting

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

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

Property List

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


Attachments	A collection of all attached files found in the document.
DecryptionCert	The decryption certificate.
Font	The currently set font.
InputData	A byte array containing the PDF document to process.
InputFile	The PDF file to process.
Media	A collection of all media objects found in the document.
NewPage	A placeholder for a page object to be added to the document.
OutputData	A byte array containing the PDF document after processing.
OutputFile	The path to a local file where the output will be written.
Overwrite	Whether or not the class should overwrite files.
Password	The password to decrypt the document with.
Position	The currently set position.
SelectedPage	The currently selected page.

Method List

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


AddAttachment	Adds an attachment to the document.
AddBitmap	Adds a bitmap image to the document.
AddDrawing	Adds a vector drawing to the document.
AddTextBlock	Adds a block of text to the document.
AppendPage	Appends a page to the end of the document.
Close	Closes the opened document.
Config	Sets or retrieves a configuration setting.
Convert	Converts the document to a different format.
CreateNew	Creates a new PDF document.
Encrypted	Checks whether the document is encrypted.
GetDocumentProperty	Returns the value of a document property.
GetDocumentText	Returns the entire text content contained in the document.
GetPageProperty	Returns the value of a page property.
GetPageText	Returns the text content residing on a specific page.
InsertPage	Inserts a page into the document.
Open	Opens the document for processing.
RemoveAttachment	Removes an attachment from the document.
RemovePage	Removes a page from the document.
RemovePages	Removes a subset of pages from the document.
ReplaceDocumentText	Replaces text in the document.
ReplacePageText	Replaces text on a page.
Reset	Resets the class.
SaveAttachment	Saves a PDF attachment to a file.
SaveMedia	Saves a media object to a file.
SelectPage	Selects a page.
SetAlignment	Sets the object alignment for subsequent insertion operations.
SetDocumentProperty	Sets the value of a document property.
SetFont	Sets the font properties to be applied to text.
SetInputStream	Sets the stream containing the PDF document to process.
SetOutputStream	Sets the stream to write the processed document to.
SetPosition	Sets the page and position for new text blocks or images.
SetTransform	Sets the object transformation parameters for subsequent insertion operations.

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.


DocumentInfo	Fired when the document has been loaded into memory.
Error	Fired when information is available about errors during data delivery.
Log	Fired once for each log message.
Password	Fired when the class detects that the document is encrypted with a password.
RecipientInfo	Fired for each recipient certificate of the encrypted document.
ReplaceText	Fired when a substring in the document is due to be replaced.

Config Settings

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


AFRelationship[Key]	The value of the AFRelationship key for the attachment.
AutoTurnPages	Whether to change the page automatically upon exceeding the upper or lower page boundary.
CloseInputStreamAfterProcessing	Whether to close the input stream after processing.
CloseOutputStreamAfterProcessing	Whether to close the output stream after processing.
CompressStreams	Whether to compress stream objects.
DefaultPageHeight	The default height for newly added pages.
DefaultPageWidth	The default width for newly added pages.
EnforcePDFA	Whether to enforce PDF/A compliance.
FallbackFont	The fallback font.
FontPaths	The font search paths.
KeepPositionOnInsert	Whether to keep the current position after inserting an element.
LoadMedia	Whether to load images from the document.
LogLevel	The level of detail that is logged.
OwnerPassword	The owner password to decrypt the document with.
PageCopyByRefElements	The names of page elements to be copied by reference.
PDFALevel	The PDF/A conformance level to enforce.
PDFAPolicy	The PDF/A policy to follow.
RightPadding	The width of the whitespace gap to the right of newly added elements.
SaveChanges	Whether to save changes made to the document.
SystemFontNames	The system font names.
TempPath	The location where temporary files are stored.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Attachments Property (PDFEdit Class)

A collection of all attached files found in the document.

Syntax

SecurePDFList<SecurePDFPDFAttachment>* GetAttachments();
int SetAttachments(SecurePDFList<SecurePDFPDFAttachment>* val);

int securepdf_pdfedit_getattachmentcount(void* lpObj);
int securepdf_pdfedit_setattachmentcount(void* lpObj, int iAttachmentCount);

char* securepdf_pdfedit_getattachmentcontenttype(void* lpObj, int attachmentindex);
int securepdf_pdfedit_setattachmentcontenttype(void* lpObj, int attachmentindex, const char* lpszAttachmentContentType);

char* securepdf_pdfedit_getattachmentcreationdate(void* lpObj, int attachmentindex);
int securepdf_pdfedit_setattachmentcreationdate(void* lpObj, int attachmentindex, const char* lpszAttachmentCreationDate);

int securepdf_pdfedit_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int securepdf_pdfedit_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);

char* securepdf_pdfedit_getattachmentdescription(void* lpObj, int attachmentindex);
int securepdf_pdfedit_setattachmentdescription(void* lpObj, int attachmentindex, const char* lpszAttachmentDescription);

char* securepdf_pdfedit_getattachmentfilename(void* lpObj, int attachmentindex);
int securepdf_pdfedit_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFileName);

int securepdf_pdfedit_setattachmentinputstream(void* lpObj, int attachmentindex, SecurePDFStream* sAttachmentInputStream);

char* securepdf_pdfedit_getattachmentmodificationdate(void* lpObj, int attachmentindex);
int securepdf_pdfedit_setattachmentmodificationdate(void* lpObj, int attachmentindex, const char* lpszAttachmentModificationDate);

char* securepdf_pdfedit_getattachmentname(void* lpObj, int attachmentindex);
int securepdf_pdfedit_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);

int securepdf_pdfedit_setattachmentoutputstream(void* lpObj, int attachmentindex, SecurePDFStream* sAttachmentOutputStream);

int64 securepdf_pdfedit_getattachmentsize(void* lpObj, int attachmentindex);

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

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

int setAttachmentInputStream(int iAttachmentIndex, SecurePDFStream* sAttachmentInputStream);

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

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

int setAttachmentOutputStream(int iAttachmentIndex, SecurePDFStream* sAttachmentOutputStream);

qint64 getAttachmentSize(int iAttachmentIndex);

Remarks

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

This property is not available at design time.

Data Type

SecurePDFPDFAttachment

DecryptionCert Property (PDFEdit Class)

The decryption certificate.

Syntax

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

char* securepdf_pdfedit_getdecryptioncerteffectivedate(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertexpirationdate(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertextendedkeyusage(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertfingerprint(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertfingerprintsha1(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertfingerprintsha256(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertissuer(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertprivatekey(void* lpObj);

int securepdf_pdfedit_getdecryptioncertprivatekeyavailable(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertprivatekeycontainer(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertpublickey(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertpublickeyalgorithm(void* lpObj);

int securepdf_pdfedit_getdecryptioncertpublickeylength(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertserialnumber(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertsignaturealgorithm(void* lpObj);

int securepdf_pdfedit_getdecryptioncertstore(void* lpObj, char** lpDecryptionCertStore, int* lenDecryptionCertStore);
int securepdf_pdfedit_setdecryptioncertstore(void* lpObj, const char* lpDecryptionCertStore, int lenDecryptionCertStore);

char* securepdf_pdfedit_getdecryptioncertstorepassword(void* lpObj);
int securepdf_pdfedit_setdecryptioncertstorepassword(void* lpObj, const char* lpszDecryptionCertStorePassword);

int securepdf_pdfedit_getdecryptioncertstoretype(void* lpObj);
int securepdf_pdfedit_setdecryptioncertstoretype(void* lpObj, int iDecryptionCertStoreType);

char* securepdf_pdfedit_getdecryptioncertsubjectaltnames(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertthumbprintmd5(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertthumbprintsha1(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertthumbprintsha256(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertusage(void* lpObj);

int securepdf_pdfedit_getdecryptioncertusageflags(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertversion(void* lpObj);

char* securepdf_pdfedit_getdecryptioncertsubject(void* lpObj);
int securepdf_pdfedit_setdecryptioncertsubject(void* lpObj, const char* lpszDecryptionCertSubject);

int securepdf_pdfedit_getdecryptioncertencoded(void* lpObj, char** lpDecryptionCertEncoded, int* lenDecryptionCertEncoded);
int securepdf_pdfedit_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

SecurePDFCertificate

Font Property (PDFEdit Class)

The currently set font.

Syntax

SecurePDFPDFFont* GetFont();

char* securepdf_pdfedit_getfontcolor(void* lpObj);

char* securepdf_pdfedit_getfontname(void* lpObj);

char* securepdf_pdfedit_getfontsize(void* lpObj);

char* securepdf_pdfedit_getfontstyle(void* lpObj);

QString getFontColor();

QString getFontName();

QString getFontSize();

QString getFontStyle();

Remarks

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

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

Data Type

SecurePDFPDFFont

InputData Property (PDFEdit Class)

A byte array containing the PDF document to process.

Syntax

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 securepdf_pdfedit_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int securepdf_pdfedit_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 (PDFEdit Class)

The PDF file to process.

Syntax

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

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

char* securepdf_pdfedit_getinputfile(void* lpObj);
int securepdf_pdfedit_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 (PDFEdit Class)

A collection of all media objects found in the document.

Syntax

SecurePDFList<SecurePDFPDFMedia>* GetMedia();
int SetMedia(SecurePDFList<SecurePDFPDFMedia>* val);

int securepdf_pdfedit_getmediacount(void* lpObj);
int securepdf_pdfedit_setmediacount(void* lpObj, int iMediaCount);

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

int securepdf_pdfedit_getmediadata(void* lpObj, int mediaindex, char** lpMediaData, int* lenMediaData);
int securepdf_pdfedit_setmediadata(void* lpObj, int mediaindex, const char* lpMediaData, int lenMediaData);

int securepdf_pdfedit_getmediaheight(void* lpObj, int mediaindex);

int securepdf_pdfedit_setmediainputstream(void* lpObj, int mediaindex, SecurePDFStream* sMediaInputStream);

int securepdf_pdfedit_setmediaoutputstream(void* lpObj, int mediaindex, SecurePDFStream* sMediaOutputStream);

int64 securepdf_pdfedit_getmediasize(void* lpObj, int mediaindex);

int securepdf_pdfedit_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);

int setMediaInputStream(int iMediaIndex, SecurePDFStream* sMediaInputStream);

int setMediaOutputStream(int iMediaIndex, SecurePDFStream* sMediaOutputStream);

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

This property is not available at design time.

Data Type

SecurePDFPDFMedia

NewPage Property (PDFEdit Class)

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

Syntax

SecurePDFPDFPage* GetNewPage();
int SetNewPage(SecurePDFPDFPage* val);

int64 securepdf_pdfedit_getnewpagehandle(void* lpObj);
int securepdf_pdfedit_setnewpagehandle(void* lpObj, int64 lNewPageHandle);

char* securepdf_pdfedit_getnewpageheight(void* lpObj);

int securepdf_pdfedit_getnewpagerotate(void* lpObj);

char* securepdf_pdfedit_getnewpagewidth(void* lpObj);

qint64 getNewPageHandle();
int setNewPageHandle(qint64 lNewPageHandle);

QString getNewPageHeight();

int getNewPageRotate();

QString getNewPageWidth();

Remarks

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

This property is not available at design time.

Data Type

SecurePDFPDFPage

OutputData Property (PDFEdit Class)

A byte array containing the PDF document after processing.

Syntax

ANSI (Cross Platform)
int GetOutputData(char* &lpOutputData, int &lenOutputData);

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);

int securepdf_pdfedit_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);

QByteArray getOutputData();

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

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

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* securepdf_pdfedit_getoutputfile(void* lpObj);
int securepdf_pdfedit_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString getOutputFile();
int setOutputFile(QString qsOutputFile);

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

Whether or not the class should overwrite files.

Syntax

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int securepdf_pdfedit_getoverwrite(void* lpObj);
int securepdf_pdfedit_setoverwrite(void* lpObj, int bOverwrite);

bool getOverwrite();
int setOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

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

Data Type

Boolean

Password Property (PDFEdit Class)

The password to decrypt the document with.

Syntax

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

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

char* securepdf_pdfedit_getpassword(void* lpObj);
int securepdf_pdfedit_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

Position Property (PDFEdit Class)

The currently set position.

Syntax

SecurePDFPDFPagePosition* GetPosition();

int securepdf_pdfedit_getpositionpageindex(void* lpObj);

char* securepdf_pdfedit_getpositionx(void* lpObj);

char* securepdf_pdfedit_getpositiony(void* lpObj);

int getPositionPageIndex();

QString getPositionX();

QString getPositionY();

Remarks

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

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

Data Type

SecurePDFPDFPagePosition

SelectedPage Property (PDFEdit Class)

The currently selected page.

Syntax

SecurePDFPDFPage* GetSelectedPage();

int64 securepdf_pdfedit_getselectedpagehandle(void* lpObj);

char* securepdf_pdfedit_getselectedpageheight(void* lpObj);

int securepdf_pdfedit_getselectedpagerotate(void* lpObj);

char* securepdf_pdfedit_getselectedpagewidth(void* lpObj);

qint64 getSelectedPageHandle();

QString getSelectedPageHeight();

int getSelectedPageRotate();

QString getSelectedPageWidth();

Remarks

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

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

Data Type

SecurePDFPDFPage

AddAttachment Method (PDFEdit Class)

Adds an attachment to the document.

Syntax

ANSI (Cross Platform)
int AddAttachment(const char* lpszFileName, const char* lpszDescription);

Unicode (Windows)
INT AddAttachment(LPCWSTR lpszFileName, LPCWSTR lpszDescription);

int securepdf_pdfedit_addattachment(void* lpObj, const char* lpszFileName, const char* lpszDescription);

int addAttachment(const QString& qsFileName, const QString& qsDescription);

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.

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

AddBitmap Method (PDFEdit Class)

Adds a bitmap image to the document.

Syntax

ANSI (Cross Platform)
int AddBitmap(const char* lpszFormat, const char* lpBitmapBytes, int lenBitmapBytes, int iWidth, int iHeight);

Unicode (Windows)
INT AddBitmap(LPCWSTR lpszFormat, LPCSTR lpBitmapBytes, INT lenBitmapBytes, INT iWidth, INT iHeight);

int securepdf_pdfedit_addbitmap(void* lpObj, const char* lpszFormat, const char* lpBitmapBytes, int lenBitmapBytes, int iWidth, int iHeight);

int addBitmap(const QString& qsFormat, QByteArray& qbaBitmapBytes, int iWidth, int iHeight);

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

Error Handling (C++)

AddDrawing Method (PDFEdit Class)

Adds a vector drawing to the document.

Syntax

ANSI (Cross Platform)
int AddDrawing(const char* lpszFormat, const char* lpDrawingBytes, int lenDrawingBytes);

Unicode (Windows)
INT AddDrawing(LPCWSTR lpszFormat, LPCSTR lpDrawingBytes, INT lenDrawingBytes);

int securepdf_pdfedit_adddrawing(void* lpObj, const char* lpszFormat, const char* lpDrawingBytes, int lenDrawingBytes);

int addDrawing(const QString& qsFormat, QByteArray& qbaDrawingBytes);

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.

Error Handling (C++)

AddTextBlock Method (PDFEdit Class)

Adds a block of text to the document.

Syntax

ANSI (Cross Platform)
int AddTextBlock(const char* lpszText);

Unicode (Windows)
INT AddTextBlock(LPCWSTR lpszText);

int securepdf_pdfedit_addtextblock(void* lpObj, const char* lpszText);

int addTextBlock(const QString& qsText);

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

Error Handling (C++)

AppendPage Method (PDFEdit Class)

Appends a page to the end of the document.

Syntax

ANSI (Cross Platform)
int AppendPage();

Unicode (Windows)
INT AppendPage();

int securepdf_pdfedit_appendpage(void* lpObj);

int appendPage();

Remarks

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

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

Error Handling (C++)

Close Method (PDFEdit Class)

Closes the opened document.

Syntax

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

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

Error Handling (C++)

Config Method (PDFEdit Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* securepdf_pdfedit_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.

Convert Method (PDFEdit Class)

Converts the document to a different format.

Syntax

ANSI (Cross Platform)
int Convert(const char* lpszFormat);

Unicode (Windows)
INT Convert(LPCWSTR lpszFormat);

int securepdf_pdfedit_convert(void* lpObj, const char* lpszFormat);

int convert(const QString& qsFormat);

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:


Format	Description
CompressedPDF	All data streams included in the document are compressed.
UncompressedPDF	All data streams included in the document are decompressed.

Error Handling (C++)

CreateNew Method (PDFEdit Class)

Creates a new PDF document.

Syntax

ANSI (Cross Platform)
int CreateNew();

Unicode (Windows)
INT CreateNew();

int securepdf_pdfedit_createnew(void* lpObj);

int createNew();

Remarks

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

Error Handling (C++)

Encrypted Method (PDFEdit Class)

Checks whether the document is encrypted.

Syntax

ANSI (Cross Platform)
bool Encrypted();

Unicode (Windows)
bool Encrypted();

bool securepdf_pdfedit_encrypted(void* lpObj);

bool encrypted();

Remarks

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

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

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

Returns the value of a document property.

Syntax

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

Unicode (Windows)
LPWSTR GetDocumentProperty(LPCWSTR lpszDocumentProperty);

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

QString getDocumentProperty(const QString& qsDocumentProperty);

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:


Document property	Default value	Description
Xmp	""	The XML body of the XMP metadata embedded in the document.
Xmp[property]	""	The value of an XMP metadata property.
XmpStream	""	The hex-encoded content of the XMP metadata stream.

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.

Error Handling (C++)

GetDocumentText Method (PDFEdit Class)

Returns the entire text content contained in the document.

Syntax

ANSI (Cross Platform)
char* GetDocumentText();

Unicode (Windows)
LPWSTR GetDocumentText();

char* securepdf_pdfedit_getdocumenttext(void* lpObj);

QString getDocumentText();

Remarks

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

Error Handling (C++)

GetPageProperty Method (PDFEdit Class)

Returns the value of a page property.

Syntax

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

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

char* securepdf_pdfedit_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.

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:


Page property	Default value	Description
CropLowerLeftX	0	The lower-left X coordinate of the page crop area in points.
CropLowerLeftY	0	The lower-left Y coordinate of the page crop area in points.
CropUpperRightX	0	The upper-right X coordinate of the page crop area in points.
CropUpperRightY	0	The upper-right Y coordinate of the page crop area in points.
Height	0	The height of the page in points. Both integer and decimal values are supported.
MediaLowerLeftX	0	The lower-left X coordinate of the page media area in points.
MediaLowerLeftY	0	The lower-left Y coordinate of the page media area in points.
MediaUpperRightX	0	The upper-right X coordinate of the page media area in points.
MediaUpperRightY	0	The upper-right Y coordinate of the page media area in points.
Rotation	0	The rotation angle of the page in degrees. Possible values: `0`, `90`, `180`, `270`.
Width	0	The width of the page in points. Both integer and decimal values are supported.

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.

Error Handling (C++)

GetPageText Method (PDFEdit Class)

Returns the text content residing on a specific page.

Syntax

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

Unicode (Windows)
LPWSTR GetPageText(INT iPageIndex);

char* securepdf_pdfedit_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 the PageIndex parameter (zero-based).

Error Handling (C++)

InsertPage Method (PDFEdit Class)

Inserts a page into the document.

Syntax

ANSI (Cross Platform)
int InsertPage(int iPageIndex);

Unicode (Windows)
INT InsertPage(INT iPageIndex);

int securepdf_pdfedit_insertpage(void* lpObj, int iPageIndex);

int insertPage(int iPageIndex);

Remarks

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

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

Error Handling (C++)

Open Method (PDFEdit Class)

Opens the document for processing.

Syntax

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int securepdf_pdfedit_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++)

RemoveAttachment Method (PDFEdit Class)

Removes an attachment from the document.

Syntax

ANSI (Cross Platform)
int RemoveAttachment(int iIndex);

Unicode (Windows)
INT RemoveAttachment(INT iIndex);

int securepdf_pdfedit_removeattachment(void* lpObj, int iIndex);

int removeAttachment(int iIndex);

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.

Error Handling (C++)

RemovePage Method (PDFEdit Class)

Removes a page from the document.

Syntax

ANSI (Cross Platform)
int RemovePage(int iPageIndex);

Unicode (Windows)
INT RemovePage(INT iPageIndex);

int securepdf_pdfedit_removepage(void* lpObj, int iPageIndex);

int removePage(int iPageIndex);

Remarks

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

Error Handling (C++)

RemovePages Method (PDFEdit Class)

Removes a subset of pages from the document.

Syntax

ANSI (Cross Platform)
int RemovePages(int iPageIndex, int iCount);

Unicode (Windows)
INT RemovePages(INT iPageIndex, INT iCount);

int securepdf_pdfedit_removepages(void* lpObj, int iPageIndex, int iCount);

int removePages(int iPageIndex, int iCount);

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

Error Handling (C++)

ReplaceDocumentText Method (PDFEdit Class)

Replaces text in the document.

Syntax

ANSI (Cross Platform)
int ReplaceDocumentText(const char* lpszPattern, const char* lpszValue);

Unicode (Windows)
INT ReplaceDocumentText(LPCWSTR lpszPattern, LPCWSTR lpszValue);

int securepdf_pdfedit_replacedocumenttext(void* lpObj, const char* lpszPattern, const char* lpszValue);

int replaceDocumentText(const QString& qsPattern, const QString& qsValue);

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.

Error Handling (C++)

This method returns an Integer 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.

ReplacePageText Method (PDFEdit Class)

Replaces text on a page.

Syntax

ANSI (Cross Platform)
int ReplacePageText(int iPageIndex, const char* lpszPattern, const char* lpszValue);

Unicode (Windows)
INT ReplacePageText(INT iPageIndex, LPCWSTR lpszPattern, LPCWSTR lpszValue);

int securepdf_pdfedit_replacepagetext(void* lpObj, int iPageIndex, const char* lpszPattern, const char* lpszValue);

int replacePageText(int iPageIndex, const QString& qsPattern, const QString& qsValue);

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.

Error Handling (C++)

Reset Method (PDFEdit Class)

Resets the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int securepdf_pdfedit_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++)

SaveAttachment Method (PDFEdit Class)

Saves a PDF attachment to a file.

Syntax

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

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

int securepdf_pdfedit_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 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 field if it's set NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

SaveMedia Method (PDFEdit Class)

Saves a media object to a file.

Syntax

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

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

int securepdf_pdfedit_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 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 field if it's set pdfedit.Close();

Error Handling (C++)

SelectPage Method (PDFEdit Class)

Selects a page.

Syntax

ANSI (Cross Platform)
int SelectPage(int iPageIndex);

Unicode (Windows)
INT SelectPage(INT iPageIndex);

int securepdf_pdfedit_selectpage(void* lpObj, int iPageIndex);

int selectPage(int iPageIndex);

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.

Error Handling (C++)

SetAlignment Method (PDFEdit Class)

Sets the object alignment for subsequent insertion operations.

Syntax

ANSI (Cross Platform)
int SetAlignment(int iHorizontalAlignment, int iVerticalAlignment);

Unicode (Windows)
INT SetAlignment(INT iHorizontalAlignment, INT iVerticalAlignment);

int securepdf_pdfedit_setalignment(void* lpObj, int iHorizontalAlignment, int iVerticalAlignment);

int setAlignment(int iHorizontalAlignment, int iVerticalAlignment);

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:


0 (haLeft - default)
1 (haCenter)
2 (haRight)

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


0 (vaTop - default)
1 (vaCenter)
2 (vaBottom)

Error Handling (C++)

SetDocumentProperty Method (PDFEdit Class)

Sets the value of a document property.

Syntax

ANSI (Cross Platform)
int SetDocumentProperty(const char* lpszDocumentProperty, const char* lpszValue);

Unicode (Windows)
INT SetDocumentProperty(LPCWSTR lpszDocumentProperty, LPCWSTR lpszValue);

int securepdf_pdfedit_setdocumentproperty(void* lpObj, const char* lpszDocumentProperty, const char* lpszValue);

int setDocumentProperty(const QString& qsDocumentProperty, const QString& qsValue);

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:


Document property	Default value	Description
Xmp	""	The XML body of the XMP metadata embedded in the document.
Xmp[property]	""	The value of an XMP metadata property.
XmpStream	""	The hex-encoded content of the XMP metadata stream.

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();

Error Handling (C++)

SetFont Method (PDFEdit Class)

Sets the font properties to be applied to text.

Syntax

ANSI (Cross Platform)
int SetFont(const char* lpszName, const char* lpszSize, const char* lpszStyle, const char* lpszColor);

Unicode (Windows)
INT SetFont(LPCWSTR lpszName, LPCWSTR lpszSize, LPCWSTR lpszStyle, LPCWSTR lpszColor);

int securepdf_pdfedit_setfont(void* lpObj, const char* lpszName, const char* lpszSize, const char* lpszStyle, const char* lpszColor);

int setFont(const QString& qsName, const QString& qsSize, const QString& qsStyle, const QString& qsColor);

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:


`aliceblue`	`antiquewhite`	`aqua`	`aquamarine`
`azure`	`beige`	`bisque`	`black`
`blanchedalmond`	`blue`	`blueviolet`	`brown`
`burlywood`	`cadetblue`	`chartreuse`	`chocolate`
`coral`	`cornflowerblue`	`cornsilk`	`crimson`
`cyan`	`darkblue`	`darkcyan`	`darkgoldenrod`
`darkgray`	`darkgrey`	`darkgreen`	`darkkhaki`
`darkmagenta`	`darkolivegreen`	`darkorange`	`darkorchid`
`darkred`	`darksalmon`	`darkseagreen`	`darkslateblue`
`darkslategray`	`darkslategrey`	`darkturquoise`	`darkviolet`
`deeppink`	`deepskyblue`	`dimgray`	`dimgrey`
`dodgerblue`	`firebrick`	`floralwhite`	`forestgreen`
`fuchsia`	`gainsboro`	`ghostwhite`	`gold`
`goldenrod`	`gray`	`grey`	`green`
`greenyellow`	`honeydew`	`hotpink`	`indianred`
`indigo`	`ivory`	`khaki`	`lavender`
`lavenderblush`	`lawngreen`	`lemonchiffon`	`lightblue`
`lightcoral`	`lightcyan`	`lightgoldenrodyellow`	`lightgray`
`lightgrey`	`lightgreen`	`lightpink`	`lightsalmon`
`lightseagreen`	`lightskyblue`	`lightslategray`	`lightslategrey`
`lightsteelblue`	`lightyellow`	`lime`	`limegreen`
`linen`	`magenta`	`maroon`	`mediumaquamarine`
`mediumblue`	`mediumorchid`	`mediumpurple`	`mediumseagreen`
`mediumslateblue`	`mediumspringgreen`	`mediumturquoise`	`mediumvioletred`
`midnightblue`	`mintcream`	`mistyrose`	`moccasin`
`navajowhite`	`navy`	`oldlace`	`olive`
`olivedrab`	`orange`	`orangered`	`orchid`
`palegoldenrod`	`palegreen`	`paleturquoise`	`palevioletred`
`papayawhip`	`peachpuff`	`peru`	`pink`
`plum`	`powderblue`	`purple`	`rebeccapurple`
`red`	`rosybrown`	`royalblue`	`saddlebrown`
`salmon`	`sandybrown`	`seagreen`	`seashell`
`sienna`	`silver`	`skyblue`	`slateblue`
`slategray`	`slategrey`	`snow`	`springgreen`
`steelblue`	`tan`	`teal`	`thistle`
`tomato`	`turquoise`	`violet`	`wheat`
`white`	`whitesmoke`	`yellow`	`yellowgreen`

Error Handling (C++)

SetInputStream Method (PDFEdit Class)

Sets the stream containing the PDF document to process.

Syntax

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

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

int securepdf_pdfedit_setinputstream(void* lpObj, SecurePDFStream* sInputStream);

int setInputStream(SecurePDFStream* sInputStream);

Remarks

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

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

Error Handling (C++)

SetOutputStream Method (PDFEdit Class)

Sets the stream to write the processed document to.

Syntax

ANSI (Cross Platform)
int SetOutputStream(SecurePDFStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(SecurePDFStream* sOutputStream);

int securepdf_pdfedit_setoutputstream(void* lpObj, SecurePDFStream* sOutputStream);

int setOutputStream(SecurePDFStream* sOutputStream);

Remarks

This method is used to set the stream to which the class will write the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class will write the data to the output stream instead of writing to OutputFile or populating OutputData.

NOTE: It may be useful to additionally set the CloseOutputStreamAfterProcessing configuration setting to true when using output streams.

Error Handling (C++)

SetPosition Method (PDFEdit Class)

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

Syntax

ANSI (Cross Platform)
int SetPosition(int iPageIndex, const char* lpszX, const char* lpszY);

Unicode (Windows)
INT SetPosition(INT iPageIndex, LPCWSTR lpszX, LPCWSTR lpszY);

int securepdf_pdfedit_setposition(void* lpObj, int iPageIndex, const char* lpszX, const char* lpszY);

int setPosition(int iPageIndex, const QString& qsX, const QString& qsY);

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.

Error Handling (C++)

SetTransform Method (PDFEdit Class)

Sets the object transformation parameters for subsequent insertion operations.

Syntax

ANSI (Cross Platform)
int SetTransform(const char* lpszTranslationX, const char* lpszTranslationY, const char* lpszScaleX, const char* lpszScaleY, const char* lpszRotation, const char* lpszSkewA, const char* lpszSkewB);

Unicode (Windows)
INT SetTransform(LPCWSTR lpszTranslationX, LPCWSTR lpszTranslationY, LPCWSTR lpszScaleX, LPCWSTR lpszScaleY, LPCWSTR lpszRotation, LPCWSTR lpszSkewA, LPCWSTR lpszSkewB);

int securepdf_pdfedit_settransform(void* lpObj, const char* lpszTranslationX, const char* lpszTranslationY, const char* lpszScaleX, const char* lpszScaleY, const char* lpszRotation, const char* lpszSkewA, const char* lpszSkewB);

int setTransform(const QString& qsTranslationX, const QString& qsTranslationY, const QString& qsScaleX, const QString& qsScaleY, const QString& qsRotation, const QString& qsSkewA, const QString& qsSkewB);

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

Error Handling (C++)

DocumentInfo Event (PDFEdit Class)

Fired when the document has been loaded into memory.

Syntax

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

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


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

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

#define EID_PDFEDIT_DOCUMENTINFO 1

virtual INT SECUREPDF_CALL FireDocumentInfo(INT &iPageCount);

class PDFEditDocumentInfoEventParams {
public:
  int pageCount();

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

// To handle, subclass PDFEdit and override this emitter function.
virtual int fireDocumentInfo(PDFEditDocumentInfoEventParams *e) {...}
// Or, connect one or more slots to this signal.
void documentInfo(PDFEditDocumentInfoEventParams *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.

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

Fired when information is available about errors during data delivery.

Syntax

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

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


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

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

#define EID_PDFEDIT_ERROR 2

virtual INT SECUREPDF_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PDFEditErrorEventParams {
public:
  int errorCode();

  const QString &description();

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

// To handle, subclass PDFEdit and override this emitter function.
virtual int fireError(PDFEditErrorEventParams *e) {...}
// Or, connect one or more slots to this signal.
void error(PDFEditErrorEventParams *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 (PDFEdit Class)

Fired once for each log message.

Syntax

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

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


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

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

#define EID_PDFEDIT_LOG 3

virtual INT SECUREPDF_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class PDFEditLogEventParams {
public:
  int logLevel();

  const QString &message();

  const QString &logType();

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

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

Remarks

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

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


0 (None)	No messages are logged.
1 (Info - default)	Informational events such as the basics of the chain validation procedure are logged.
2 (Verbose)	Detailed data such as HTTP requests are logged.
3 (Debug)	Debug data including the full chain validation procedure are logged.

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

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

Syntax

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

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


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

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

#define EID_PDFEDIT_PASSWORD 4

virtual INT SECUREPDF_CALL FirePassword(BOOL &bAvailable, BOOL &bCancel);

class PDFEditPasswordEventParams {
public:
  bool available();

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

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

// To handle, subclass PDFEdit and override this emitter function.
virtual int firePassword(PDFEditPasswordEventParams *e) {...}
// Or, connect one or more slots to this signal.
void password(PDFEditPasswordEventParams *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 the Password property.

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

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

RecipientInfo Event (PDFEdit Class)

Fired for each recipient certificate of the encrypted document.

Syntax

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

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


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

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

#define EID_PDFEDIT_RECIPIENTINFO 5

virtual INT SECUREPDF_CALL FireRecipientInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, BOOL &bAvailable, BOOL &bCancel);

class PDFEditRecipientInfoEventParams {
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 PDFEdit and override this emitter function.
virtual int fireRecipientInfo(PDFEditRecipientInfoEventParams *e) {...}
// Or, connect one or more slots to this signal.
void recipientInfo(PDFEditRecipientInfoEventParams *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 the DecryptionCert property.

The Issuer parameter specifies the subject of the issuer certificate.

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

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

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

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

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

ReplaceText Event (PDFEdit Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireReplaceText(PDFEditReplaceTextEventParams *e);

typedef struct {
  int PageIndex;
  int EntryIndex;
  int Offset;
  const char *Pattern;
  char *Substitute;
  int Skip;
  int reserved;
} PDFEditReplaceTextEventParams;


Unicode (Windows)
virtual INT FireReplaceText(PDFEditReplaceTextEventParams *e);

typedef struct {
  INT PageIndex;
  INT EntryIndex;
  INT Offset;
  LPCWSTR Pattern;
  LPWSTR Substitute;
  BOOL Skip;
  INT reserved;
} PDFEditReplaceTextEventParams;

#define EID_PDFEDIT_REPLACETEXT 6

virtual INT SECUREPDF_CALL FireReplaceText(INT &iPageIndex, INT &iEntryIndex, INT &iOffset, LPSTR &lpszPattern, LPSTR &lpszSubstitute, BOOL &bSkip);

class PDFEditReplaceTextEventParams {
public:
  int pageIndex();

  int entryIndex();

  int offset();

  const QString &pattern();

  const QString &substitute();
  void setSubstitute(const QString &qsSubstitute);

  bool skip();
  void setSkip(bool bSkip);

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

// To handle, subclass PDFEdit and override this emitter function.
virtual int fireReplaceText(PDFEditReplaceTextEventParams *e) {...}
// Or, connect one or more slots to this signal.
void replaceText(PDFEditReplaceTextEventParams *e);

Remarks

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

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

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

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

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

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

Certificate Type

This is the digital certificate being used.

Syntax

SecurePDFCertificate (declared in securepdf.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.

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

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.

ExpirationDate
char* (read-only)
Default Value: ""

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.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

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

Fingerprint
char* (read-only)
Default Value: ""

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

FingerprintSHA1
char* (read-only)
Default Value: ""

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

FingerprintSHA256
char* (read-only)
Default Value: ""

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

Issuer
char* (read-only)
Default Value: ""

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

PrivateKey
char* (read-only)
Default Value: ""

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

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

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

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

PrivateKeyContainer
char* (read-only)
Default Value: ""

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

PublicKey
char* (read-only)
Default Value: ""

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

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

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.

PublicKeyLength
int (read-only)
Default Value: 0

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

SerialNumber
char* (read-only)
Default Value: ""

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.

SignatureAlgorithm
char* (read-only)
Default Value: ""

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.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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

StorePassword
char*
Default Value: ""

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

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

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

ThumbprintMD5
char* (read-only)
Default Value: ""

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.

ThumbprintSHA1
char* (read-only)
Default Value: ""

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.

ThumbprintSHA256
char* (read-only)
Default Value: ""

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.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

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.

UsageFlags
int (read-only)
Default Value: 0

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


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

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

Version
char* (read-only)
Default Value: ""

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

Subject
char*
Default Value: ""

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


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

Creates a instance whose properties can be set.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

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

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

PDFAttachment Type

The file being attached to the PDF document.

Syntax

SecurePDFPDFAttachment (declared in securepdf.h)

Remarks

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

The following fields are available:

ContentType
CreationDate
Data
Description
FileName
ModificationDate
Name
Size

Fields

ContentType
char*
Default Value: ""

The content type of the attachment.

CreationDate
char*
Default Value: ""

The creation date of the attachment.

Data
char*
Default Value: ""

The raw data of the attachment.

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

Description
char*
Default Value: ""

A textual description of the attachment.

FileName
char*
Default Value: ""

The path and filename of the attachment.

ModificationDate
char*
Default Value: ""

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

Name
char*
Default Value: ""

The name of the attachment.

Size
int64 (read-only)
Default Value: 0

The attachment's size in bytes.

Constructors

PDFAttachment()

PDFAttachment(const char* lpszFileName)

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

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

PDFFont Type

The font used in the PDF document.

Syntax

SecurePDFPDFFont (declared in securepdf.h)

Remarks

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

The following fields are available:

Color
Name
Size
Style

Fields

Color
char* (read-only)
Default Value: "#000000"

The color of the current font in hexadecimal format.

Name
char* (read-only)
Default Value: "Arial"

The name of the current font.

Size
char* (read-only)
Default Value: "12"

The size of the current font in points.

Style
char* (read-only)
Default Value: ""

The style of the current font.

Constructors

PDFFont()

PDFMedia Type

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

Syntax

SecurePDFPDFMedia (declared in securepdf.h)

Remarks

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

The following fields are available:

ContentType
Data
Height
Size
Width

Fields

ContentType
char* (read-only)
Default Value: ""

The content type of the media object.

Data
char*
Default Value: ""

The raw data of the media object.

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

Height
int (read-only)
Default Value: 0

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

Size
int64 (read-only)
Default Value: 0

The size of the media in bytes.

Width
int (read-only)
Default Value: 0

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

Constructors

PDFMedia()

PDFMedia(const char* lpData, int lenData)

PDFPage Type

A container for PDF page details.

Syntax

SecurePDFPDFPage (declared in securepdf.h)

Remarks

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

The following fields are available:

Handle
Height
Rotate
Width

Fields

Handle
int64
Default Value: 0

A handle, a unique identifier of the underlying property object. Use this field 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());

Height
char* (read-only)
Default Value: "0"

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

Rotate
int (read-only)
Default Value: 0

The rotation angle of the page in degrees.

Width
char* (read-only)
Default Value: "0"

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

Constructors

PDFPage()

PDFPagePosition Type

The position within a PDF document.

Syntax

SecurePDFPDFPagePosition (declared in securepdf.h)

Remarks

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

The following fields are available:

PageIndex
X
Y

Fields

PageIndex
int (read-only)
Default Value: 0

The index of the current page in the PDF document.

X
char* (read-only)
Default Value: "0"

The X coordinate of the current position on the page.

Y
char* (read-only)
Default Value: "0"

The Y coordinate of the current position on the page.

Constructors

PDFPagePosition()

SecurePDFList Type

Syntax

SecurePDFList<T> (declared in securepdf.h)

Remarks

SecurePDFList 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 PDFEdit class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

SecurePDFStream Type

Syntax

SecurePDFStream (declared in securepdf.h)

Remarks

The PDFEdit 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 SecurePDFStream interface and pass the PDFEdit class an instance of that concrete class.

When implementing the SecurePDFStream 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.

Properties

CanRead	Whether the stream supports reading. bool CanRead() { return true; }
CanSeek	Whether the stream supports seeking. bool CanSeek() { return true; }
CanWrite	Whether the stream supports writing. bool CanWrite() { return true; }
Length	Gets the length of the stream, in bytes. int64 GetLength() = 0;
Methods

Close	Closes the stream, releasing all resources currently allocated for it. void Close() {} This method is called automatically when a SecurePDFStream object is deleted.
Flush	Forces all data held by the stream's buffers to be written out to storage. int Flush() { return 0; } Must return `0` if flushing is successful; or `-1` if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return `0`.
Read	Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. int Read(void* buffer, int count) = 0; `Buffer` specifies the buffer to populate with data from the stream. `Count` specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into `Buffer`; this may be less than `Count` if that many bytes are not currently available, or `0` if the end of the stream has been reached. Must return `-1` if an error occurs, if reading is not supported, or if the stream is closed.
Seek	Sets the current position within the stream based on a particular point of origin. int64 Seek(int64 offset, int seekOrigin) = 0; `Offset` specifies the offset in the stream to seek to, relative to `SeekOrigin`. Valid values for `SeekOrigin` are: `0`: Seek from beginning. `1`: Seek from current position. `2`: Seek from end. Must return the new position within the stream; or `-1` if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If `-1` is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an `Offset` of `0` and a `SeekOrigin` of `1` to obtain the current position within the stream, even if seeking is not otherwise supported.
Write	Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. int Write(const void* buffer, int count) = 0; `Buffer` specifies the buffer with data to write to the stream. `Count` specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than `Count` if that many bytes could not be written. Must return `-1` if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (PDFEdit Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

PDFEdit Config Settings

AFRelationship[Key]: The value of the AFRelationship key for the attachment.

This setting specifies the value of the AFRelationship key for the attachment. 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. Key is either the index of the attachment in the Attachments properties or the Name of the attachment.

AutoTurnPages: Whether to change the page automatically upon exceeding the upper or lower page boundary.

This setting specifies whether the class will turn the page automatically. If set to true, the class will automatically progress to the next or previous page upon reaching a page boundary while adding new elements or changing the page position. If set to false, any new elements will be added to the current page, even if they are outside of the visible page region. The default value is true.

CloseInputStreamAfterProcessing: Whether to close the input stream after processing.

This setting determines whether the input stream specified in SetInputStream will be closed after processing is complete. The default value is true.

CloseOutputStreamAfterProcessing: Whether to close the output stream after processing.

This setting determines whether the output stream specified in SetOutputStream will be closed after processing is complete. The default value is true.

CompressStreams: Whether to compress stream objects.

This setting specifies whether the bytes in the document's stream objects will be compressed when the document is saved. The default value is true.

DefaultPageHeight: The default height for newly added pages.

This setting specifies the default height, in points, of pages added using the CreateNew or AddNewPage methods. The default value is 0, meaning the class will reuse the height of the previous page when adding a new page. If the new page will be the first in the document, the height will default to the standard 792.

DefaultPageWidth: The default width for newly added pages.

This setting specifies the default width, in points, of pages added using the CreateNew or AddNewPage methods. The default value is 0, meaning the class will reuse the width of the previous page when adding a new page. If the new page will be the first in the document, the width will default to the standard 612.

EnforcePDFA: Whether to enforce PDF/A compliance.

This setting specifies whether the class will enforce PDF/A compliance when operating on the document. If set to true, PDFALevel and PDFAPolicy will be used to establish the level of PDF/A compliance to apply. The default value is true.

FallbackFont: The fallback font.

This setting specifies the font that the class will use if it cannot find the intended font on the local system. In PDF/A, fonts must be embedded into the document, so this setting can be useful when text must be added but no font is available. The default value is Arial.

FontPaths: The font search paths.

This setting specifies a CRLF-separated list of paths where the class will search for additional TrueType font files. The default value is the system font search paths.

KeepPositionOnInsert: Whether to keep the current position after inserting an element.

This setting specifies whether the class will keep the current position at the set value after inserting an element. In the default configuration, insertion of a new element, such as a text block, moves the page position marker to the right of the newly inserted element. If set to true, the class will keep the position marker at its original location after adding the element. The default value is false.

LoadMedia: Whether to load images from the document.

This setting specifies whether the class will load images from the document. If media does not need to be accessed, it can be set to false to speed up document processing. The default value is true.

LogLevel: The level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. Possible values are:


0 (None)	No messages are logged.
1 (Info - default)	Informational events such as the basics of the chain validation procedure are logged.
2 (Verbose)	Detailed data such as HTTP requests are logged.
3 (Debug)	Debug data including the full chain validation procedure are logged.

OwnerPassword: The owner password to decrypt the document with.

This setting is used to provide the document owner password for decryption. Though it may be different from Password, most implementations use the same value for both.

PageCopyByRefElements: The names of page elements to be copied by reference.

This setting specifies a semicolon-separated list of names of page elements that will be copied by reference (shallow copy) instead of by value when AppendPage or InsertPage is called. If set to an empty string, the class will copy all page elements by value, which may lead to inefficient duplication of inherently shared objects such as fonts or bitmaps. The default value is Resources.

PDFALevel: The PDF/A conformance level to enforce.

This setting specifies the desired PDF/A conformance level that the class will attempt to enforce when EnforcePDFA is set to true. Possible values are:


1	PDF/A-1.
2	PDF/A-2.
3 (default)	PDF/A-3.

PDFAPolicy: The PDF/A policy to follow.

This setting specifies the PDF/A policy the class will follow when EnforcePDFA is set to true. Possible values are:


Default	Maps to Preserve.
Preserve	Keep existing document features and only write PDF/A-compliant pieces. If the class needs to write a non-compliant piece, it will throw an exception.
Enforce	Preserve PDF/A-compliant pieces and attempt to fix violations in the original document.

RightPadding: The width of the whitespace gap to the right of newly added elements.

This setting specifies the width, in points, of the empty space that is allowed to the right of newly added elements. Using a non-zero value for this setting allows multiple text blocks and other elements to be placed next to each other without sticking them together. This setting is ignored if KeepPositionOnInsert is set to true. The default value is 5.

SaveChanges: Whether to save changes made to the document.

This setting specifies whether and how changes made to the PDF document will be saved when the Close method is called. Possible values are:


0	Discard all changes.
1	Save the document to OutputFile, OutputData, or the stream set in SetOutputStream, even if it has not been modified.
2 (default)	Save the document to OutputFile, OutputData, or the stream set in SetOutputStream, but only if it has been modified.

SystemFontNames: The system font names.

This setting returns a CRLF-separated list of system TrueType font names that are supported by the class. This setting is read-only.

TempPath: The location where temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored. It can be useful to reduce memory usage.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (PDFEdit 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.

PDFEdit Errors

1203	Page index is out of bounds.
1209	Invalid PDF structure.
1210	Cannot remove last page.

PDF Errors

804	PDF decompression failed.
805	Cannot add entry to cross-reference table.
806	Unsupported field size.
807	Unsupported Encoding filter.
808	Unsupported predictor algorithm.
809	Unsupported document version.
812	Cannot read PDF file stream.
813	Cannot write to PDF file stream.
814	OutputFile already exists and Overwrite is `false`.
815	Invalid parameter.
817	Bad cross-reference entry.
818	Invalid object or generation number.
819	Invalid object stream.
820	Invalid stream dictionary.
821	Invalid AcroForm entry.
822	Invalid Root entry.
823	Invalid annotation.
824	The input document is empty.
826	OpenType font error. The error description contains the detailed message.
828	Invalid CMS data. The error description contains the detailed message.
835	Cannot change decryption mode for opened document.
836	Unsupported Date string.
838	Cryptographic error. The error description contains the detailed message.
840	DecryptionCert error. The error description contains the detailed message.
841	Encryption failed. The error description contains the detailed message.
842	No proper certificate for encryption found.
846	Unsupported revision.
847	Unsupported security handler SubFilter.
848	Failed to verify permissions.
849	Invalid password.
850	Invalid password information.
852	Unsupported encryption algorithm.
859	Cannot encrypt encrypted document.
864	Cannot modify document after signature update.
868	Cannot encrypt or decrypt object.
869	Invalid security handler information.
870	Invalid encrypted data.
871	Invalid block cipher padding.
872	Failed to reload signature.
873	Object is not encrypted.
874	Unexpected cipher information.
877	Invalid document. Bad document catalog.
878	Invalid document Id.
880	Invalid document. Invalid requirements dictionary.
881	Invalid linearization dictionary.
882	Invalid signature information.
883	Unsupported document format.
890	Unsupported feature.
891	Internal error. The error description contains the detailed message.
892	Unsupported color.
893	This operation is not supported for this PDF/A level.
894	Interactive features (Action) are not supported by PDF/A. Set EnforcePDFA to `false` or clear the Action property of the field.
895	Font file not found.

Parsing Errors

1001	Bad object.
1002	Bad document trailer.
1003	Illegal stream dictionary.
1004	Illegal string.
1005	Indirect object expected.
1007	Invalid reference.
1008	Invalid reference table.
1009	Invalid stream data.
1010	Unexpected character.
1011	Unexpected EOF.
1012	Unexpected indirect object in cross-reference table.
1013	RDF object not found.
1014	Invalid RDF object.
1015	Cannot create element with unknown prefix.
1021	Invalid type in Root object list.