Represents the PDF viewer component.
<div id="pdfViewer"></div>
<script>
var pdfViewerObj = new PdfViewer();
pdfViewerObj.appendTo("#pdfViewer");
</script>Get or set the dropdown field settings.
Defines the ajax Request settings of the PdfViewer.
any[]
Get the Loaded document annotation Collections in the PdfViewer control.
AnnotationSelectorSettingsModel
Defines the settings of annotation selector.
Defines the settings of the annotations.
Defines the settings of area annotation.
Defines the settings of arrow annotation.
Get or set the check box field settings.
Defines the settings of circle annotation.
string
Specifies the state of the ContextMenu in the PDF document.
Defaults to RightClick
Defines the context menu settings.
number
Returns the current page number of the document displayed in the PdfViewer control.
Defaults to 0
Defines the stamp items of the PdfViewer.
Defines the settings of customStamp annotation.
string
Customize desired date and time format
boolean
Enable or disable the interaction of form fields in the Pdfviewer.
Defaults to false
enable or disable context menu Items
Defaults to []
Defines the settings of distance annotation.
string
Sets the PDF document path for initial loading.
string
Gets or sets the download file name in the PdfViewer control.
boolean
Enable or disable the annotation in the Pdfviewer.
Defaults to true
boolean
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.
Defaults to true
boolean
Enable or disables the auto complete option in form documents.
Defaults to true
boolean
Enables or disables the bookmark view in the PDF viewer
Defaults to true
boolean
Enables or disables the bookmark styles in the PDF viewer
Defaults to false
boolean
Enable or disables the Comment Panel of PdfViewer.
Defaults to true
boolean
Gets or sets a boolean value to show or hide desktop toolbar in mobile devices. FALSE by default.
Defaults to false
boolean
Enable or disables the download option of PdfViewer.
Defaults to true
boolean
Get or set a boolean value to enable or disable the form designer. TRUE by default.
Defaults to true
boolean
Opens the form designer toolbar when the PDF document is loaded in the PDF Viewer control initially.
Defaults to true
boolean
Enable or disable the form fields in the Pdfviewer.
Defaults to true
boolean
Enable or disable the form fields validation.
Defaults to false
boolean
Enable or disable the free text annotation in the Pdfviewer.
Defaults to true
boolean
Enables or disables the handwritten signature in PDF document.
Defaults to true
boolean
Enables or disables the hyperlinks in PDF document.
Defaults to true
boolean
Enable or disables the customization of measure values in PdfViewer.
Defaults to true
boolean
If it is set as false, then the ink annotation support in the PDF Viewer will be disabled. By default it is true.
Defaults to true
boolean
Enable or disables the Magnification module of PdfViewer.
Defaults to true
boolean
Enable or disables the calibrate annotation in the PdfViewer.
Defaults to true
boolean
Enable or disable the multi line text markup annotations in overlapping collections.
Defaults to false
boolean
Enables or disables the multi-page text markup annotation selection in UI.
Defaults to false
boolean
Enable or disables the Navigation module of PdfViewer.
Defaults to true
boolean
Enable or disables the Navigation toolbar of PdfViewer.
Defaults to true
boolean
Enable or disable persisting component’s state between page reloads.
Defaults to false
boolean
Enable or disables the Pinch zoom of PdfViewer.
Defaults to true
boolean
Enable or disables the print option of PdfViewer.
Defaults to true
boolean
If it is set as FALSE, will suppress the page rotation of Landscape document on print action. By default it is TRUE.
Defaults to true
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
boolean
Enable or disables the shape annotation in the PdfViewer.
Defaults to true
boolean
Enable or disables the Label for shapeAnnotations of PdfViewer.
Defaults to false
boolean
Enables and disables the stamp annotations when the PDF viewer control is loaded initially.
Defaults to true
boolean
Enables and disables the stickyNotes annotations when the PDF viewer control is loaded initially.
Defaults to true
boolean
Enable or disables the text markup annotation in the PdfViewer.
Defaults to true
boolean
Enable or disable the text markup resizer to modify the bounds in UI.
Defaults to false
boolean
Enable or disables the text search in the PdfViewer.
Defaults to true
boolean
Enable or disables the text selection in the PdfViewer.
Defaults to true
boolean
Enables or disables the thumbnail view in the PDF viewer
Defaults to true
boolean
Enable or disables the toolbar of PdfViewer.
Defaults to true
boolean
Enable or disable the zoom optimization mode in PDF Viewer.
Defaults to true
string
Gets or sets the export annotations JSON file name in the PdfViewer control.
string
Gets or sets the document name loaded in the PdfViewer control.
Gets the form fields present in the loaded PDF document. It used to get the form fields id, name, type and it’s values.
Defines the settings of free text annotation.
HandWrittenSignatureSettingsModel
Defines the settings of handWrittenSignature.
string | number
Defines the scrollable height of the PdfViewer control.
Defaults to ‘auto’
boolean
Gets or sets a boolean value to show or hide the save signature check box option in the signature dialog. FALSE by default
Defaults to false
Defines the settings of highlight annotation.
string
Specifies the open state of the hyperlink in the PDF document.
Defaults to CurrentTab
Get or set the signature dialog settings for initial field.
Get or set the initial field settings.
Defines the ink annotation settings for PDF Viewer.It used to customize the strokeColor, thickness, opacity of the ink annotation.
string
Sets the interaction mode of the PdfViewer
Defaults to TextSelection
boolean
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.
Defaults to false
boolean
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially and get the annotation Toolbar Visible status.
Defaults to false
boolean
Gets or sets a boolean value to show or hide the bookmark panel while loading a document. FALSE by default.
Defaults to false
boolean
If it set as true, then the command panel show at initial document loading in the PDF viewer
Defaults to false
boolean
Checks whether the PDF document is edited.
boolean
Enable or disables the get the document text collections.
Defaults to false
boolean
Enable if the PDF document contains form fields.
Defaults to false
boolean
Maintain the selection of text markup annotation.
Defaults to false
boolean
Enables or disable saving Hand Written signature as editable in the PDF.
Defaults to false
boolean
If it set as true, then the thumbnail view show at initial document loading in the PDF viewer
Defaults to false
boolean
Checks if the freeText value is valid or not. FALSE by default
Defaults to false
Defines the settings of line annotation.
Get or set the listbox field settings.
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Defaults to ”
Defines the settings of measurement annotation.
number
gets the page count of the document loaded in the PdfViewer control.
Defaults to 0
Get or set the password field settings.
Defines the settings of perimeter annotation.
Defines the settings of polygon annotation.
string
Specifies the print mode in the PDF Viewer.
Defaults to Default
Get or set the radio button field settings.
Defines the settings of radius annotation.
Defines the settings of rectangle annotation.
boolean
restrict zoom request.
Defaults to false
number
Specifies the retry count for the failed requests.
Defaults to 1
Defines the scroll settings.
Defines the collection of selected items, size and position of the selector
Defaults to {}
Defines the settings of the PdfViewer service.
string
Defines the service url of the PdfViewer control.
Defines the settings of shape label.
boolean
If it is set as false then error message box is not displayed in PDF viewer control.
Defaults to true
any[]
Get the Loaded document signature Collections in the PdfViewer control.
Get or set the signature dialog settings for signature field.
Get or set the signature field settings.
string
Specifies the signature mode in the PDF Viewer.
Defaults to Default
Defines the settings of stamp annotation.
Defines the settings of stickyNotes annotation.
Defines the settings of strikethrough annotation.
Get or set the text field settings.
Sets the settings for the color of the text search highlight.
Defines the tile rendering settings.
Defines the settings of the PdfViewer toolbar.
Defines the settings of underline annotation.
Defines the settings of volume annotation.
string | number
Defines the scrollable width of the PdfViewer control.
Defaults to ‘auto’
string
Specifies the rendering mode in the PDF Viewer.
Defaults to Default
number
Sets the initial loading zoom value from 10 to 400 in PdfViewer Control.
Defaults to 0
AnnotationGets the annotation object of the pdf viewer.
BookmarkViewGets the bookmark view object of the pdf viewer.
FormDesignerGets the FormDesigner object of the pdf viewer.
MagnificationGets the magnification object of the pdf viewer.
NavigationGets the navigation object of the pdf viewer.
PrintGets the print object of the pdf viewer.
TextSearchGets the text search object of the pdf viewer.
TextSelectionGets the TextSelection object of the pdf viewer.
ThumbnailViewGets the thumbnail-view object of the pdf viewer.
ToolbarGets the toolbar object of the pdf viewer.
numberReturns the current zoom percentage of the PdfViewer control.
Perform to add annotations in the PDF Viewer
Returns void
Adds the handler to the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event |
| handler | Function |
Specifies the call to run when the event occurs. |
Returns void
Appends the control within the given HTML element
| Parameter | Type | Description |
|---|---|---|
| selector (optional) | string | HTMLElement |
Target element where control needs to be appended |
Returns void
Clears data from the form fields. Parameter - Specifies the form field object.
Returns void
Convert user coordinates to the PDF page coordinates.
| Parameter | Type | Description |
|---|---|---|
| clientPoint | Point |
The user should provide a x, y coordinates. |
| pageNumber | number |
We need to pass pageNumber. |
Returns Point
Convert page coordinates to the user coordinates.
| Parameter | Type | Description |
|---|---|---|
| pagePoint | Point |
The user should provide a page x, y coordinates. |
| pageNumber | number |
We need to pass pageNumber. |
Returns Point
Convert page coordinates to the scrolling coordinates.
| Parameter | Type | Description |
|---|---|---|
| pagePoint | Point |
The user should provide a page x, y coordinates. |
| pageNumber | number |
We need to pass pageNumber. |
Returns Point
When invoked, applies the pending property changes immediately to the component.
Returns void
To delete the annotation Collections in the PDF Document.
Returns void
Destroys all managed resources used by this object.
Returns void
Downloads the PDF document being loaded in the ejPdfViewer control.
Returns void
Perform export annotations action in the PDF Viewer
Returns void
Export annotations and returns a base64 string for both Json and XFDF formats
Returns Promise
Perform export annotations action in the PDF Viewer
Returns Promise
Perform export action in the PDF Viewer
Returns void
Perform export annotations action in the PDF Viewer
Returns Promise
Focus a form field in a document by its field name or the field object.
Returns void
Returns the persistence data for component
Returns any
Get page number from the user coordinates x and y.
| Parameter | Type | Description |
|---|---|---|
| clientPoint | Point |
The user will provide a x, y coordinates. |
Returns number
Returns the route element of the component
Returns HTMLElement
Perform imports annotations action in the PDF Viewer
Returns void
Perform action in the PDF Viewer
Returns void
Loads the given PDF document in the PDF viewer control
| Parameter | Type | Description |
|---|---|---|
| document | string |
Specifies the document name for load |
| password | string |
Specifies the Given document password |
Returns void
Perform redo action for the edited annotations
Returns void
Removes the handler from the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event to remove |
| handler | Function |
Specifies the function to remove |
Returns void
reset all form fields data
Returns void
To retrieve the form fields in the PDF Document.
Returns FormFieldModel[]
Saves the PDF document being loaded in the PDF Viewer control as blob.
Returns Promise
To modify the Json Data in ajax request.
Returns void
Specifies the message to be displayed in the popup.
Returns void
Perform undo action for the edited annotations
Returns void
Unloads the PDF document being displayed in the PDF viewer.
Returns void
To update the form fields in the PDF Document.
Returns void
Update the form field values from externally.
Returns void
updates the PDF Viewer container width and height from externally.
Returns void
Brings the given rectangular region to view and zooms in the document to fit the region in client area (view port).
| Parameter | Type | Description |
|---|---|---|
| rectangle | Rect |
Specifies the region in client coordinates that is to be brought to view. |
Returns void
Dynamically injects the required modules to the component.
| Parameter | Type | Description |
|---|---|---|
| moduleList | Function[] |
? |
Returns void
EmitType<AddSignatureEventArgs>
Triggers when signature is added over the page of the PDF document.
EmitType<AjaxRequestFailureEventArgs>
Triggers when the AJAX request is failed.
EmitType<AjaxRequestInitiateEventArgs>
Triggers before the data send in to the server.
EmitType<AjaxRequestSuccessEventArgs>
Event triggers on successful AJAX request
EmitType<AnnotationAddEventArgs>
Triggers when an annotation is added over the page of the PDF document.
EmitType<AnnotationDoubleClickEventArgs>
Triggers an event when the annotation is double click.
EmitType<AnnotationMouseLeaveEventArgs>
Triggers when mouse over the annotation object.
EmitType<AnnotationMouseoverEventArgs>
Triggers when mouse over the annotation object.
EmitType<AnnotationMoveEventArgs>
Triggers when an annotation is moved over the page of the PDF document.
EmitType<AnnotationMovingEventArgs>
Triggers while moving an annotation.
EmitType<AnnotationPropertiesChangeEventArgs>
Triggers when the property of the annotation is changed in the page of the PDF document.
EmitType<AnnotationRemoveEventArgs>
Triggers when an annotation is removed from the page of the PDF document.
EmitType<AnnotationResizeEventArgs>
Triggers when an annotation is resized over the page of the PDF document.
EmitType<AnnotationSelectEventArgs>
Triggers when an annotation is selected over the page of the PDF document.
EmitType<AnnotationUnSelectEventArgs>
Triggers when an annotation is unselected over the page of the PDF document.
EmitType<BeforeAddFreeTextEventArgs>
Triggers the event before adding a text in the freeText annotation.
EmitType<BookmarkClickEventArgs>
Triggers an event when the bookmark is clicked in the bookmark panel of PDF Viewer.
EmitType<ButtonFieldClickEventArgs>
Triggers an event when the button is clicked.
Triggers when the comment is added for the annotation in the comment panel.
Triggers when the comment is deleted for the annotation in the comment panel.
Triggers when the comment is edited for the annotation in the comment panel.
Triggers when the comment is selected for the annotation in the comment panel.
Triggers when the comment for status is changed for the annotation in the comment panel.
EmitType<void>
Triggers while created the PdfViewer component.
Triggers while loading document into PdfViewer.
Triggers while loading document got failed in PdfViewer.
Triggers while close the document
EmitType<DownloadEndEventArgs>
Triggers an event when the download actions is finished.
EmitType<DownloadStartEventArgs>
Triggers an event when the download action is started.
EmitType<ExportFailureEventArgs>
Triggers when an export annotations failed in the PDF Viewer.
EmitType<ExportStartEventArgs>
Triggers when an exported annotations started in the PDF Viewer.
EmitType<ExportSuccessEventArgs>
Triggers when an export annotations succeed in the PDF Viewer.
EmitType<ExtractTextCompletedEventArgs>
Triggers when an text extraction is completed in the PDF Viewer.
The event is triggered when a form field is added.
Triggers an event when the form field is clicked.
EmitType<FormFieldDoubleClickArgs>
Triggers an event when the form field is double-clicked.
EmitType<FormFieldFocusOutEventArgs>
Triggers when focus out from the form fields.
EmitType<FormFieldMouseLeaveArgs>
The event is triggered when a mouse cursor leaves form field.
EmitType<FormFieldMouseoverArgs>
The event is triggered when a mouse cursor is over a form field.
The event is triggered when a form field is moved.
EmitType<FormFieldPropertiesChangeArgs>
The event is triggered when a property of form field is changed.
The event is triggered when a form field is removed.
The event is triggered when a form field is resized.
The event is triggered when a form field is selected.
EmitType<FormFieldUnselectArgs>
The event is triggered when a form field is unselected.
EmitType<HyperlinkClickEventArgs>
Triggers when hyperlink in the PDF Document is clicked
EmitType<HyperlinkMouseOverArgs>
Triggers when hyperlink in the PDF Document is hovered
EmitType<ImportFailureEventArgs>
Triggers when an imports annotations failed in the PDF document.
EmitType<ImportStartEventArgs>
Triggers when an imported annotations started in the PDF document.
EmitType<ImportSuccessEventArgs>
Triggers when an imports annotations succeed in the PDF document.
EmitType<MoveSignatureEventArgs>
Triggers when an signature is moved over the page of the PDF document.
Triggers when there is change in current page number.
Triggers when the mouse click is performed over the page of the PDF document.
EmitType<PageMouseoverEventArgs>
Triggers when mouse over the page.
Triggers an event when the print actions is finished.
Triggers an event when the print action is started.
EmitType<RemoveSignatureEventArgs>
Triggers when signature is removed over the page of the PDF document.
EmitType<ResizeSignatureEventArgs>
Triggers when signature is resized over the page of the PDF document.
EmitType<SignaturePropertiesChangeEventArgs>
Triggers when the property of the signature is changed in the page of the PDF document.
EmitType<SignatureSelectEventArgs>
Triggers when signature is selected over the page of the PDF document.
EmitType<TextSearchCompleteEventArgs>
Triggers an event when the text search is completed.
EmitType<TextSearchHighlightEventArgs>
Triggers an event when the text search text is highlighted.
EmitType<TextSearchStartEventArgs>
Triggers an event when the text search is started.
EmitType<TextSelectionEndEventArgs>
Triggers an event when the text selection is finished.
EmitType<TextSelectionStartEventArgs>
Triggers an event when the text selection is started.
EmitType<ThumbnailClickEventArgs>
Triggers an event when the thumbnail is clicked in the thumbnail panel of PDF Viewer.
EmitType<ValidateFormFieldsArgs>
Triggers when validation is failed.
Triggers when there is change in the magnification value.