Class PDFOptions
Provides options to manage PDF export behaviors.
Inheritance
Inherited Members
Namespace: BoldReports.Writer
Assembly: BoldReports.Web.dll
Syntax
public class PDFOptions : IReportDispose, IDisposable
Remarks
PDFOptions contains the properties to define the Fonts, TempPath, SplitPageCount and EnableSplitMerge
Constructors
PDFOptions()
Declaration
public PDFOptions()
Properties
EnableComplexScript
The property indicates that the content of the text should be treated as complex script text layout rendering.
Declaration
public bool EnableComplexScript { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | True if to consider as complex script; otherwise, false. |
Examples
ReportWriter reportWriter = new ReportWriter();
reportWriter.PDFOptions = new PDFOptions();
reportWriter.PDFOptions.EnableComplexScript = true;
EnableTableOfContents
Gets or sets whether to enable Table of contents to an PDF exported file or not.
Declaration
public bool EnableTableOfContents { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | It set to true if PDF file need to enable Table of Contents; otherwise false. |
EnableUniqueResourceNaming
The property indicates that the generating unique resource naming
Declaration
public bool EnableUniqueResourceNaming { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | True if to consider to generate the unique resource naming |
ExcludePDFBlankPage
Declaration
public bool ExcludePDFBlankPage { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Fonts
Load Font stream from external resources.
Declaration
public Dictionary<string, Stream> Fonts { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.IO.Stream> | Contains the collections of font stream. |
ImageProcessOption
Gets or sets process of pdf images.
Declaration
public PdfImageProcessOptions ImageProcessOption { get; set; }
Property Value
| Type | Description |
|---|---|
| PdfImageProcessOptions | Contains the details of TempFolderPath, and UseFileStreamProcess. |
PDFCertificates
Gets or sets the collection of PFX files to be used for digital signing operations.
Declaration
public List<PdfCertificate> PDFCertificates { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<PdfCertificate> | A System.Collections.Generic.List<T> of PdfCertificate objects. Each object encapsulates the necessary data (name, byte array, and password) for a single certificate. |
PdfConformanceLevel
Enable PDFA export.
Declaration
public PdfConformanceLevel PdfConformanceLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| Syncfusion.Pdf.PdfConformanceLevel | Contains the Pdf document's Conformance-level. |
Security
Protect the exported PDF from unauthorized users.
Declaration
public PdfSecurity Security { get; set; }
Property Value
| Type | Description |
|---|---|
| Syncfusion.Pdf.Security.PdfSecurity | Contains the security settings of the PDF document. |
Methods
Dispose()
Provides a mechanism for releasing unmanaged resources.
Declaration
public void Dispose()
Remarks
It close or release unmanaged resources such as files, streams, and handles held by an instance of the class that implements this interface.