Class PDFExport

PDF export (Adobe Acrobat)

Inheritance
System.Object
Base
ExportBase
PDFExport
Implements
Inherited Members
FastReport.Export.ExportBase.TabsIsExists
FastReport.Export.ExportBase.Export(FastReport.Report, System.Collections.Generic.List<FastReport.Preview.PreparedPages>)
FastReport.Export.ExportBase.GetOverlayPage(FastReport.ReportPage)
FastReport.Base.IsSelected
FastReport.Base.IsParentSelected
FastReport.Base.Delete()
FastReport.Base.OnBeforeInsert(System.Int32)
FastReport.Base.OnAfterInsert(FastReport.InsertFrom)
FastReport.Base.SelectionChanged()
FastReport.Base.GetContextMenu()
FastReport.Base.GetImageIndex()
Namespace: FastReport.Export.Pdf
Assembly: FastReport.dll
Syntax
public class PDFExport : ExportBase, IDisposable, IFRSerializable

Constructors

PDFExport()

Initializes a new instance of the PDFExport class.

Declaration
public PDFExport()

Properties

AllowAnnotate

Enable or disable annotating in protected document.

Declaration
public bool AllowAnnotate { get; set; }
Property Value
Type Description
System.Boolean

AllowCopy

Enable or disable copying in protected document.

Declaration
public bool AllowCopy { get; set; }
Property Value
Type Description
System.Boolean

AllowModify

Enable or disable modifying in protected document.

Declaration
public bool AllowModify { get; set; }
Property Value
Type Description
System.Boolean

AllowPrint

Enable or disable printing in protected document.

Declaration
public bool AllowPrint { get; set; }
Property Value
Type Description
System.Boolean

Author

Author of the document.

Declaration
public string Author { get; set; }
Property Value
Type Description
System.String

Background

Enable or disable of exporting the background.

Declaration
public bool Background { get; set; }
Property Value
Type Description
System.Boolean

CenterWindow

Enable or disable of centering the window.

Declaration
public bool CenterWindow { get; set; }
Property Value
Type Description
System.Boolean

ColorProfile

Color Profile (ICC file). If "null" then default profile will be used

Declaration
public byte[] ColorProfile { get; set; }
Property Value
Type Description
System.Byte[]

ColorSpace

Gets or sets PDF color space

Declaration
public PDFExport.PdfColorSpace ColorSpace { get; set; }
Property Value
Type Description
PDFExport.PdfColorSpace

Compressed

Enable or disable the compression in PDF document.

Declaration
public bool Compressed { get; set; }
Property Value
Type Description
System.Boolean

Creator

Creator of the document.

Declaration
public string Creator { get; set; }
Property Value
Type Description
System.String

CurvesInterpolation

The interpolation of curves (svg)

Declaration
public PDFExport.CurvesInterpolationEnum CurvesInterpolation { get; set; }
Property Value
Type Description
PDFExport.CurvesInterpolationEnum

CurvesInterpolationText

The interpolation of curves (text)

Declaration
public PDFExport.CurvesInterpolationEnum CurvesInterpolationText { get; set; }
Property Value
Type Description
PDFExport.CurvesInterpolationEnum

DefaultPage

Set default page on open document

Declaration
public int DefaultPage { get; set; }
Property Value
Type Description
System.Int32

DefaultZoom

Set default zoom on open document

Declaration
public PDFExport.MagnificationFactor DefaultZoom { get; set; }
Property Value
Type Description
PDFExport.MagnificationFactor

DigitalSignCertificate

Manualy sets digital sign certificate for exported documents.

Declaration
public X509Certificate2 DigitalSignCertificate { set; }
Property Value
Type Description
System.Security.Cryptography.X509Certificates.X509Certificate2
Remarks

This property is in priority, i.e. if a certificate is specified, the DigitalSignCertificatePath and DigitalSignCertificatePassword properties will not be used.

DigitalSignCertificatePassword

Sets digital sign certificate password.

Declaration
public string DigitalSignCertificatePassword { get; set; }
Property Value
Type Description
System.String

DigitalSignCertificatePath

The path for load digital sign certificate.

Declaration
public string DigitalSignCertificatePath { get; set; }
Property Value
Type Description
System.String

DigitalSignContactInfo

The information to enable the recipient to contact the signer to verify the signature

Declaration
public string DigitalSignContactInfo { get; set; }
Property Value
Type Description
System.String

DigitalSignLocation

Gets or sets the cpu host name or physical location of the signing

Declaration
public string DigitalSignLocation { get; set; }
Property Value
Type Description
System.String

DigitalSignReason

The reason for the signing, such as (I agree ...)

Declaration
public string DigitalSignReason { get; set; }
Property Value
Type Description
System.String

DisplayDocTitle

Enable or disable of displaying document's title.

Declaration
public bool DisplayDocTitle { get; set; }
Property Value
Type Description
System.Boolean

EmbeddingFonts

Enable or disable of embedding the TrueType fonts.

Declaration
public bool EmbeddingFonts { get; set; }
Property Value
Type Description
System.Boolean

ExportMode

Gets or sets pdf export mode

Declaration
public PDFExport.ExportType ExportMode { get; set; }
Property Value
Type Description
PDFExport.ExportType

FitWindow

Enable or disable of fitting the window

Declaration
public bool FitWindow { get; set; }
Property Value
Type Description
System.Boolean

GradientInterpolationPoints

Gradient interpolation, high value will lead beautiful the gradient, but the file size will increase and the speed of work will decrease.

Declaration
public PDFExport.GradientInterpolationPointsEnum GradientInterpolationPoints { get; set; }
Property Value
Type Description
PDFExport.GradientInterpolationPointsEnum

GradientQuality

The quality of gradient, export as image or export as gradient grid

Declaration
public PDFExport.GradientQualityEnum GradientQuality { get; set; }
Property Value
Type Description
PDFExport.GradientQualityEnum

HideMenubar

Enable or disable hide the menu's bar.

Declaration
public bool HideMenubar { get; set; }
Property Value
Type Description
System.Boolean

HideToolbar

Enable or disable hide the toolbar.

Declaration
public bool HideToolbar { get; set; }
Property Value
Type Description
System.Boolean

HideWindowUI

Enable or disable hide the Windows UI.

Declaration
public bool HideWindowUI { get; set; }
Property Value
Type Description
System.Boolean

ImagesOriginalResolution

Enables or disables saving images in their original resolution

Declaration
public bool ImagesOriginalResolution { get; set; }
Property Value
Type Description
System.Boolean

InteractiveForms

Gets pdf AcroForms compatibility, if set then EmbeddingFonts = false and PdfCompliance = PdfStandard.None

Declaration
public bool InteractiveForms { get; set; }
Property Value
Type Description
System.Boolean

InteractiveFormsFontSetPattern

Set pattern for selection of embedding glyphs for Interactive Forms

Declaration
public string InteractiveFormsFontSetPattern { get; set; }
Property Value
Type Description
System.String

IsDigitalSignEnable

Enable or disable digital sign for pdf document

Declaration
public bool IsDigitalSignEnable { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Be sure to specify a valid certificate for signing using the DigitalSignCertificate property. Or using the DigitalSignCertificatePath and DigitalSignCertificatePassword properties.

JpegCompression

Enable or disable image jpeg compression

Declaration
public bool JpegCompression { get; set; }
Property Value
Type Description
System.Boolean

JpegQuality

Sets the quality of images in the PDF

Declaration
public int JpegQuality { get; set; }
Property Value
Type Description
System.Int32

Keywords

Keywords of the document.

Declaration
public string Keywords { get; set; }
Property Value
Type Description
System.String

Outline

Enable or disable of document's Outline.

Declaration
public bool Outline { get; set; }
Property Value
Type Description
System.Boolean

OwnerPassword

Sets the owner password.

Declaration
public string OwnerPassword { get; set; }
Property Value
Type Description
System.String

PdfCompliance

Gets or sets PDF Compliance standard. After set, do not change other settings, it may lead to fail compliance test.

Declaration
public PDFExport.PdfStandard PdfCompliance { get; set; }
Property Value
Type Description
PDFExport.PdfStandard

PrintOptimized

Enables or disables optimization of images for printing

Declaration
public bool PrintOptimized { get; set; }
Property Value
Type Description
System.Boolean

PrintScaling

Enable or disable of scaling the page for shrink to printable area.

Declaration
public bool PrintScaling { get; set; }
Property Value
Type Description
System.Boolean

Producer

Producer of the document.

Declaration
public string Producer { get; set; }
Property Value
Type Description
System.String

RichTextQuality

Sets the quality of RichText objects in the PDF

Declaration
public int RichTextQuality { get; set; }
Property Value
Type Description
System.Int32

SaveDigitalSignCertificatePassword

Should save and serialize password for digital sign certificate. Do not save password unless absolutely necessary!!!

Declaration
public bool SaveDigitalSignCertificatePassword { get; set; }
Property Value
Type Description
System.Boolean

ShowPrintDialog

Enable or disable the print dialog window after opening

Declaration
public bool ShowPrintDialog { get; set; }
Property Value
Type Description
System.Boolean

Subject

Subject of the document.

Declaration
public string Subject { get; set; }
Property Value
Type Description
System.String

SvgAsPicture

Export svg object as image, not vector

Declaration
public bool SvgAsPicture { get; set; }
Property Value
Type Description
System.Boolean

TextInCurves

Enable or disable export text in curves

Declaration
public bool TextInCurves { get; set; }
Property Value
Type Description
System.Boolean

Title

Title of the document.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

TransparentImages

Enable or disable of images transparency.

Declaration
public bool TransparentImages { get; set; }
Property Value
Type Description
System.Boolean

UseFileStream

Enable or disable using FileStream instead of MemoryStream when exporting. Its useful when exporting huge reports on machines with small amount of RAM.

Declaration
public bool UseFileStream { get; set; }
Property Value
Type Description
System.Boolean

UserPassword

Sets the user password.

Declaration
public string UserPassword { get; set; }
Property Value
Type Description
System.String

Methods

AddEmbeddedFile(String, String, DateTime, PDFExport.EmbeddedRelation, String, Stream)

Add an embedded file (only for PDF/A-3 standard).

Declaration
public void AddEmbeddedFile(string name, string description, DateTime modDate, PDFExport.EmbeddedRelation relation, string mime, Stream fileStream)
Parameters
Type Name Description
System.String name

File name
System.String description

Description
System.DateTime modDate

Modification date
PDFExport.EmbeddedRelation relation

Relation type
System.String mime

MIME type
System.IO.Stream fileStream

File stream

AddEmbeddedXML(String, String, DateTime, Stream)

Add an embedded XML file (only for PDF/A-3 standard).

Declaration
public void AddEmbeddedXML(string name, string description, DateTime modDate, Stream fileStream)
Parameters
Type Name Description
System.String name

File name
System.String description

Description
System.DateTime modDate

Modification date
System.IO.Stream fileStream

File stream

AddEmbeddedXML(String, String, DateTime, Stream, PDFExport.ZUGFeRD_ConformanceLevel)

Add an embedded XML file (only for PDF/A-3 standard).

Declaration
public void AddEmbeddedXML(string name, string description, DateTime modDate, Stream fileStream, PDFExport.ZUGFeRD_ConformanceLevel ZUGFeRDLevel)
Parameters
Type Name Description
System.String name

File name
System.String description

Description
System.DateTime modDate

Modification date
System.IO.Stream fileStream

File stream
PDFExport.ZUGFeRD_ConformanceLevel ZUGFeRDLevel

ZUGFeRD Conformance Level

ExportBand(BandBase)

Export of Band

Declaration
protected override void ExportBand(BandBase band)
Parameters
Type Name Description
BandBase band
Overrides

ExportPageBegin(ReportPage)

Begin exporting of page

Declaration
protected override void ExportPageBegin(ReportPage page)
Parameters
Type Name Description
ReportPage page
Overrides

ExportPageEnd(ReportPage)

End exporting

Declaration
protected override void ExportPageEnd(ReportPage page)
Parameters
Type Name Description
ReportPage page
Overrides

Finish()

This method is called when the export is finished.

Declaration
protected override void Finish()
Overrides

GetFileFilter()

Returns a file filter for a save dialog.

Declaration
protected override string GetFileFilter()
Returns
Type Description
System.String

String that contains a file filter, for example: "Bitmap image (.bmp)|.bmp"
Overrides

Serialize(FRWriter)

Serializes the object.

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer

Writer object.
Overrides
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

ShowDialog()

Displays a dialog with export options.

Declaration
public override bool ShowDialog()
Returns
Type Description
System.Boolean

true if dialog was closed with OK button.
Overrides
FastReport.Export.ExportBase.ShowDialog()
Remarks

Before calling this method, set the report.

Start()

This method is called when the export starts.

Declaration
protected override void Start()
Overrides

Implements