PDFEdit Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.SecurePDF.PDFEdit

Remarks

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

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

Search, Replace, and Extract Text

Content Composition

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

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

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

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

Document Merging and Splitting

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Attachments Property (PDFEdit Component)

A collection of all attached files found in the document.

Syntax

• C#
• VB.NET

public PDFAttachmentList Attachments { get; }

Public Property Attachments As PDFAttachmentList

Remarks

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

This property is not available at design time.

DecryptionCert Property (PDFEdit Component)

The decryption certificate.

Syntax

• C#
• VB.NET

public Certificate DecryptionCert { get; set; }

Public Property DecryptionCert As Certificate

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.

Font Property (PDFEdit Component)

The currently set font.

Syntax

• C#
• VB.NET

public PDFFont Font { get; }

Public ReadOnly Property Font As PDFFont

Remarks

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

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

InputData Property (PDFEdit Component)

A byte array containing the PDF document to process.

Syntax

• C#
• VB.NET

public byte[] InputData { get; set; }

Public Property InputData As Byte()

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

The PDF file to process.

Syntax

• C#
• VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

""

Remarks

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

Media Property (PDFEdit Component)

A collection of all media objects found in the document.

Syntax

• C#
• VB.NET

public PDFMediaList Media { get; }

Public Property Media As PDFMediaList

Remarks

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

Use the AddBitmap method to add images to this collection, and use the SaveMedia method to extract the embedded media object to a local file.

This property is not available at design time.

NewPage Property (PDFEdit Component)

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

Syntax

• C#
• VB.NET

public PDFPage NewPage { get; set; }

Public Property NewPage As PDFPage

Remarks

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

This property is not available at design time.

OutputData Property (PDFEdit Component)

A byte array containing the PDF document after processing.

Syntax

• C#
• VB.NET

public byte[] OutputData { get; }

Public ReadOnly Property OutputData As Byte()

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via OutputFile and SetOutputStream respectively.

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

OutputFile Property (PDFEdit Component)

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

Syntax

• C#
• VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

""

Remarks

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

Overwrite Property (PDFEdit Component)

Whether or not the component should overwrite files.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

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

Password Property (PDFEdit Component)

The password to decrypt the document with.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

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

Position Property (PDFEdit Component)

The currently set position.

Syntax

• C#
• VB.NET

public PDFPagePosition Position { get; }

Public ReadOnly Property Position As PDFPagePosition

Remarks

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

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

SelectedPage Property (PDFEdit Component)

The currently selected page.

Syntax

• C#
• VB.NET

public PDFPage SelectedPage { get; }

Public ReadOnly Property SelectedPage As PDFPage

Remarks

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

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

AddAttachment Method (PDFEdit Component)

Adds an attachment to the document.

Syntax

• C#
• VB.NET

public void AddAttachment(string fileName, string description);

Async Version
public async Task AddAttachment(string fileName, string description);
public async Task AddAttachment(string fileName, string description, CancellationToken cancellationToken);

Public Sub AddAttachment(ByVal FileName As String, ByVal Description As String)

Async Version
Public Sub AddAttachment(ByVal FileName As String, ByVal Description As String) As Task
Public Sub AddAttachment(ByVal FileName As String, ByVal Description As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to add an attachment (embedded file) to the document and to the Attachments collection.

The FileName and Description parameters specify the filename and description of the attachment respectively.

Example: component.InputFile = "input.pdf"; component.OutputFile = "input_with_attachment.pdf"; component.Open(); component.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; component.Attachments.Add(attachment); // Or using one of the constructors: component.Attachments.Add(new PDFAttachment("foo.txt", "desc")); component.Close(); The full list of attachments is contained in the Attachments collection.

NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

AddBitmap Method (PDFEdit Component)

Adds a bitmap image to the document.

Syntax

• C#
• VB.NET

public void AddBitmap(string format, byte[] bitmapBytes, int width, int height);

Async Version
public async Task AddBitmap(string format, byte[] bitmapBytes, int width, int height);
public async Task AddBitmap(string format, byte[] bitmapBytes, int width, int height, CancellationToken cancellationToken);

Public Sub AddBitmap(ByVal Format As String, ByVal BitmapBytes As Byte(), ByVal Width As Integer, ByVal Height As Integer)

Async Version
Public Sub AddBitmap(ByVal Format As String, ByVal BitmapBytes As Byte(), ByVal Width As Integer, ByVal Height As Integer) As Task
Public Sub AddBitmap(ByVal Format As String, ByVal BitmapBytes As Byte(), ByVal Width As Integer, ByVal Height As Integer, cancellationToken As CancellationToken) As Task

Remarks

This method is used to add a bitmap image to the document at the current Position and to the Media collection.

The Format and BitmapBytes parameters specify the format and raw data of the serialized image respectively. The former can take one of the following values:

• JPEG2000
• JPEG
• Custom

The full list of images is contained in the Media collection. Use the following methods to adjust new image parameters:

• SetAlignment
• SetPosition
• SetTransform

AddDrawing Method (PDFEdit Component)

Adds a vector drawing to the document.

Syntax

• C#
• VB.NET

public void AddDrawing(string format, byte[] drawingBytes);

Async Version
public async Task AddDrawing(string format, byte[] drawingBytes);
public async Task AddDrawing(string format, byte[] drawingBytes, CancellationToken cancellationToken);

Public Sub AddDrawing(ByVal Format As String, ByVal DrawingBytes As Byte())

Async Version
Public Sub AddDrawing(ByVal Format As String, ByVal DrawingBytes As Byte()) As Task
Public Sub AddDrawing(ByVal Format As String, ByVal DrawingBytes As Byte(), cancellationToken As CancellationToken) As Task

Remarks

This method is used to add a vector drawing to the document at the current Position.

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

AddTextBlock Method (PDFEdit Component)

Adds a block of text to the document.

Syntax

• C#
• VB.NET

public void AddTextBlock(string text);

Async Version
public async Task AddTextBlock(string text);
public async Task AddTextBlock(string text, CancellationToken cancellationToken);

Public Sub AddTextBlock(ByVal Text As String)

Async Version
Public Sub AddTextBlock(ByVal Text As String) As Task
Public Sub AddTextBlock(ByVal Text As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to insert a block of Text into the document at the current Position. Use the following methods to adjust new text block parameters:

• SetAlignment
• SetFont
• SetPosition
• SetTransform

AppendPage Method (PDFEdit Component)

Appends a page to the end of the document.

Syntax

• C#
• VB.NET

public void AppendPage();

Async Version
public async Task AppendPage();
public async Task AppendPage(CancellationToken cancellationToken);

Public Sub AppendPage()

Async Version
Public Sub AppendPage() As Task
Public Sub AppendPage(cancellationToken As CancellationToken) As Task

Remarks

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

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

Close Method (PDFEdit Component)

Closes the opened document.

Syntax

• C#
• VB.NET

public void Close();

Async Version
public async Task Close();
public async Task Close(CancellationToken cancellationToken);

Public Sub Close()

Async Version
Public Sub Close() As Task
Public Sub Close(cancellationToken As CancellationToken) As Task

Remarks

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

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); If any changes are made to the document, they will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Config Method (PDFEdit Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

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

Convert Method (PDFEdit Component)

Converts the document to a different format.

Syntax

• C#
• VB.NET

public void Convert(string format);

Async Version
public async Task Convert(string format);
public async Task Convert(string format, CancellationToken cancellationToken);

Public Sub Convert(ByVal Format As String)

Async Version
Public Sub Convert(ByVal Format As String) As Task
Public Sub Convert(ByVal Format As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to convert the document to the format specified by the Format parameter, which can take one of the following values:

CreateNew Method (PDFEdit Component)

Creates a new PDF document.

Syntax

• C#
• VB.NET

public void CreateNew();

Async Version
public async Task CreateNew();
public async Task CreateNew(CancellationToken cancellationToken);

Public Sub CreateNew()

Async Version
Public Sub CreateNew() As Task
Public Sub CreateNew(cancellationToken As CancellationToken) As Task

Remarks

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

Encrypted Method (PDFEdit Component)

Checks whether the document is encrypted.

Syntax

• C#
• VB.NET

public bool Encrypted();

Async Version
public async Task<bool> Encrypted();
public async Task<bool> Encrypted(CancellationToken cancellationToken);

Public Function Encrypted() As Boolean

Async Version
Public Function Encrypted() As Task(Of Boolean)
Public Function Encrypted(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

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

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

GetDocumentProperty Method (PDFEdit Component)

Returns the value of a document property.

Syntax

• C#
• VB.NET

public string GetDocumentProperty(string documentProperty);

Async Version
public async Task<string> GetDocumentProperty(string documentProperty);
public async Task<string> GetDocumentProperty(string documentProperty, CancellationToken cancellationToken);

Public Function GetDocumentProperty(ByVal DocumentProperty As String) As String

Async Version
Public Function GetDocumentProperty(ByVal DocumentProperty As String) As Task(Of String)
Public Function GetDocumentProperty(ByVal DocumentProperty As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method is used to obtain the value of a document property. Together with SetDocumentProperty, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

The DocumentProperty parameter specifies the document property to read and can take one of the following values:

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

GetDocumentText Method (PDFEdit Component)

Returns the entire text content contained in the document.

Syntax

• C#
• VB.NET

public string GetDocumentText();

Async Version
public async Task<string> GetDocumentText();
public async Task<string> GetDocumentText(CancellationToken cancellationToken);

Public Function GetDocumentText() As String

Async Version
Public Function GetDocumentText() As Task(Of String)
Public Function GetDocumentText(cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

GetPageProperty Method (PDFEdit Component)

Returns the value of a page property.

Syntax

• C#
• VB.NET

public string GetPageProperty(int pageIndex, string pageProperty);

Async Version
public async Task<string> GetPageProperty(int pageIndex, string pageProperty);
public async Task<string> GetPageProperty(int pageIndex, string pageProperty, CancellationToken cancellationToken);

Public Function GetPageProperty(ByVal PageIndex As Integer, ByVal PageProperty As String) As String

Async Version
Public Function GetPageProperty(ByVal PageIndex As Integer, ByVal PageProperty As String) As Task(Of String)
Public Function GetPageProperty(ByVal PageIndex As Integer, ByVal PageProperty As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

The PageIndex parameter specifies the page to read information about (with a valid range from 0 to PageCount - 1), and the PageProperty parameter specifies the page property to read. The latter can take one of the following values:

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

NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

GetPageText Method (PDFEdit Component)

Returns the text content residing on a specific page.

Syntax

• C#
• VB.NET

public string GetPageText(int pageIndex);

Async Version
public async Task<string> GetPageText(int pageIndex);
public async Task<string> GetPageText(int pageIndex, CancellationToken cancellationToken);

Public Function GetPageText(ByVal PageIndex As Integer) As String

Async Version
Public Function GetPageText(ByVal PageIndex As Integer) As Task(Of String)
Public Function GetPageText(ByVal PageIndex As Integer, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

InsertPage Method (PDFEdit Component)

Inserts a page into the document.

Syntax

• C#
• VB.NET

public void InsertPage(int pageIndex);

Async Version
public async Task InsertPage(int pageIndex);
public async Task InsertPage(int pageIndex, CancellationToken cancellationToken);

Public Sub InsertPage(ByVal PageIndex As Integer)

Async Version
Public Sub InsertPage(ByVal PageIndex As Integer) As Task
Public Sub InsertPage(ByVal PageIndex As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

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

Open Method (PDFEdit Component)

Opens the document for processing.

Syntax

• C#
• VB.NET

public void Open();

Async Version
public async Task Open();
public async Task Open(CancellationToken cancellationToken);

Public Sub Open()

Async Version
Public Sub Open() As Task
Public Sub Open(cancellationToken As CancellationToken) As Task

Remarks

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

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

RemoveAttachment Method (PDFEdit Component)

Removes an attachment from the document.

Syntax

• C#
• VB.NET

public void RemoveAttachment(int index);

Async Version
public async Task RemoveAttachment(int index);
public async Task RemoveAttachment(int index, CancellationToken cancellationToken);

Public Sub RemoveAttachment(ByVal Index As Integer)

Async Version
Public Sub RemoveAttachment(ByVal Index As Integer) As Task
Public Sub RemoveAttachment(ByVal Index As Integer, cancellationToken As CancellationToken) As Task

Remarks

This method is used to remove an attachment from the document and from the Attachments collection.

The Index parameter is the index of the attachment in the Attachments collection to be removed.

Example: pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

RemovePage Method (PDFEdit Component)

Removes a page from the document.

Syntax

• C#
• VB.NET

public void RemovePage(int pageIndex);

Async Version
public async Task RemovePage(int pageIndex);
public async Task RemovePage(int pageIndex, CancellationToken cancellationToken);

Public Sub RemovePage(ByVal PageIndex As Integer)

Async Version
Public Sub RemovePage(ByVal PageIndex As Integer) As Task
Public Sub RemovePage(ByVal PageIndex As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

RemovePages Method (PDFEdit Component)

Removes a subset of pages from the document.

Syntax

• C#
• VB.NET

public void RemovePages(int pageIndex, int count);

Async Version
public async Task RemovePages(int pageIndex, int count);
public async Task RemovePages(int pageIndex, int count, CancellationToken cancellationToken);

Public Sub RemovePages(ByVal PageIndex As Integer, ByVal Count As Integer)

Async Version
Public Sub RemovePages(ByVal PageIndex As Integer, ByVal Count As Integer) As Task
Public Sub RemovePages(ByVal PageIndex As Integer, ByVal Count As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

ReplaceDocumentText Method (PDFEdit Component)

Replaces text in the document.

Syntax

• C#
• VB.NET

public int ReplaceDocumentText(string pattern, string value);

Async Version
public async Task<int> ReplaceDocumentText(string pattern, string value);
public async Task<int> ReplaceDocumentText(string pattern, string value, CancellationToken cancellationToken);

Public Function ReplaceDocumentText(ByVal Pattern As String, ByVal Value As String) As Integer

Async Version
Public Function ReplaceDocumentText(ByVal Pattern As String, ByVal Value As String) As Task(Of Integer)
Public Function ReplaceDocumentText(ByVal Pattern As String, ByVal Value As String, cancellationToken As CancellationToken) As Task(Of Integer)

Remarks

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

The ReplaceText event will fire repeatedly during its work to report every new search entry identified in the document. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

ReplacePageText Method (PDFEdit Component)

Replaces text on a page.

Syntax

• C#
• VB.NET

public int ReplacePageText(int pageIndex, string pattern, string value);

Async Version
public async Task<int> ReplacePageText(int pageIndex, string pattern, string value);
public async Task<int> ReplacePageText(int pageIndex, string pattern, string value, CancellationToken cancellationToken);

Public Function ReplacePageText(ByVal PageIndex As Integer, ByVal Pattern As String, ByVal Value As String) As Integer

Async Version
Public Function ReplacePageText(ByVal PageIndex As Integer, ByVal Pattern As String, ByVal Value As String) As Task(Of Integer)
Public Function ReplacePageText(ByVal PageIndex As Integer, ByVal Pattern As String, ByVal Value As String, cancellationToken As CancellationToken) As Task(Of Integer)

Remarks

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

The ReplaceText event will fire repeatedly during its work to report every new search entry identified on the page. Subscribe to that event to adjust the substitute on the fly.

This method returns the number of occurrences found and replaced.

Reset Method (PDFEdit Component)

Resets the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SaveAttachment Method (PDFEdit Component)

Saves a PDF attachment to a file.

Syntax

• C#
• VB.NET

public void SaveAttachment(int index, string fileName);

Async Version
public async Task SaveAttachment(int index, string fileName);
public async Task SaveAttachment(int index, string fileName, CancellationToken cancellationToken);

Public Sub SaveAttachment(ByVal Index As Integer, ByVal FileName As String)

Async Version
Public Sub SaveAttachment(ByVal Index As Integer, ByVal FileName As String) As Task
Public Sub SaveAttachment(ByVal Index As Integer, ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); Example (saving to a stream): component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream field if it's set NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

SaveMedia Method (PDFEdit Component)

Saves a media object to a file.

Syntax

• C#
• VB.NET

public void SaveMedia(int index, string fileName);

Async Version
public async Task SaveMedia(int index, string fileName);
public async Task SaveMedia(int index, string fileName, CancellationToken cancellationToken);

Public Sub SaveMedia(ByVal Index As Integer, ByVal FileName As String)

Async Version
Public Sub SaveMedia(ByVal Index As Integer, ByVal FileName As String) As Task
Public Sub SaveMedia(ByVal Index As Integer, ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

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

SelectPage Method (PDFEdit Component)

Selects a page.

Syntax

• C#
• VB.NET

public void SelectPage(int pageIndex);

Async Version
public async Task SelectPage(int pageIndex);
public async Task SelectPage(int pageIndex, CancellationToken cancellationToken);

Public Sub SelectPage(ByVal PageIndex As Integer)

Async Version
Public Sub SelectPage(ByVal PageIndex As Integer) As Task
Public Sub SelectPage(ByVal PageIndex As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

SetAlignment Method (PDFEdit Component)

Sets the object alignment for subsequent insertion operations.

Syntax

• C#
• VB.NET

public void SetAlignment(int horizontalAlignment, int verticalAlignment);

Async Version
public async Task SetAlignment(int horizontalAlignment, int verticalAlignment);
public async Task SetAlignment(int horizontalAlignment, int verticalAlignment, CancellationToken cancellationToken);

Public Sub SetAlignment(ByVal HorizontalAlignment As Integer, ByVal VerticalAlignment As Integer)

Async Version
Public Sub SetAlignment(ByVal HorizontalAlignment As Integer, ByVal VerticalAlignment As Integer) As Task
Public Sub SetAlignment(ByVal HorizontalAlignment As Integer, ByVal VerticalAlignment As Integer, cancellationToken As CancellationToken) As Task

Remarks

This method is used to set the horizontal and vertical alignment parameters to apply when AddTextBlock or AddBitmap is called. Alignment specifies the position of the newly added text block or image relative to the current Position on the page.

The HorizontalAlignment parameter specifies the horizontal alignment and can be one of the following values:

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

SetDocumentProperty Method (PDFEdit Component)

Sets the value of a document property.

Syntax

• C#
• VB.NET

public void SetDocumentProperty(string documentProperty, string value);

Async Version
public async Task SetDocumentProperty(string documentProperty, string value);
public async Task SetDocumentProperty(string documentProperty, string value, CancellationToken cancellationToken);

Public Sub SetDocumentProperty(ByVal DocumentProperty As String, ByVal Value As String)

Async Version
Public Sub SetDocumentProperty(ByVal DocumentProperty As String, ByVal Value As String) As Task
Public Sub SetDocumentProperty(ByVal DocumentProperty As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to adjust properties of the opened document. Together with GetDocumentProperty, this method provides an extensible way of managing the document settings that are not available through other means. The list of settings below may be extended in the future.

The DocumentProperty and Value parameters specify the document property and value to set respectively. The former can take one of the following values:

Example: pdfedit.InputFile = "input.pdf"; pdfedit.Open(); pdfedit.SetDocumentProperty("Xmp[dc:description]", "My first book draft"); pdfedit.SetDocumentProperty("Xmp", "...xml data here..."); // Use language descriptors for multi-language properties pdfedit.SetDocumentProperty("Xmp[dc:description[es]]", "El primer borrador de mi libro"); pdfedit.Close();

SetFont Method (PDFEdit Component)

Sets the font properties to be applied to text.

Syntax

• C#
• VB.NET

public void SetFont(string name, string size, string style, string color);

Async Version
public async Task SetFont(string name, string size, string style, string color);
public async Task SetFont(string name, string size, string style, string color, CancellationToken cancellationToken);

Public Sub SetFont(ByVal Name As String, ByVal Size As String, ByVal Style As String, ByVal Color As String)

Async Version
Public Sub SetFont(ByVal Name As String, ByVal Size As String, ByVal Style As String, ByVal Color As String) As Task
Public Sub SetFont(ByVal Name As String, ByVal Size As String, ByVal Style As String, ByVal Color As String, cancellationToken As CancellationToken) As Task

Remarks

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

The Name parameter specifies the font name.

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

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

[B][I][U][bold][italic][underline][##%][##%,##%][0.###][0.###]

For example:

• bold
• bold 50%
• bold italic 50%
• BI 50% 42%
• B 50% italic 0.42

The Color parameter specifies the font color in hash-prefixed hexadecimal format (such as #FF0000 for red). The following HTML color aliases are also supported:

SetInputStream Method (PDFEdit Component)

Sets the stream containing the PDF document to process.

Syntax

• C#
• VB.NET

public void SetInputStream(System.IO.Stream inputStream);

Async Version
public async Task SetInputStream(System.IO.Stream inputStream);
public async Task SetInputStream(System.IO.Stream inputStream, CancellationToken cancellationToken);

Public Sub SetInputStream(ByVal InputStream As System.IO.Stream)

Async Version
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream) As Task
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

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

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

SetOutputStream Method (PDFEdit Component)

Sets the stream to write the processed document to.

Syntax

• C#
• VB.NET

public void SetOutputStream(System.IO.Stream outputStream);

Async Version
public async Task SetOutputStream(System.IO.Stream outputStream);
public async Task SetOutputStream(System.IO.Stream outputStream, CancellationToken cancellationToken);

Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream)

Async Version
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream) As Task
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

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

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

SetPosition Method (PDFEdit Component)

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

Syntax

• C#
• VB.NET

public void SetPosition(int pageIndex, string X, string Y);

Async Version
public async Task SetPosition(int pageIndex, string X, string Y);
public async Task SetPosition(int pageIndex, string X, string Y, CancellationToken cancellationToken);

Public Sub SetPosition(ByVal PageIndex As Integer, ByVal X As String, ByVal Y As String)

Async Version
Public Sub SetPosition(ByVal PageIndex As Integer, ByVal X As String, ByVal Y As String) As Task
Public Sub SetPosition(ByVal PageIndex As Integer, ByVal X As String, ByVal Y As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to define the Position where new text blocks or images will be added. The page is identified by the PageIndex parameter (zero-based), the X parameter specifies the horizontal position, and the Y parameter specifies the vertical position.

X and Y values that are absolute, relative to the current position, and relative to the page dimensions are all supported.

Example: // Sets to exact coordinates. pdfedit.SetPosition(0, "100", "20"); // Moves 20 points to the right and 20 points down from the current position. pdfedit.SetPosition(0, "{x}+20", "{y}-20"); // Moves 20 points from the right edge and 120 points from the top edge of the page. pdfedit.SetPosition(0, "{width}-20", "{height}-120"); NOTE: PageIndex set to -1 specifies the last page of the document.

SetTransform Method (PDFEdit Component)

Sets the object transformation parameters for subsequent insertion operations.

Syntax

• C#
• VB.NET

public void SetTransform(string translationX, string translationY, string scaleX, string scaleY, string rotation, string skewA, string skewB);

Async Version
public async Task SetTransform(string translationX, string translationY, string scaleX, string scaleY, string rotation, string skewA, string skewB);
public async Task SetTransform(string translationX, string translationY, string scaleX, string scaleY, string rotation, string skewA, string skewB, CancellationToken cancellationToken);

Public Sub SetTransform(ByVal TranslationX As String, ByVal TranslationY As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String)

Async Version
Public Sub SetTransform(ByVal TranslationX As String, ByVal TranslationY As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String) As Task
Public Sub SetTransform(ByVal TranslationX As String, ByVal TranslationY As String, ByVal ScaleX As String, ByVal ScaleY As String, ByVal Rotation As String, ByVal SkewA As String, ByVal SkewB As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to specify the transformation matrix to apply when AddTextBlock or AddBitmap is called. The transformation matrix defines how the coordinates and content of the newly added text block or image are mapped onto the page.

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

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

The Rotation parameter specifies the rotation angle of the object in degrees.

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

DocumentInfo Event (PDFEdit Component)

Fired when the document has been loaded into memory.

Syntax

• C#
• VB.NET

public event OnDocumentInfoHandler OnDocumentInfo;

public delegate void OnDocumentInfoHandler(object sender, PDFEditDocumentInfoEventArgs e);

public class PDFEditDocumentInfoEventArgs : EventArgs {
  public int PageCount { get; }
}

Public Event OnDocumentInfo As OnDocumentInfoHandler

Public Delegate Sub OnDocumentInfoHandler(sender As Object, e As PDFEditDocumentInfoEventArgs)

Public Class PDFEditDocumentInfoEventArgs Inherits EventArgs
  Public ReadOnly Property PageCount As Integer
End Class

Remarks

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

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

The PageCount parameter reports the number of pages in the document.

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

Error Event (PDFEdit Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PDFEditErrorEventArgs e);

public class PDFEditErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PDFEditErrorEventArgs)

Public Class PDFEditErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

Log Event (PDFEdit Component)

Fired once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, PDFEditLogEventArgs e);

public class PDFEditLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As PDFEditLogEventArgs)

Public Class PDFEditLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

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

The Message parameter is the log message.

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

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

Password Event (PDFEdit Component)

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

Syntax

• C#
• VB.NET

public event OnPasswordHandler OnPassword;

public delegate void OnPasswordHandler(object sender, PDFEditPasswordEventArgs e);

public class PDFEditPasswordEventArgs : EventArgs {
  public bool Available { get; }
  public bool Cancel { get; set; }
}

Public Event OnPassword As OnPasswordHandler

Public Delegate Sub OnPasswordHandler(sender As Object, e As PDFEditPasswordEventArgs)

Public Class PDFEditPasswordEventArgs Inherits EventArgs
  Public ReadOnly Property Available As Boolean
  Public Property Cancel As Boolean
End Class

Remarks

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

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

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

RecipientInfo Event (PDFEdit Component)

Fired for each recipient certificate of the encrypted document.

Syntax

• C#
• VB.NET

public event OnRecipientInfoHandler OnRecipientInfo;

public delegate void OnRecipientInfoHandler(object sender, PDFEditRecipientInfoEventArgs e);

public class PDFEditRecipientInfoEventArgs : EventArgs {
  public string Issuer { get; }
  public string SerialNumber { get; }
  public string SubjectKeyIdentifier { get; }
  public bool Available { get; }
  public bool Cancel { get; set; }
}

Public Event OnRecipientInfo As OnRecipientInfoHandler

Public Delegate Sub OnRecipientInfoHandler(sender As Object, e As PDFEditRecipientInfoEventArgs)

Public Class PDFEditRecipientInfoEventArgs Inherits EventArgs
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property SerialNumber As String
  Public ReadOnly Property SubjectKeyIdentifier As String
  Public ReadOnly Property Available As Boolean
  Public Property Cancel As Boolean
End Class

Remarks

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

The Issuer parameter specifies the subject of the issuer certificate.

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

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

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

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

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

ReplaceText Event (PDFEdit Component)

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

Syntax

• C#
• VB.NET

public event OnReplaceTextHandler OnReplaceText;

public delegate void OnReplaceTextHandler(object sender, PDFEditReplaceTextEventArgs e);

public class PDFEditReplaceTextEventArgs : EventArgs {
  public int PageIndex { get; }
  public int EntryIndex { get; }
  public int Offset { get; }
  public string Pattern { get; }
  public string Substitute { get; set; }
  public bool Skip { get; set; }
}

Public Event OnReplaceText As OnReplaceTextHandler

Public Delegate Sub OnReplaceTextHandler(sender As Object, e As PDFEditReplaceTextEventArgs)

Public Class PDFEditReplaceTextEventArgs Inherits EventArgs
  Public ReadOnly Property PageIndex As Integer
  Public ReadOnly Property EntryIndex As Integer
  Public ReadOnly Property Offset As Integer
  Public ReadOnly Property Pattern As String
  Public Property Substitute As String
  Public Property Skip As Boolean
End Class

Remarks

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

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

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

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

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

The Skip parameter determines whether the component 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.

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

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

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.

• ContentType
• CreationDate
• Data
• Description
• FileName
• InputStream
• ModificationDate
• Name
• OutputStream
• Size

Fields

Constructors

• C#
• VB.NET

public PDFAttachment();

Public PDFAttachment()

• C#
• VB.NET

public PDFAttachment(string fileName);

Public PDFAttachment(ByVal FileName As String)

• C#
• VB.NET

public PDFAttachment(string fileName, string description);

Public PDFAttachment(ByVal FileName As String, ByVal Description As String)

• C#
• VB.NET

public PDFAttachment(byte[] data, string name, string description);

Public PDFAttachment(ByVal Data As Byte(), ByVal Name As String, ByVal Description As String)

• C#
• VB.NET

public PDFAttachment(System.IO.Stream inputStream, string name, string description);

Public PDFAttachment(ByVal InputStream As System.IO.Stream, ByVal Name As String, ByVal Description As String)

PDFFont Type

The font used in the PDF document.

Remarks

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

• Color
• Name
• Size
• Style

Fields

Constructors

• C#
• VB.NET

public PDFFont();

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.

• ContentType
• Data
• Height
• InputStream
• OutputStream
• Size
• Width

Fields

Constructors

• C#
• VB.NET

public PDFMedia();

Public PDFMedia()

• C#
• VB.NET

public PDFMedia(byte[] data);

Public PDFMedia(ByVal Data As Byte())

• C#
• VB.NET

public PDFMedia(System.IO.Stream inputStream);

Public PDFMedia(ByVal InputStream As System.IO.Stream)

PDFPage Type

A container for PDF page details.

Remarks

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

• Height
• Rotate
• Width

Fields

Constructors

• C#
• VB.NET

public PDFPage();

Public PDFPage()

PDFPagePosition Type

The position within a PDF document.

Remarks

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

• PageIndex
• X
• Y

Fields

Constructors

• C#
• VB.NET

public PDFPagePosition();

Public PDFPagePosition()

Config Settings (PDFEdit Component)

PDFEdit Config Settings

Base Config Settings

Trappable Errors (PDFEdit Component)

PDFEdit Errors

PDF Errors

Parsing Errors