IRichEditPdfSettings Interface

Declares settings related to document export to PDF.

Declaration

export interface IRichEditPdfSettings

Remarks

To learn more about PDF export in the Rich Text Editor, see the following topic: Export to PDF.

Properties

blobStream Property

A constructor that creates a blobStream object.

Declaration

blobStream?: new () => any

Remarks

To export a document to PDF, the RichEdit control requires a blobStream constructor. Depending on the framework and the way the library is built, this constructor can be placed in different directories. The control searches for the constructor in window.BlobStream. If the constructor is in another directory, specify the blobStream property.

defaultFontName Property

Specifies a default font to which font families are mapped.

Declaration

defaultFontName?: string

Property Value

Type	Description
string	The font name.

Remarks

The defaultFontName property specifies the name of the default font to which font families are mapped (when there is no appropriate rule in the rules collection).

Note

The defaultFontName property value should match the name property value of a font listed in the fonts collection.

exportUrl Property

Specifies the path where the exported PDF document is sent for further processing.

Declaration

exportUrl?: string

Property Value

Type	Description
string	The URL.

pdfDocument Property

A constructor that creates a PDFDocument object.

Declaration

pdfDocument?: new (options?: {
    autoFirstPage: boolean;
    defaultFont: any;
}) => any

Remarks

To export a document to PDF, the RichEdit control requires a PDFDocument constructor. Depending on the framework and the way the library is built, this constructor can be placed in different directories. The control searches for the constructor in window.PDFDocument. If the constructor is in another directory, specify the pdfDocument property.

pdfKitScriptUrl Property

Specifies the path to the pdfkit library’s scripts.

Declaration

pdfKitScriptUrl?: string

Property Value

Type	Description
string	The URL.