SurveyPDF
The SurveyPDF
object enables you to export your surveys and forms to PDF documents.
Properties
Removes watermarks from the exported document.
You can enable this property only if you have a SurveyJS PDF Generator commercial license. It is illegal to enable this property without a license.
- Type:
- boolean writable
- Implemented in:
- SurveyPDF
Parameters:
sender
:SurveyPDF
- Type:
- EventBase<SurveyPDF, { controller: DocController; }>
- Implemented in:
- SurveyPDF
An event that is raised when SurveyJS PDF Generator renders a page header. Handle this event to customize the header.
Parameters:
sender
:SurveyPDF
A SurveyPDF instance that raised the event.canvas
:DrawCanvas
An object that you can use to draw text and images in the page header.
- Type:
- EventAsync<SurveyPDF, DrawCanvas>
- Implemented in:
- SurveyPDF
An event that is raised when SurveyJS PDF Generator renders a page. Handle this event to customize page rendering.
Parameters:
sender
:SurveyPDF
A SurveyPDF instance that raised the event.options.page
:PageModel
A page that is being rendered.options.point
:IPoint
An object with coordinates of the top-left corner of the element being rendered. This object contains the following properties:{ xLeft: number, yTop: number }
.options.bricks
:PdfBrick[]
An array of bricks used to render the element.options.controller
:DocController
An object that provides access to main PDF document properties (font, margins, page width and height) and allows you to modify them.options.repository
:FlatRepository
A repository with classes that render elements to PDF. Use itscreate
method if you need to create a new instance of a rendering class.
- Type:
- EventAsync<SurveyPDF, AdornersPageOptions>
- Implemented in:
- SurveyPDF
An event that is raised when SurveyJS PDF Generator renders a panel. Handle this event to customize panel rendering.
Parameters:
sender
:SurveyPDF
A SurveyPDF instance that raised the event.options.panel
:PanelModel
A panel that is being rendered.options.point
:IPoint
An object with coordinates of the top-left corner of the element being rendered. This object contains the following properties:{ xLeft: number, yTop: number }
.options.bricks
:PdfBrick[]
An array of bricks used to render the element.options.controller
:DocController
An object that provides access to main PDF document properties (font, margins, page width and height) and allows you to modify them.options.repository
:FlatRepository
A repository with classes that render elements to PDF. Use itscreate
method if you need to create a new instance of a rendering class.
- Type:
- EventAsync<SurveyPDF, AdornersPanelOptions>
- Implemented in:
- SurveyPDF
An event that is raised when SurveyJS PDF Generator renders a survey question. Handle this event to customize question rendering.
Parameters:
sender
:SurveyPDF
A SurveyPDF instance that raised the event.options.question
:Question
A survey question that is being rendered.options.point
:IPoint
An object with coordinates of the top-left corner of the element being rendered. This object contains the following properties:{ xLeft: number, yTop: number }
.options.bricks
:PdfBrick[]
An array of bricks used to render the element.options.controller
:DocController
An object that provides access to main PDF document properties (font, margins, page width and height) and allows you to modify them.options.repository
:FlatRepository
A repository with classes that render elements to PDF. Use itscreate
method if you need to create a new instance of a rendering class.
- Type:
- EventAsync<SurveyPDF, AdornersOptions>
- Implemented in:
- SurveyPDF
An asynchronous method that allows you to get PDF content in different formats.
- Type:
- (type?: string) => any
- Parameters:
-
type, type: string ,
(Optional) One of
"blob"
,"bloburl"
,"dataurlstring"
. Do not specify this parameter if you want to get raw PDF content as a string value.
- Implemented in:
- SurveyPDF
Copyright © 2023 Devsoft Baltic OÜ. All rights reserved.