Class QPdfClient<T>
Inheritance
Implements
Namespace: IronSoftware.Pdfium
Assembly: IronPdf.dll
Syntax
public abstract class QPdfClient<T> : Object, IDisposable, IQPdfClient where T : QPdfDeploymentBase
Type Parameters
| Name | Description |
|---|---|
| T |
Constructors
QPdfClient(Boolean)
Declaration
protected QPdfClient(bool deployQpdf = true)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | deployQpdf |
Methods
CompleteSavingAsPdfA4(IDocumentId, String, String)
Applies final PDF/A-4 specific flags and saves the provided PDF content using QPdf.
Declaration
public void CompleteSavingAsPdfA4(IDocumentId documentId, string outputPath, string password = "")
Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.IDocumentId | documentId | The id of the input document. |
| System.String | outputPath | The file path where the PDF should be saved. |
| System.String | password | An optional password to encrypt the PDF. Pass |
Remarks
Note: IronSoftware.Pdfium.IPdfClient.ConvertToPdfA(IronSoftware.IDocumentId,System.Byte[],IronPdf.InternalPdfAVersion) should be called before invoking this method to perform the actual conversion.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown if |
| System.IO.IOException | Thrown if there is an error retrieving the PDF bytes from the native PDF library. |
| System.Exception | Thrown if the QPdf handle creation, reading, initialization, or writing fails. |
Dispose()
Declaration
public virtual void Dispose()
IsLinearized(String, String)
Check if a file is linearized or not
Declaration
public bool IsLinearized(string path, string password)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | file path where the linearized file is located |
| System.String | password | password of the pdf content |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns true if the file is linearized, otherwise returns false |
SaveAsLinearized(IDocumentId, String, String)
Save PDF document as a linearized PDF file
Declaration
public void SaveAsLinearized(IDocumentId id, string path, string password)
Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.IDocumentId | id | id of the document |
| System.String | path | path where the linearized file will be saved |
| System.String | password | password of the pdf content |
SaveAsLinearized(Byte[], String, String)
Save PDF document as a linearized PDF file
Declaration
public void SaveAsLinearized(byte[] pdfBytes, string path, string password)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | pdfBytes | |
| System.String | path | path where the linearized file will be saved |
| System.String | password | password of the pdf content |