# PDFEdit Class

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

## Syntax

```text
pdfsdk.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](#inputfile-property-pdfedit-class)), byte array ([InputData](#inputdata-property-pdfedit-class)), or stream ([SetInputStream](#setinputstream-method-pdfedit-class)) and call [Open](#open-method-pdfedit-class). When finished editing the document, call [Close](#close-method-pdfedit-class) to close it and save the changes to either [OutputFile](#outputfile-property-pdfedit-class), [OutputData](#outputdata-property-pdfedit-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfedit-class).

### Search, Replace, and Extract Text

 Use the [ReplacePageText](#replacepagetext-method-pdfedit-class) and [ReplaceDocumentText](#replacedocumenttext-method-pdfedit-class) 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 fires the [ReplaceText](#replacetext-event-pdfedit-class) event during this operation, providing the flexibility of skipping certain text blocks or updating the replacement string on the fly. For example:

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

 Please see [this article](https://www.nsoftware.com/kb/articles/pdfedit-searching-replacing-text) for more details about searching and replacing text.

Additionally, the [GetPageText](#getpagetext-method-pdfedit-class) and [GetDocumentText](#getdocumenttext-method-pdfedit-class) 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](#createnew-method-pdfedit-class) creates a blank PDF document.
- [AddTextBlock](#addtextblock-method-pdfedit-class) adds a block of text.
- [AddBitmap](#addbitmap-method-pdfedit-class) adds an image (JPEG, BMP, or PNG).
- [AddDrawing](#adddrawing-method-pdfedit-class) 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](#setposition-method-pdfedit-class) sets the page to work with and places the cursor at a specific position on the page.
- [SetFont](#setfont-method-pdfedit-class) sets the font to use, including its size, style, and color.
- [SetAlignment](#setalignment-method-pdfedit-class) sets the block alignment (left/center/right, top/center/bottom).
- [SetTransform](#settransform-method-pdfedit-class) 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](#appendpage-method-pdfedit-class), [InsertPage](#insertpage-method-pdfedit-class), [RemovePage](#removepage-method-pdfedit-class), and [RemovePages](#removepages-method-pdfedit-class) methods.

To copy pages from one document to another, open each document in an individual PDFEdit object. Then, using [SelectPage](#selectpage-method-pdfedit-class), select the page of document 1 that you want to add to document 2, and assign the [PDFPage](#pdfpage-type) object populated in its [SelectedPage](#selectedpage-property-pdfedit-class) property to the [NewPage](#newpage-property-pdfedit-class) property of the recipient document. Finally, commit the page to the recipient document using [AppendPage](#appendpage-method-pdfedit-class) or [InsertPage](#insertpage-method-pdfedit-class).

```csharp
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 [RemovePages](#removepages-method-pdfedit-class) to remove the respective subsets of pages from the document, then save each remaining part. For example:

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

 Please see [this article](https://www.nsoftware.com/kb/articles/pdfedit-splitting-merging) for more details about splitting and merging PDFs.

## 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](#attachments-property-pdfedit-class) | A collection of all attached files found in the document. |
| [DecryptionCert](#decryptioncert-property-pdfedit-class) | The decryption certificate. |
| [Font](#font-property-pdfedit-class) | The currently set font. |
| [InputData](#inputdata-property-pdfedit-class) | A byte array containing the PDF document to process. |
| [InputFile](#inputfile-property-pdfedit-class) | The PDF file to process. |
| [Media](#media-property-pdfedit-class) | A collection of all media objects found in the document. |
| [NewPage](#newpage-property-pdfedit-class) | A placeholder for a page object to be added to the document. |
| [OutputData](#outputdata-property-pdfedit-class) | A byte array containing the PDF document after processing. |
| [OutputFile](#outputfile-property-pdfedit-class) | The path to a local file where the output is written. |
| [Overwrite](#overwrite-property-pdfedit-class) | Whether the class should overwrite files. |
| [Password](#password-property-pdfedit-class) | The password to decrypt the document with. |
| [Position](#position-property-pdfedit-class) | The currently set position. |
| [SelectedPage](#selectedpage-property-pdfedit-class) | 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](#addattachment-method-pdfedit-class) | Adds an attachment to the document. |
| [AddBitmap](#addbitmap-method-pdfedit-class) | Adds a bitmap image to the document. |
| [AddDrawing](#adddrawing-method-pdfedit-class) | Adds a vector drawing to the document. |
| [AddTextBlock](#addtextblock-method-pdfedit-class) | Adds a block of text to the document. |
| [AppendPage](#appendpage-method-pdfedit-class) | Appends a page to the end of the document. |
| [Close](#close-method-pdfedit-class) | Closes the opened document. |
| [Config](#config-method-pdfedit-class) | Sets or retrieves a configuration setting. |
| [Convert](#convert-method-pdfedit-class) | Converts the document to a different format. |
| [CreateNew](#createnew-method-pdfedit-class) | Creates a new PDF document. |
| [Encrypted](#encrypted-method-pdfedit-class) | Checks whether the document is encrypted. |
| [GetDocumentProperty](#getdocumentproperty-method-pdfedit-class) | Returns the value of a document property. |
| [GetDocumentText](#getdocumenttext-method-pdfedit-class) | Returns the entire text content contained in the document. |
| [GetPageProperty](#getpageproperty-method-pdfedit-class) | Returns the value of a page property. |
| [GetPageText](#getpagetext-method-pdfedit-class) | Returns the text content residing on a specific page. |
| [InsertPage](#insertpage-method-pdfedit-class) | Inserts a page into the document. |
| [Open](#open-method-pdfedit-class) | Opens the document for processing. |
| [RemoveAttachment](#removeattachment-method-pdfedit-class) | Removes an attachment from the document. |
| [RemovePage](#removepage-method-pdfedit-class) | Removes a page from the document. |
| [RemovePages](#removepages-method-pdfedit-class) | Removes a subset of pages from the document. |
| [ReplaceDocumentText](#replacedocumenttext-method-pdfedit-class) | Replaces text in the document. |
| [ReplacePageText](#replacepagetext-method-pdfedit-class) | Replaces text on a page. |
| [Reset](#reset-method-pdfedit-class) | Resets the class. |
| [SaveAttachment](#saveattachment-method-pdfedit-class) | Saves a PDF attachment to a file. |
| [SaveMedia](#savemedia-method-pdfedit-class) | Saves a media object to a file. |
| [SelectPage](#selectpage-method-pdfedit-class) | Selects a page. |
| [SetAlignment](#setalignment-method-pdfedit-class) | Sets the object alignment for subsequent insertion operations. |
| [SetDocumentProperty](#setdocumentproperty-method-pdfedit-class) | Sets the value of a document property. |
| [SetFont](#setfont-method-pdfedit-class) | Sets the font properties to be applied to text. |
| [SetInputStream](#setinputstream-method-pdfedit-class) | Sets the stream containing the PDF document to process. |
| [SetOutputStream](#setoutputstream-method-pdfedit-class) | Sets the stream to write the processed document to. |
| [SetPosition](#setposition-method-pdfedit-class) | Sets the page and position for new text blocks or images. |
| [SetTransform](#settransform-method-pdfedit-class) | 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](#documentinfo-event-pdfedit-class) | Fired when the document has been loaded into memory. |
| [Error](#error-event-pdfedit-class) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-pdfedit-class) | Fired once for each log message. |
| [Password](#password-event-pdfedit-class) | Fired when the class detects that the document is encrypted with a password. |
| [RecipientInfo](#recipientinfo-event-pdfedit-class) | Fired for each recipient certificate of the encrypted document. |
| [ReplaceText](#replacetext-event-pdfedit-class) | 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\]](#AFRelationship[Key]) | The value of the AFRelationship key for the attachment. |
| [AutoTurnPages](#AutoTurnPages) | Whether to change the page automatically upon exceeding the upper or lower page boundary. |
| [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether to close the input stream after processing. |
| [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Whether to close the output stream after processing. |
| [CompressStreams](#CompressStreams) | Whether to compress stream objects. |
| [DefaultPageHeight](#DefaultPageHeight) | The default height for newly added pages. |
| [DefaultPageWidth](#DefaultPageWidth) | The default width for newly added pages. |
| [EnforcePDFA](#EnforcePDFA) | Whether to enforce PDF/A compliance. |
| [FallbackFont](#FallbackFont) | The fallback font. |
| [FontPaths](#FontPaths) | The font search paths. |
| [KeepPositionOnInsert](#KeepPositionOnInsert) | Whether to keep the current position after inserting an element. |
| [LoadMedia](#LoadMedia) | Whether to load images from the document. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [OwnerPassword](#OwnerPassword) | The owner password to decrypt the document with. |
| [PageCopyByRefElements](#PageCopyByRefElements) | The names of page elements to be copied by reference. |
| [PDFALevel](#PDFALevel) | The PDF/A conformance level to enforce. |
| [PDFAPolicy](#PDFAPolicy) | The PDF/A policy to follow. |
| [RightPadding](#RightPadding) | The width of the whitespace gap to the right of newly added elements. |
| [SaveChanges](#SaveChanges) | Whether to save changes made to the document. |
| [SystemFontNames](#SystemFontNames) | The system font names. |
| [TempPath](#TempPath) | The location where temporary files are stored. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |
| [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. |

# Attachments Property ([PDFEdit](#pdfedit-class) Class)

A collection of all attached files found in the document.

## Syntax

```text
public PDFAttachmentList getAttachments();
```

## Remarks

This property is used to access the details of all the attached files identified in the document. Use [AddAttachment](#addattachment-method-pdfedit-class), [RemoveAttachment](#removeattachment-method-pdfedit-class), and [SaveAttachment](#saveattachment-method-pdfedit-class) to add, remove, and save attachments to/from this collection respectively.

This property is not available at design time.

 Please refer to the [PDFAttachment](#pdfattachment-type) type for a complete list of fields.

# DecryptionCert Property ([PDFEdit](#pdfedit-class) Class)

The decryption certificate.

## Syntax

```text
public Certificate getDecryptionCert();
public void setDecryptionCert(Certificate decryptionCert);
```

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

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# Font Property ([PDFEdit](#pdfedit-class) Class)

The currently set font.

## Syntax

```text
public PDFFont getFont();
```

## Remarks

This property is used to access the font details specified using [SetFont](#setfont-method-pdfedit-class).

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

 Please refer to the [PDFFont](#pdffont-type) type for a complete list of fields.

# InputData Property ([PDFEdit](#pdfedit-class) Class)

A byte array containing the PDF document to process.

## Syntax

```text
public byte[] getInputData();
public void setInputData(byte[] inputData);
```

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

# InputFile Property ([PDFEdit](#pdfedit-class) Class)

The PDF file to process.

## Syntax

```text
public String getInputFile();
public void setInputFile(String inputFile);
```

## Default Value

""

## Remarks

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

# Media Property ([PDFEdit](#pdfedit-class) Class)

A collection of all media objects found in the document.

## Syntax

```text
public PDFMediaList getMedia();
```

## 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 [AddBitmap](#addbitmap-method-pdfedit-class) to add images to this collection, and use [SaveMedia](#savemedia-method-pdfedit-class) to extract the embedded media object to a local file.

This property is not available at design time.

 Please refer to the [PDFMedia](#pdfmedia-type) type for a complete list of fields.

# NewPage Property ([PDFEdit](#pdfedit-class) Class)

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

## Syntax

```text
public PDFPage getNewPage();
public void setNewPage(PDFPage newPage);
```

## Remarks

This property is used to specify a page object from another document to be added to the current document using [AppendPage](#appendpage-method-pdfedit-class) or [InsertPage](#insertpage-method-pdfedit-class).

This property is not available at design time.

 Please refer to the [PDFPage](#pdfpage-type) type for a complete list of fields.

# OutputData Property ([PDFEdit](#pdfedit-class) Class)

A byte array containing the PDF document after processing.

## Syntax

```text
public byte[] getOutputData();
```

## Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It is only set if an output file and output stream have not been assigned via [OutputFile](#outputfile-property-pdfedit-class) and [SetOutputStream](#setoutputstream-method-pdfedit-class) respectively.

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

# OutputFile Property ([PDFEdit](#pdfedit-class) Class)

The path to a local file where the output is written.

## Syntax

```text
public String getOutputFile();
public void setOutputFile(String outputFile);
```

## Default Value

""

## Remarks

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

# Overwrite Property ([PDFEdit](#pdfedit-class) Class)

Whether the class should overwrite files.

## Syntax

```text
public boolean isOverwrite();
public void setOverwrite(boolean overwrite);
```

## Default Value

False

## Remarks

This property indicates whether the class overwrites [OutputFile](#outputfile-property-pdfedit-class). If set to *false*, an error is thrown whenever [OutputFile](#outputfile-property-pdfedit-class) exists before an operation.

# Password Property ([PDFEdit](#pdfedit-class) Class)

The password to decrypt the document with.

## Syntax

```text
public String getPassword();
public void setPassword(String password);
```

## Default Value

""

## Remarks

This property is used to provide the user password for decryption. Though it may be different from [OwnerPassword](#OwnerPassword), most implementations use the same value for both.

# Position Property ([PDFEdit](#pdfedit-class) Class)

The currently set position.

## Syntax

```text
public PDFPagePosition getPosition();
```

## Remarks

This property is used to access the position details specified using [SetPosition](#setposition-method-pdfedit-class).

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

 Please refer to the [PDFPagePosition](#pdfpageposition-type) type for a complete list of fields.

# SelectedPage Property ([PDFEdit](#pdfedit-class) Class)

The currently selected page.

## Syntax

```text
public PDFPage getSelectedPage();
```

## Remarks

This property is used to access the page object that corresponds to the page selected using [SelectPage](#selectpage-method-pdfedit-class). Use page selection to copy a page from one document to another.

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

 Please refer to the [PDFPage](#pdfpage-type) type for a complete list of fields.

# AddAttachment Method ([PDFEdit](#pdfedit-class) Class)

Adds an attachment to the document.

## Syntax

```text
public void addAttachment(String fileName, String description);
```

## Remarks

This method is used to add an attachment (embedded file) to the document and to the [Attachments](#attachments-property-pdfedit-class) collection.

*FileName* and *Description* specify the filename and description of the attachment respectively.

**Example:**

```csharp
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](#attachments-property-pdfedit-class) collection.

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

# AddBitmap Method ([PDFEdit](#pdfedit-class) Class)

Adds a bitmap image to the document.

## Syntax

```text
public void addBitmap(String format, byte[] bitmapBytes, int width, int height);
```

## Remarks

This method is used to add a bitmap image to the document at the current [Position](#position-property-pdfedit-class) and to the [Media](#media-property-pdfedit-class) collection.

*Format* and *BitmapBytes* specify the format and raw data of the serialized image respectively. Possible values for the former are:

- JPEG2000
- JPEG
- Custom

 *Width* and *Height* specify the original width and height of the bitmap in pixels.

The full list of images is contained in the [Media](#media-property-pdfedit-class) collection. Use the following methods to adjust new image parameters:

- [SetAlignment](#setalignment-method-pdfedit-class)
- [SetPosition](#setposition-method-pdfedit-class)
- [SetTransform](#settransform-method-pdfedit-class)

# AddDrawing Method ([PDFEdit](#pdfedit-class) Class)

Adds a vector drawing to the document.

## Syntax

```text
public void addDrawing(String format, byte[] drawingBytes);
```

## Remarks

This method is used to add a vector drawing to the document at the current [Position](#position-property-pdfedit-class).

*Format* and *DrawingBytes* specify the format and raw data (as an encoded PDF appearance stream) of the drawing respectively. The former is reserved for future use.

# AddTextBlock Method ([PDFEdit](#pdfedit-class) Class)

Adds a block of text to the document.

## Syntax

```text
public void addTextBlock(String text);
```

## Remarks

This method is used to insert a block of *Text* into the document at the current [Position](#position-property-pdfedit-class). Use the following methods to adjust new text block parameters:

- [SetAlignment](#setalignment-method-pdfedit-class)
- [SetFont](#setfont-method-pdfedit-class)
- [SetPosition](#setposition-method-pdfedit-class)
- [SetTransform](#settransform-method-pdfedit-class)

# AppendPage Method ([PDFEdit](#pdfedit-class) Class)

Appends a page to the end of the document.

## Syntax

```text
public void appendPage();
```

## Remarks

This method is used to append the page specified in [NewPage](#newpage-property-pdfedit-class) to the end of the opened document. If [NewPage](#newpage-property-pdfedit-class) is not set, the class appends a new blank page.

Note that upon completion of this method, the [Position](#position-property-pdfedit-class) will not be automatically moved to the newly appended page.

# Close Method ([PDFEdit](#pdfedit-class) Class)

Closes the opened document.

## Syntax

```text
public void close();
```

## Remarks

This method is used to close the previously opened document. It should always be preceded by a call to [Open](#open-method-pdfedit-class).

**Example:**

```csharp
component.InputFile = "input.pdf";
component.Open();
// Some operation
component.Close();
```

 If any changes are made to the document, they are saved automatically to [OutputFile](#outputfile-property-pdfedit-class), [OutputData](#outputdata-property-pdfedit-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfedit-class) when this method is called. To configure this saving behavior, set [SaveChanges](#SaveChanges).

# Config Method ([PDFEdit](#pdfedit-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pdfedit-class) 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](#config-settings-pdfedit-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Convert Method ([PDFEdit](#pdfedit-class) Class)

Converts the document to a different format.

## Syntax

```text
public void convert(String format);
```

## Remarks

This method is used to convert the document to the format specified by *Format*. Possible values are:

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

# CreateNew Method ([PDFEdit](#pdfedit-class) Class)

Creates a new PDF document.

## Syntax

```text
public void createNew();
```

## Remarks

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

# Encrypted Method ([PDFEdit](#pdfedit-class) Class)

Checks whether the document is encrypted.

## Syntax

```text
public boolean encrypted();
```

## Remarks

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

**Example:**

```csharp
component.InputFile = "input.pdf";
if (component.Encrypted())
{
  // Set Password or DecryptionCert
}
component.Open();
// Some operation
component.Close();
```

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

# GetDocumentProperty Method ([PDFEdit](#pdfedit-class) Class)

Returns the value of a document property.

## Syntax

```text
public String getDocumentProperty(String documentProperty);
```

## Remarks

This method is used to obtain the value of a document property. Together with [SetDocumentProperty](#setdocumentproperty-method-pdfedit-class), 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.

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

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

```csharp
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](#documentinfo-event-pdfedit-class) event.

# GetDocumentText Method ([PDFEdit](#pdfedit-class) Class)

Returns the entire text content contained in the document.

## Syntax

```text
public String getDocumentText();
```

## Remarks

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

# GetPageProperty Method ([PDFEdit](#pdfedit-class) Class)

Returns the value of a page property.

## Syntax

```text
public String getPageProperty(int pageIndex, String pageProperty);
```

## Remarks

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

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

| 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. |
| 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 clockwise. Supported values: 0, 90, 180, 270. |
| Width | 0 | The width of the page in points. |

**Example:**

```csharp
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:

```csharp
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](#documentinfo-event-pdfedit-class) event.

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

# GetPageText Method ([PDFEdit](#pdfedit-class) Class)

Returns the text content residing on a specific page.

## Syntax

```text
public String getPageText(int pageIndex);
```

## Remarks

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

# InsertPage Method ([PDFEdit](#pdfedit-class) Class)

Inserts a page into the document.

## Syntax

```text
public void insertPage(int pageIndex);
```

## Remarks

This method is used to insert the page specified in [NewPage](#newpage-property-pdfedit-class) into the opened document at the position specified by *PageIndex* (zero-based). If [NewPage](#newpage-property-pdfedit-class) is not set, the class inserts a new blank page.

Note that upon completion of this method, the [Position](#position-property-pdfedit-class) will not be automatically moved to the newly inserted page.

# Open Method ([PDFEdit](#pdfedit-class) Class)

Opens the document for processing.

## Syntax

```text
public void open();
```

## Remarks

This method is used to open the document specified in [InputFile](#inputfile-property-pdfedit-class), [InputData](#inputdata-property-pdfedit-class), or [SetInputStream](#setinputstream-method-pdfedit-class) before performing some operation on it, such as extracting, editing, or replacing text. When finished, call [Close](#close-method-pdfedit-class) to complete or discard the operation.

It is recommended to use this method (alongside [Close](#close-method-pdfedit-class)) when performing multiple operations on the document at once.

# RemoveAttachment Method ([PDFEdit](#pdfedit-class) Class)

Removes an attachment from the document.

## Syntax

```text
public void removeAttachment(int index);
```

## Remarks

This method is used to remove an attachment from the document and from the [Attachments](#attachments-property-pdfedit-class) collection.

*Index* is the index of the attachment in the [Attachments](#attachments-property-pdfedit-class) collection to be removed.

**Example:**

```csharp
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 opens it, performs the operation, then closes it.

# RemovePage Method ([PDFEdit](#pdfedit-class) Class)

Removes a page from the document.

## Syntax

```text
public void removePage(int pageIndex);
```

## Remarks

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

# RemovePages Method ([PDFEdit](#pdfedit-class) Class)

Removes a subset of pages from the document.

## Syntax

```text
public void removePages(int pageIndex, int count);
```

## Remarks

This method is used to remove a sequence of *Count* pages from the opened document starting at the position specified by *PageIndex* (zero-based).

# ReplaceDocumentText Method ([PDFEdit](#pdfedit-class) Class)

Replaces text in the document.

## Syntax

```text
public int replaceDocumentText(String pattern, String value);
```

## Remarks

This method is used to replace all entries of *Pattern* with *Value* in the whole document.

The [ReplaceText](#replacetext-event-pdfedit-class) event fires repeatedly during its work to report every new search entry identified in the document. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

# ReplacePageText Method ([PDFEdit](#pdfedit-class) Class)

Replaces text on a page.

## Syntax

```text
public int replacePageText(int pageIndex, String pattern, String value);
```

## Remarks

This method is used to replace all entries of *Pattern* with *Value* on the page specified by *PageIndex* (zero-based).

The [ReplaceText](#replacetext-event-pdfedit-class) event fires repeatedly during its work to report every new search entry identified on the page. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

# Reset Method ([PDFEdit](#pdfedit-class) Class)

Resets the class.

## Syntax

```text
public void reset();
```

## Remarks

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

# SaveAttachment Method ([PDFEdit](#pdfedit-class) Class)

Saves a PDF attachment to a file.

## Syntax

```text
public void saveAttachment(int index, String fileName);
```

## Remarks

This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the [Attachments](#attachments-property-pdfedit-class) collection.

*Index* is the index of the attachment in the [Attachments](#attachments-property-pdfedit-class) collection to be saved.

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

**Example:**

```csharp
component.InputFile = "input_with_attachment.pdf";
component.Open();
component.SaveAttachment(0, "a.dat");
component.Close();
```

 **Example (saving to a stream):**

```csharp
component.InputFile = "input_with_attachment.pdf";
component.Attachments[0].OutputStream = myStream;
component.SaveAttachment(0, null); // null means use the OutputStream field if it's set
```

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

# SaveMedia Method ([PDFEdit](#pdfedit-class) Class)

Saves a media object to a file.

## Syntax

```text
public void saveMedia(int index, String fileName);
```

## Remarks

This method is used to retrieve the contents of a media object from the document and save it to a file. It does not modify the contents of the [Media](#media-property-pdfedit-class) collection.

*Index* is the index of the media object in the [Media](#media-property-pdfedit-class) collection to be saved.

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

**Example:**

```csharp
pdfedit.InputFile = "input_with_pictures.pdf";
pdfedit.Open();
pdfedit.SaveMedia(0, "picture.jpg");
pdfedit.Close();
```

 **Example (saving to a stream):**

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

# SelectPage Method ([PDFEdit](#pdfedit-class) Class)

Selects a page.

## Syntax

```text
public void selectPage(int pageIndex);
```

## Remarks

This method is used to select the page specified by *PageIndex* (zero-based) and populate its details in the [SelectedPage](#selectedpage-property-pdfedit-class) property. Use page selection to access a page's properties or copy it to another document.

# SetAlignment Method ([PDFEdit](#pdfedit-class) Class)

Sets the object alignment for subsequent insertion operations.

## Syntax

```text
public void setAlignment(int horizontalAlignment, int verticalAlignment);
```

## Remarks

This method is used to set the horizontal and vertical alignment parameters to apply when [AddTextBlock](#addtextblock-method-pdfedit-class) or [AddBitmap](#addbitmap-method-pdfedit-class) is called. Alignment specifies the position of the newly added text block or image relative to the current [Position](#position-property-pdfedit-class) on the page.

*HorizontalAlignment* specifies the horizontal alignment. Possible values are:

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

*VerticalAlignment* specifies the vertical alignment. Possible values are:

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

# SetDocumentProperty Method ([PDFEdit](#pdfedit-class) Class)

Sets the value of a document property.

## Syntax

```text
public void setDocumentProperty(String documentProperty, String value);
```

## Remarks

This method is used to adjust properties of the opened document. Together with [GetDocumentProperty](#getdocumentproperty-method-pdfedit-class), 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.

*DocumentProperty* and *Value* specify the document property and value to set respectively. Possible values for the former are:

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

```csharp
pdfedit.InputFile = "input.pdf";
pdfedit.Open();

pdfedit.SetDocumentProperty("Xmp[dc:description]", "My first book draft");
pdfedit.SetDocumentProperty("Xmp", "...xml data here...");

// Use language descriptors for multi-language properties
pdfedit.SetDocumentProperty("Xmp[dc:description[es]]", "El primer borrador de mi libro");

pdfedit.Close();
```

# SetFont Method ([PDFEdit](#pdfedit-class) Class)

Sets the font properties to be applied to text.

## Syntax

```text
public void setFont(String name, String size, String style, String color);
```

## Remarks

This method is used to define the font attributes for text.

*Name* specifies the font name.

*Size* specifies the font size, either as an absolute value (e.g., *12*) or relative adjustment (e.g., *+2*).

*Style* specifies the font style. The following syntax is supported:

*[B][I][bold][italic][##%][##%,##%][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.

*Color* 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 |

# SetInputStream Method ([PDFEdit](#pdfedit-class) Class)

Sets the stream containing the PDF document to process.

## Syntax

```text
public void setInputStream(java.io.InputStream inputStream);
```

## Remarks

This method is used to set the stream from which the class reads the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class reads the data from the input stream instead of from the [InputFile](#inputfile-property-pdfedit-class) or [InputData](#inputdata-property-pdfedit-class) properties.

NOTE: It may be useful to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) to *true* when using input streams.

# SetOutputStream Method ([PDFEdit](#pdfedit-class) Class)

Sets the stream to write the processed document to.

## Syntax

```text
public void setOutputStream(java.io.OutputStream outputStream);
```

## Remarks

This method is used to set the stream to which the class writes the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class writes the data to the output stream instead of writing to [OutputFile](#outputfile-property-pdfedit-class) or populating [OutputData](#outputdata-property-pdfedit-class).

NOTE: It may be useful to additionally set [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) to *true* when using output streams.

# SetPosition Method ([PDFEdit](#pdfedit-class) Class)

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

## Syntax

```text
public void setPosition(int pageIndex, String X, String Y);
```

## Remarks

This method is used to define the [Position](#position-property-pdfedit-class) where new text blocks or images are added. The page is identified by *PageIndex* (zero-based), *X* specifies the horizontal position, and *Y* 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:**

```csharp
// Sets to exact coordinates.
pdfedit.SetPosition(0, "100", "20");
// Moves 20 points to the right and 20 points down from the current position.
pdfedit.SetPosition(0, "{x}+20", "{y}-20");
// Moves 20 points from the right edge and 120 points from the top edge of the page.
pdfedit.SetPosition(0, "{width}-20", "{height}-120");
```

 NOTE: *PageIndex* set to *-1* specifies the last page of the document.

# SetTransform Method ([PDFEdit](#pdfedit-class) Class)

Sets the object transformation parameters for subsequent insertion operations.

## Syntax

```text
public void setTransform(String translationX, String translationY, String scaleX, String scaleY, String rotation, String skewA, String skewB);
```

## Remarks

This method is used to specify the transformation matrix to apply when [AddTextBlock](#addtextblock-method-pdfedit-class) or [AddBitmap](#addbitmap-method-pdfedit-class) is called. The transformation matrix defines how the coordinates and content of the newly added text block or image are mapped onto the page.

*TranslationX* and *TranslationY* specify the horizontal and vertical translation of the object in points.

*ScaleX* and *ScaleY* specify the horizontal and vertical scaling of the object (e.g., use *0.5* to scale an image to half its original size).

*Rotation* specifies the rotation angle of the object in degrees counterclockwise.

*SkewA* and *SkewB* specify the horizontal and vertical skew angles of the object in degrees (e.g., use *30* and *20* respectively to slant the object by 30 degrees horizontally and 20 degrees vertically).

# DocumentInfo Event ([PDFEdit](#pdfedit-class) Class)

Fired when the document has been loaded into memory.

## Syntax

```text
public class DefaultPDFEditEventListener implements PDFEditEventListener {
  ...
  public void documentInfo(PDFEditDocumentInfoEvent e) {}
  ...
}

public class PDFEditDocumentInfoEvent {
  public int pageCount;
}
```

## Remarks

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

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

*PageCount* reports the number of pages in the document.

This event is fired when [Open](#open-method-pdfedit-class) is called, but only after [Password](#password-event-pdfedit-class) or [RecipientInfo](#recipientinfo-event-pdfedit-class) is fired (if applicable) and the document has been decrypted.

# Error Event ([PDFEdit](#pdfedit-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
public class DefaultPDFEditEventListener implements PDFEditEventListener {
  ...
  public void error(PDFEditErrorEvent e) {}
  ...
}

public class PDFEditErrorEvent {
  public int errorCode;
  public String description;
}
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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](#trappable-errors-pdfedit-class) section.

# Log Event ([PDFEdit](#pdfedit-class) Class)

Fired once for each log message.

## Syntax

```text
public class DefaultPDFEditEventListener implements PDFEditEventListener {
  ...
  public void log(PDFEditLogEvent e) {}
  ...
}

public class PDFEditLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}
```

## Remarks

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

*LogLevel* 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. |

*Message* is the log message.

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

- CertValidator
- Font
- HTTP
- PDFInvalidSignature
- PDFRevocationInfo
- Timestamp
- TSL

# Password Event ([PDFEdit](#pdfedit-class) Class)

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

## Syntax

```text
public class DefaultPDFEditEventListener implements PDFEditEventListener {
  ...
  public void password(PDFEditPasswordEvent e) {}
  ...
}

public class PDFEditPasswordEvent {
  public boolean available;
  public boolean cancel; //read-write
}
```

## Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to [Password](#password-property-pdfedit-class).

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

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

# RecipientInfo Event ([PDFEdit](#pdfedit-class) Class)

Fired for each recipient certificate of the encrypted document.

## Syntax

```text
public class DefaultPDFEditEventListener implements PDFEditEventListener {
  ...
  public void recipientInfo(PDFEditRecipientInfoEvent e) {}
  ...
}

public class PDFEditRecipientInfoEvent {
  public String issuer;
  public String serialNumber;
  public String subjectKeyIdentifier;
  public boolean available;
  public boolean cancel; //read-write
}
```

## Remarks

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

*Issuer* specifies the subject of the issuer certificate.

*SerialNumber* specifies the serial number of the encryption certificate.

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

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

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

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

# ReplaceText Event ([PDFEdit](#pdfedit-class) Class)

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

## Syntax

```text
public class DefaultPDFEditEventListener implements PDFEditEventListener {
  ...
  public void replaceText(PDFEditReplaceTextEvent e) {}
  ...
}

public class PDFEditReplaceTextEvent {
  public int pageIndex;
  public int entryIndex;
  public int offset;
  public String pattern;
  public String substitute; //read-write
  public boolean skip; //read-write
}
```

## Remarks

This event is fired from within [ReplaceDocumentText](#replacedocumenttext-method-pdfedit-class) and [ReplacePageText](#replacepagetext-method-pdfedit-class), repeatedly, for each located *Pattern* string. It may be used to track and, if required, alter individual text substitutions.

*PageIndex* contains the page number where the entry is located.

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

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

*Substitute* contains the value that *Pattern* will be replaced with. This value matches the *Value* parameter passed to the respective [ReplaceDocumentText](#replacedocumenttext-method-pdfedit-class) or [ReplacePageText](#replacepagetext-method-pdfedit-class) call. Adjust it from the event handler if required.

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

# Certificate Type

This is the digital certificate being used.

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

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *String (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** *String (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** *String (read-only)*
*Default Value: ""*

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

 **Fingerprint** *String (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** *String (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** *String (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** *String (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.

 **KeyPassword** *String*
*Default Value: ""*

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys.

NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey).

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

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

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

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

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

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

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

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

 **PublicKeyAlgorithm** *String (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** *String (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** *String (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** *String*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_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. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

 **StoreB** *byte[]*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_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. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

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** *String*
*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:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

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

|  |  |
| --- | --- |
| 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, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 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** *String (read-only)*
*Default Value: ""*

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

 **ThumbprintMD5** *String (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** *String (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** *String (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** *String (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_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](#Certificate_f_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](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

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

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

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

 **Subject** *String*
*Default Value: ""*

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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** *String*
*Default Value: ""*

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

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

 **EncodedB** *byte[]*
*Default Value: ""*

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

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

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(int storeType, String store, String storePassword, String subject);
```

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

 After the store has been successfully opened, the class 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.

```text
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
```

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

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the class 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.

```text
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
```

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

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject);
```

 * 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 class 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.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
```

 * 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 class 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.

```text
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
```

 * 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 class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# PDFAttachment Type

The file being attached to the PDF document.

## Remarks

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

The following fields are available:

- [ContentType](#PDFAttachment_f_ContentType)

- [CreationDate](#PDFAttachment_f_CreationDate)

- [Data](#PDFAttachment_f_Data)

- [Description](#PDFAttachment_f_Description)

- [FileName](#PDFAttachment_f_FileName)

- [InputStream](#PDFAttachment_f_InputStream)

- [ModificationDate](#PDFAttachment_f_ModificationDate)

- [Name](#PDFAttachment_f_Name)

- [OutputStream](#PDFAttachment_f_OutputStream)

- [Size](#PDFAttachment_f_Size)

## Fields

 **ContentType** *String*
*Default Value: ""*

The content type of the attachment.

 **CreationDate** *String*
*Default Value: ""*

The creation date of the attachment.

 **Data** *String*
*Default Value: ""*

The raw data of the attachment.

If [OutputStream](#PDFAttachment_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveAttachment.

 **DataB** *byte[]*
*Default Value: ""*

The raw data of the attachment.

If [OutputStream](#PDFAttachment_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveAttachment.

 **Description** *String*
*Default Value: ""*

A textual description of the attachment.

 **FileName** *String*
*Default Value: ""*

The path and filename of the attachment.

 **InputStream** *java.io.InputStream*
*Default Value: ""*

A stream containing the attachment.

If this field is set to a valid stream, the class attaches the data from the stream as the current attachment.

 **ModificationDate** *String*
*Default Value: ""*

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

 **Name** *String*
*Default Value: ""*

The name of the attachment.

 **OutputStream** *java.io.OutputStream*
*Default Value: ""*

The stream to write the attachment to.

If this field is set to a valid stream, the class writes to the stream when an empty string is passed to SaveAttachment.

 **Size** *long (read-only)*
*Default Value: 0*

The attachment's size in bytes.

## Constructors

```text
public PDFAttachment();
```

```text
public PDFAttachment(String fileName);
```

```text
public PDFAttachment(String fileName, String description);
```

```text
public PDFAttachment(byte[] data, String name, String description);
```

```text
public PDFAttachment(java.io.InputStream inputStream, String name, String description);
```

# PDFFont Type

The font used in the PDF document.

## Remarks

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

The following fields are available:

- [Color](#PDFFont_f_Color)

- [Name](#PDFFont_f_Name)

- [Size](#PDFFont_f_Size)

- [Style](#PDFFont_f_Style)

## Fields

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

The color of the current font in hash-prefixed hexadecimal format or as a name.

 **Name** *String (read-only)*
*Default Value: "Times New Roman"*

The name of the current font.

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

The size of the current font in points.

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

The style of the current font.

## Constructors

```text
public PDFFont();
```

# PDFMedia Type

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

## 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](#PDFMedia_f_ContentType)

- [Data](#PDFMedia_f_Data)

- [Height](#PDFMedia_f_Height)

- [InputStream](#PDFMedia_f_InputStream)

- [OutputStream](#PDFMedia_f_OutputStream)

- [Size](#PDFMedia_f_Size)

- [Width](#PDFMedia_f_Width)

## Fields

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

The content type of the media object.

 **Data** *String*
*Default Value: ""*

The raw data of the media object.

If [OutputStream](#PDFMedia_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveMedia.

 **DataB** *byte[]*
*Default Value: ""*

The raw data of the media object.

If [OutputStream](#PDFMedia_f_OutputStream) is not set to a valid stream, the class writes to this field when an empty string is passed to SaveMedia.

 **Height** *int (read-only)*
*Default Value: 0*

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

 **InputStream** *java.io.InputStream*
*Default Value: ""*

A stream containing the media object.

If this field is set to a valid stream, the class adds the data from the stream as the current image.

 **OutputStream** *java.io.OutputStream*
*Default Value: ""*

The stream to write the image data to.

If this field is set to a valid stream, the class writes to the stream when an empty string is passed to SaveMedia.

 **Size** *long (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

```text
public PDFMedia();
```

```text
public PDFMedia(byte[] data);
```

```text
public PDFMedia(java.io.InputStream inputStream);
```

# PDFPage Type

A container for PDF page details.

## Remarks

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

The following fields are available:

- [Height](#PDFPage_f_Height)

- [Rotate](#PDFPage_f_Rotate)

- [Width](#PDFPage_f_Width)

## Fields

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

The height of the page in points.

 **Rotate** *int (read-only)*
*Default Value: 0*

The rotation angle of the page in degrees clockwise.

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

The width of the page in points.

## Constructors

```text
public PDFPage();
```

# PDFPagePosition Type

The position within a PDF document.

## Remarks

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

The following fields are available:

- [PageIndex](#PDFPagePosition_f_PageIndex)

- [X](#PDFPagePosition_f_X)

- [Y](#PDFPagePosition_f_Y)

## Fields

 **PageIndex** *int (read-only)*
*Default Value: 0*

The index of the current page in the PDF document.

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

The X coordinate of the current position on the page.

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

The Y coordinate of the current position on the page.

## Constructors

```text
public PDFPagePosition();
```

# Config Settings ([PDFEdit](#pdfedit-class) 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](#config-method-pdfedit-class) 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](#attachments-property-pdfedit-class) collection or the [Name](#PDFAttachment_f_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 turns the page automatically. If set to *true*, the class automatically progresses 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 are 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](#setinputstream-method-pdfedit-class) 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](#setoutputstream-method-pdfedit-class) 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 are 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 [CreateNew](#createnew-method-pdfedit-class) or [AddNewPage](PDFForm.md#PDFForm_m_AddNewPage). The default value is *0*, meaning the class reuses the height of the previous page when adding a new page. If the new page is the first in the document, the height defaults to the standard *792*.

**DefaultPageWidth**: The default width for newly added pages.This setting specifies the default width, in points, of pages added using [CreateNew](#createnew-method-pdfedit-class) or [AddNewPage](PDFForm.md#PDFForm_m_AddNewPage). The default value is *0*, meaning the class reuses the width of the previous page when adding a new page. If the new page is the first in the document, the width defaults to the standard *612*.

**EnforcePDFA**: Whether to enforce PDF/A compliance.This setting specifies whether the class enforces PDF/A compliance when operating on the document. If set to *true*, [PDFALevel](#PDFALevel) and [PDFAPolicy](#PDFAPolicy) are 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 uses 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.

**FontPaths**: The font search paths.This setting specifies a CRLF-separated list of directories where the class searches for additional TrueType font files. It is used when resolving a TrueType font specified in [SetFont](#setfont-method-pdfedit-class) without a full file path.

Each entry is interpreted as a directory path used during font lookup. To use a specific TrueType font file, either specify its filename and include the containing directory in this setting, or specify the full file path in [SetFont](#setfont-method-pdfedit-class).

The default value is the system font search paths. These paths are platform-dependent:

|  |  |
| --- | --- |
| Windows | %windir%\Fonts and %LOCALAPPDATA%\Microsoft\Windows\Fonts |
| macOS and iOS | /System/Library/Fonts/, /Library/Fonts/, and ~/Library/Fonts/ |
| Linux | Directories listed by dir entries in /etc/fonts/fonts.conf and /usr/local/etc/fonts/fonts.conf |
| Android | /system/fonts |

On Windows, the .NET and Java editions obtain these locations through the runtime APIs or the *windir*, *SystemRoot*, and *LOCALAPPDATA* environment variables.

To use custom directories together with the default system locations, include both to prevent the current search path list from being replaced. For example:

```csharp
string fontPaths = component.Config("FontPaths");
fontPaths += @"\r\nC:\Fonts";
component.Config("FontPaths=" + fontPaths);
```

**KeepPositionOnInsert**: Whether to keep the current position after inserting an element.This setting specifies whether the class keeps 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 keeps 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 loads 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](#log-event-pdfedit-class) 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](#password-property-pdfedit-class), 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 are copied by reference (shallow copy) instead of by value when [AppendPage](#appendpage-method-pdfedit-class) or [InsertPage](#insertpage-method-pdfedit-class) is called. If set to an empty string, the class copies 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 attempts to enforce when [EnforcePDFA](#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 follows when [EnforcePDFA](#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 throws 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](#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 are saved when [Close](#close-method-pdfedit-class) is called. Possible values are:

|  |  |
| --- | --- |
| 0 | Discard all changes. |
| 1 | Save the document to [OutputFile](#outputfile-property-pdfedit-class), [OutputData](#outputdata-property-pdfedit-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfedit-class), even if it has not been modified. |
| 2 (default) | Save the document to [OutputFile](#outputfile-property-pdfedit-class), [OutputData](#outputdata-property-pdfedit-class), or the stream set in [SetOutputStream](#setoutputstream-method-pdfedit-class), 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.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events.

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

**UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

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

 This setting is set to *false* by default on all platforms.

**UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*.

# Trappable Errors ([PDFEdit](#pdfedit-class) Class)

### 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](#outputfile-property-pdfedit-class) already exists and [Overwrite](#overwrite-property-pdfedit-class) 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](#decryptioncert-property-pdfedit-class) 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](#PDFField_f_Action)) are not supported by PDF/A. Set [EnforcePDFA](#EnforcePDFA) to false or clear the [Action](#PDFField_f_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. |