PdfViewer

Represents the PDF viewer component.

<div id="pdfViewer"></div>
<script>
 var pdfViewerObj = new PdfViewer();
 pdfViewerObj.appendTo("#pdfViewer");
</script>

Properties

ajaxRequestSettings

AjaxRequestSettingsModel

Defines the ajax Request settings of the PdfViewer.

annotationCollection

any

Get the Loaded document annotation Collections in the PdfViewer control.

annotationSelectorSettings

AnnotationSelectorSettingsModel

Defines the settings of annotation selector.

annotationSettings

AnnotationSettingsModel

Defines the settings of the annotations.

annotationToolbarSettings

AnnotationToolbarSettingsModel

Defines the settings of the PdfViewer annotation toolbar.

areaSettings

AreaSettingsModel

Defines the settings of area annotation.

arrowSettings

ArrowSettingsModel

Defines the settings of arrow annotation.

circleSettings

CircleSettingsModel

Defines the settings of circle annotation.

contextMenuOption

string

Specifies the state of the ContextMenu in the PDF document.

Defaults to RightClick

customStampItems

CustomStampItemModel[]

Defines the stamp items of the PdfViewer.

customStampSettings

CustomStampSettingsModel

Defines the settings of customStamp annotation.

distanceSettings

DistanceSettingsModel

Defines the settings of distance annotation.

documentPath

string

Sets the PDF document path for initial loading.

downloadFileName

string

Gets or sets the download file name in the PdfViewer control.

enableAnnotation

boolean

Enable or disable the annotation in the Pdfviewer.

Defaults to true

enableAnnotationToolbar

boolean

Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.

Defaults to false

enableBookmark

boolean

Enables or disables the bookmark view in the PDF viewer

Defaults to true

enableCommentPanel

boolean

Enable or disables the Comment Panel of PdfViewer.

Defaults to true

enableDownload

boolean

Enable or disables the download option of PdfViewer.

Defaults to true

enableFormFields

boolean

Enable or disable the form fields in the Pdfviewer.

Defaults to true

enableFreeText

boolean

Enable or disable the free text annotation in the Pdfviewer.

Defaults to true

enableHandwrittenSignature

boolean

Enables or disables the handwritten signature in PDF document.

Defaults to true

enableHyperlink

boolean

Enables or disables the hyperlinks in PDF document.

Defaults to true

enableMagnification

boolean

Enable or disables the Magnification module of PdfViewer.

Defaults to true

enableMeasureAnnotation

boolean

Enable or disables the calibrate annotation in the PdfViewer.

Defaults to true

enableNavigation

boolean

Enable or disables the Navigation module of PdfViewer.

Defaults to true

enableNavigationToolbar

boolean

Enable or disables the Navigation toolbar of PdfViewer.

Defaults to true

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enablePinchZoom

boolean

Enable or disables the Pinch zoom of PdfViewer.

Defaults to true

enablePrint

boolean

Enable or disables the print option of PdfViewer.

Defaults to true

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableShapeAnnotation

boolean

Enable or disables the shape annotation in the PdfViewer.

Defaults to true

enableShapeLabel

boolean

Enable or disables the Label for shapeAnnotations of PdfViewer.

Defaults to false

enableStampAnnotations

boolean

Enables and disables the stamp annotations when the PDF viewer control is loaded initially.

Defaults to true

enableStickyNotesAnnotation

boolean

Enables and disables the stickyNotes annotations when the PDF viewer control is loaded initially.

Defaults to true

enableTextMarkupAnnotation

boolean

Enable or disables the text markup annotation in the PdfViewer.

Defaults to true

enableTextMarkupResizer

boolean

Enable or disable the text markup resizer to modify the bounds in UI.

Defaults to false

enableTextSearch

boolean

Enable or disables the text search in the PdfViewer.

Defaults to true

enableTextSelection

boolean

Enable or disables the text selection in the PdfViewer.

Defaults to true

enableThumbnail

boolean

Enables or disables the thumbnail view in the PDF viewer

Defaults to true

enableToolbar

boolean

Enable or disables the toolbar of PdfViewer.

Defaults to true

exportAnnotationFileName

string

Gets or sets the export annotations JSON file name in the PdfViewer control.

fileName

string

Gets or sets the document name loaded in the PdfViewer control.

freeTextSettings

FreeTextSettingsModel

Defines the settings of free text annotation.

handWrittenSignatureSettings

HandWrittenSignatureSettingsModel

Defines the settings of handWrittenSignature.

height

string | number

Defines the scrollable height of the PdfViewer control.

Defaults to ‘auto’

highlightSettings

HighlightSettingsModel

Defines the settings of highlight annotation.

hyperlinkOpenState

string

Specifies the open state of the hyperlink in the PDF document.

Defaults to CurrentTab

interactionMode

string

Sets the interaction mode of the PdfViewer

Defaults to TextSelection

lineSettings

LineSettingsModel

Defines the settings of line annotation.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ”

measurementSettings

MeasurementSettingsModel

Defines the settings of measurement annotation.

perimeterSettings

PerimeterSettingsModel

Defines the settings of perimeter annotation.

polygonSettings

PolygonSettingsModel

Defines the settings of polygon annotation.

radiusSettings

RadiusSettingsModel

Defines the settings of radius annotation.

rectangleSettings

RectangleSettingsModel

Defines the settings of rectangle annotation.

selectedItems

SelectorModel

Defines the collection of selected items, size and position of the selector

Defaults to {}

serverActionSettings

ServerActionSettingsModel

Defines the settings of the PdfViewer service.

serviceUrl

string

Defines the service url of the PdfViewer control.

shapeLabelSettings

ShapeLabelSettingsModel

Defines the settings of shape label.

stampSettings

StampSettingsModel

Defines the settings of stamp annotation.

stickyNotesSettings

StickyNotesSettingsModel

Defines the settings of stickyNotes annotation.

strikethroughSettings

StrikethroughSettingsModel

Defines the settings of strikethrough annotation.

textSearchColorSettings

TextSearchColorSettingsModel

Sets the settings for the color of the text search highlight.

toolbarSettings

ToolbarSettingsModel

Defines the settings of the PdfViewer toolbar.

underlineSettings

UnderlineSettingsModel

Defines the settings of underline annotation.

volumeSettings

VolumeSettingsModel

Defines the settings of volume annotation.

width

string | number

Defines the scrollable width of the PdfViewer control.

Defaults to ‘auto’

zoomMode

string

Specifies the rendering mode in the PDF Viewer.

Defaults to Default

annotation Annotation

Gets the annotation object of the pdf viewer.

bookmark BookmarkView

Gets the bookmark view object of the pdf viewer.

currentPageNumber number

Returns the current page number of the document displayed in the PdfViewer control.

isDocumentEdited boolean

Checks whether the PDF document is edited.

magnification Magnification

Gets the magnification object of the pdf viewer.

navigation Navigation

Gets the navigation object of the pdf viewer.

pageCount number

Returns the page count of the document loaded in the PdfViewer control.

print Print

Gets the print object of the pdf viewer.

textSearch TextSearch

Gets the text search object of the pdf viewer.

thumbnailView ThumbnailView

Gets the thumbnail-view object of the pdf viewer.

toolbar Toolbar

Gets the toolbar object of the pdf viewer.

zoomPercentage number

Returns the current zoom percentage of the PdfViewer control.

Methods

addEventListener

Adds the handler to the given event listener.

Returns void

appendTo

Appends the control within the given HTML element

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

deleteAnnotations

To delete the annotation Collections in the PDF Document.

Returns void

destroy

Destroys all managed resources used by this object.

Returns void

download

Downloads the PDF document being loaded in the ejPdfViewer control.

Returns void

exportAnnotations

Perform export annotations action in the PDF Viewer

Returns void

exportAnnotationsAsObject

Perform export annotations action in the PDF Viewer

Returns Promise

exportFormFields

Perform export action in the PDF Viewer

Returns void

exportFormFieldsAsObject

Perform export annotations action in the PDF Viewer

Returns Promise

importAnnotations

Perform imports annotations action in the PDF Viewer

Returns void

importFormFields

Perform action in the PDF Viewer

Returns void

load

Loads the given PDF document in the PDF viewer control

Returns void

redo

Perform redo action for the edited annotations

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

saveAsBlob

Saves the PDF document being loaded in the PDF Viewer control as blob.

Returns Promise

setJsonData

To modify the Json Data in ajax request.

Returns void

undo

Perform undo action for the edited annotations

Returns void

unload

Unloads the PDF document being displayed in the PDF viewer.

Returns void

updateViewerContainer

updates the PDF Viewer container width and height from externally.

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void

Events

ajaxRequestFailed

EmitType<AjaxRequestFailureEventArgs>

Triggers when the AJAX request is failed.

ajaxRequestInitiate

EmitType<AjaxRequestInitiateEventArgs>

Triggers before the data send in to the server.

annotationAdd

EmitType<AnnotationAddEventArgs>

Triggers when an annotation is added over the page of the PDF document.

annotationMove

EmitType<AnnotationMoveEventArgs>

Triggers when an annotation is moved over the page of the PDF document.

annotationPropertiesChange

EmitType<AnnotationPropertiesChangeEventArgs>

Triggers when the property of the annotation is changed in the page of the PDF document.

annotationRemove

EmitType<AnnotationRemoveEventArgs>

Triggers when an annotation is removed from the page of the PDF document.

annotationResize

EmitType<AnnotationResizeEventArgs>

Triggers when an annotation is resized over the page of the PDF document.

annotationSelect

EmitType<AnnotationSelectEventArgs>

Triggers when an annotation is selected over the page of the PDF document.

documentLoad

EmitType<LoadEventArgs>

Triggers while loading document into PdfViewer.

documentLoadFailed

EmitType<LoadFailedEventArgs>

Triggers while loading document got failed in PdfViewer.

documentUnload

EmitType<UnloadEventArgs>

Triggers while close the document

downloadEnd

EmitType<DownloadEndEventArgs>

Triggers an event when the download actions is finished.

downloadStart

EmitType<DownloadStartEventArgs>

Triggers an event when the download action is started.

exportFailed

EmitType<ExportFailureEventArgs>

Triggers when an export annotations failed in the PDF Viewer.

exportStart

EmitType<ExportStartEventArgs>

Triggers when an exported annotations started in the PDF Viewer.

exportSuccess

EmitType<ExportSuccessEventArgs>

Triggers when an export annotations succeed in the PDF Viewer.

hyperlinkClick

EmitType<HyperlinkClickEventArgs>

Triggers when hyperlink in the PDF Document is clicked

hyperlinkMouseOver

EmitType<HyperlinkMouseOverArgs>

Triggers when hyperlink in the PDF Document is hovered

importFailed

EmitType<ImportFailureEventArgs>

Triggers when an imports annotations failed in the PDF document.

importStart

EmitType<ImportStartEventArgs>

Triggers when an imported annotations started in the PDF document.

importSuccess

EmitType<ImportSuccessEventArgs>

Triggers when an imports annotations succeed in the PDF document.

pageChange

EmitType<PageChangeEventArgs>

Triggers when there is change in current page number.

pageClick

EmitType<PageClickEventArgs>

Triggers when the mouse click is performed over the page of the PDF document.

textSelectionEnd

EmitType<TextSelectionEndEventArgs>

Triggers an event when the text selection is finished.

textSelectionStart

EmitType<TextSelectionStartEventArgs>

Triggers an event when the text selection is started.

thumbnailClick

EmitType<ThumbnailClickEventArgs>

Triggers an event when the thumbnail is clicked in the thumbnail panel of PDF Viewer.

zoomChange

EmitType<ZoomChangeEventArgs>

Triggers when there is change in the magnification value.