Search results

PdfViewerModel API in JavaScript (ES5) PDF Viewer API control

Interface for a class PdfViewer

Properties

addSignature

EmitType<AddSignatureEventArgs>

Triggers when signature is added over the page of the PDF document.

ajaxRequestFailed

EmitType<AjaxRequestFailureEventArgs>

Triggers when the AJAX request is failed.

ajaxRequestInitiate

EmitType<AjaxRequestInitiateEventArgs>

Triggers before the data send in to the server.

ajaxRequestSuccess

EmitType<AjaxRequestSuccessEventArgs>

Event triggers on successful AJAX request

annotationAdd

EmitType<AnnotationAddEventArgs>

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

annotationDoubleClick

EmitType<AnnotationDoubleClickEventArgs>

Triggers an event when the annotation is double click.

annotationMouseLeave

EmitType<AnnotationMouseLeaveEventArgs>

Triggers when mouse over the annotation object.

annotationMouseover

EmitType<AnnotationMouseoverEventArgs>

Triggers when mouse over the annotation object.

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.

annotationUnSelect

EmitType<AnnotationUnSelectEventArgs>

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

beforeAddFreeText

EmitType<BeforeAddFreeTextEventArgs>

Triggers the event before adding a text in the freeText annotation.

bookmarkClick

EmitType<BookmarkClickEventArgs>

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

buttonFieldClick

EmitType<ButtonFieldClickEventArgs>

Triggers an event when the button is clicked.

commentAdd

EmitType<CommentEventArgs>

Triggers when the comment is added for the annotation in the comment panel.

commentDelete

EmitType<CommentEventArgs>

Triggers when the comment is deleted for the annotation in the comment panel.

commentEdit

EmitType<CommentEventArgs>

Triggers when the comment is edited for the annotation in the comment panel.

commentSelect

EmitType<CommentEventArgs>

Triggers when the comment is selected for the annotation in the comment panel.

commentStatusChanged

EmitType<CommentEventArgs>

Triggers when the comment for status is changed for the annotation in the comment panel.

created

EmitType<void>

Triggers while created the PdfViewer component.

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.

extractTextCompleted

EmitType<ExtractTextCompletedEventArgs>

Triggers when an text extraction is completed in the PDF Viewer.

formFieldAdd

EmitType<FormFieldAddArgs>

The event is triggered when a form field is added.

formFieldClick

EmitType<FormFieldClickArgs>

Triggers an event when the form field is clicked.

formFieldFocusOut

EmitType<FormFieldFocusOutEventArgs>

Triggers when focus out from the form fields.

formFieldMouseLeave

EmitType<FormFieldMouseLeaveArgs>

The event is triggered when a mouse cursor leaves form field.

formFieldMouseover

EmitType<FormFieldMouseoverArgs>

The event is triggered when a mouse cursor is over a form field.

formFieldMove

EmitType<FormFieldMoveArgs>

The event is triggered when a form field is moved.

formFieldPropertiesChange

EmitType<FormFieldPropertiesChangeArgs>

The event is triggered when a property of form field is changed.

formFieldRemove

EmitType<FormFieldRemoveArgs>

The event is triggered when a form field is removed.

formFieldResize

EmitType<FormFieldResizeArgs>

The event is triggered when a form field is resized.

formFieldSelect

EmitType<FormFieldSelectArgs>

The event is triggered when a form field is selected.

formFieldUnselect

EmitType<FormFieldUnselectArgs>

The event is triggered when a form field is unselected.

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.

moveSignature

EmitType<MoveSignatureEventArgs>

Triggers when an signature is moved over the page of 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.

pageMouseover

EmitType<PageMouseoverEventArgs>

Triggers when mouse over the page.

printEnd

EmitType<PrintEndEventArgs>

Triggers an event when the print actions is finished.

printStart

EmitType<PrintStartEventArgs>

Triggers an event when the print action is started.

removeSignature

EmitType<RemoveSignatureEventArgs>

Triggers when signature is removed over the page of the PDF document.

resizeSignature

EmitType<ResizeSignatureEventArgs>

Triggers when signature is resized over the page of the PDF document.

signaturePropertiesChange

EmitType<SignaturePropertiesChangeEventArgs>

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

signatureSelect

EmitType<SignatureSelectEventArgs>

Triggers when signature is selected over the page of the PDF document.

textSearchComplete

EmitType<TextSearchCompleteEventArgs>

Triggers an event when the text search is completed.

textSearchHighlight

EmitType<TextSearchHighlightEventArgs>

Triggers an event when the text search text is highlighted.

textSearchStart

EmitType<TextSearchStartEventArgs>

Triggers an event when the text search is started.

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.

validateFormFields

EmitType<ValidateFormFieldsArgs>

Triggers when validation is failed.

zoomChange

EmitType<ZoomChangeEventArgs>

Triggers when there is change in the magnification value.

Get or set the dropdown field settings.

ajaxRequestSettings

AjaxRequestSettingsModel

Defines the ajax Request settings of the PdfViewer.

annotationSelectorSettings

AnnotationSelectorSettingsModel

Defines the settings of annotation selector.

annotationSettings

AnnotationSettingsModel

Defines the settings of the annotations.

areaSettings

AreaSettingsModel

Defines the settings of area annotation.

arrowSettings

ArrowSettingsModel

Defines the settings of arrow annotation.

checkBoxFieldSettings

CheckBoxFieldSettingsModel

Get or set the check box field settings.

circleSettings

CircleSettingsModel

Defines the settings of circle annotation.

contextMenuOption

string

Specifies the state of the ContextMenu in the PDF document.

contextMenuSettings

ContextMenuSettingsModel

Defines the context menu settings.

currentPageNumber

number

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

customStamp

CustomStampModel[]

Defines the stamp items of the PdfViewer.

customStampSettings

CustomStampSettingsModel

Defines the settings of customStamp annotation.

dateTimeFormat

string

Customize desired date and time format

designerMode

boolean

Enable or disable the interaction of form fields in the Pdfviewer.

disableContextMenuItems

ContextMenuItem[]

enable or disable context menu Items

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.

enableAnnotationToolbar

boolean

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

enableAutoComplete

boolean

Enable or disables the auto complete option in form documents.

enableBookmark

boolean

Enables or disables the bookmark view in the PDF viewer

enableBookmarkStyles

boolean

Enables or disables the bookmark styles in the PDF viewer

enableCommentPanel

boolean

Enable or disables the Comment Panel of PdfViewer.

enableDesktopMode

boolean

Gets or sets a boolean value to show or hide desktop toolbar in mobile devices. FALSE by default.

enableDownload

boolean

Enable or disables the download option of PdfViewer.

enableFormDesigner

boolean

Get or set a boolean value to enable or disable the form designer. TRUE by default.

enableFormDesignerToolbar

boolean

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

enableFormFields

boolean

Enable or disable the form fields in the Pdfviewer.

enableFormFieldsValidation

boolean

Enable or disable the form fields validation.

enableFreeText

boolean

Enable or disable the free text annotation in the Pdfviewer.

enableHandwrittenSignature

boolean

Enables or disables the handwritten signature in PDF document.

Enables or disables the hyperlinks in PDF document.

enableImportAnnotationMeasurement

boolean

Enable or disables the customization of measure values in PdfViewer.

enableInkAnnotation

boolean

If it is set as false, then the ink annotation support in the PDF Viewer will be disabled. By default it is true.

enableMagnification

boolean

Enable or disables the Magnification module of PdfViewer.

enableMeasureAnnotation

boolean

Enable or disables the calibrate annotation in the PdfViewer.

enableMultiLineOverlap

boolean

Enable or disable the multi line text markup annotations in overlapping collections.

enableMultiPageAnnotation

boolean

Enables or disables the multi-page text markup annotation selection in UI.

enableNavigation

boolean

Enable or disables the Navigation module of PdfViewer.

enableNavigationToolbar

boolean

Enable or disables the Navigation toolbar of PdfViewer.

enablePersistence

boolean

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

enablePinchZoom

boolean

Enable or disables the Pinch zoom of PdfViewer.

enablePrint

boolean

Enable or disables the print option of PdfViewer.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

enableShapeAnnotation

boolean

Enable or disables the shape annotation in the PdfViewer.

enableShapeLabel

boolean

Enable or disables the Label for shapeAnnotations of PdfViewer.

enableStampAnnotations

boolean

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

enableStickyNotesAnnotation

boolean

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

enableTextMarkupAnnotation

boolean

Enable or disables the text markup annotation in the PdfViewer.

enableTextMarkupResizer

boolean

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

enableTextSearch

boolean

Enable or disables the text search in the PdfViewer.

enableTextSelection

boolean

Enable or disables the text selection in the PdfViewer.

enableThumbnail

boolean

Enables or disables the thumbnail view in the PDF viewer

enableToolbar

boolean

Enable or disables the toolbar of PdfViewer.

enableZoomOptimization

boolean

Enable or disable the zoom optimization mode in PDF Viewer.

exportAnnotationFileName

string

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

formFieldCollections

FormFieldModel[]

Gets the form fields present in the loaded PDF document. It used to get the form fields id, name, type and it’s values.

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.

hideSaveSignature

boolean

Gets or sets a boolean value to show or hide the save signature check box option in the signature dialog. FALSE by default

highlightSettings

HighlightSettingsModel

Defines the settings of highlight annotation.

hyperlinkOpenState

string

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

initialFieldSettings

InitialFieldSettingsModel

Get or set the initial field settings.

inkAnnotationSettings

InkAnnotationSettingsModel

Defines the ink annotation settings for PDF Viewer.It used to customize the strokeColor, thickness, opacity of the ink annotation.

interactionMode

string

Sets the interaction mode of the PdfViewer

isAnnotationToolbarOpen

boolean

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

isAnnotationToolbarVisible

boolean

Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially and get the annotation Toolbar Visible status.

isBookmarkPanelOpen

boolean

Gets or sets a boolean value to show or hide the bookmark panel while loading a document. FALSE by default.

isCommandPanelOpen

boolean

If it set as true, then the command panel show at initial document loading in the PDF viewer

isDocumentEdited

boolean

Checks whether the PDF document is edited.

isExtractText

boolean

Enable or disables the get the document text collections.

isFormFieldDocument

boolean

Enable if the PDF document contains form fields.

isMaintainSelection

boolean

Maintain the selection of text markup annotation.

isSignatureEditable

boolean

Enables or disable saving Hand Written signature as editable in the PDF.

isThumbnailViewOpen

boolean

If it set as true, then the thumbnail view show at initial document loading in the PDF viewer

isValidFreeText

boolean

Checks if the freeText value is valid or not. FALSE by default

lineSettings

LineSettingsModel

Defines the settings of line annotation.

listBoxFieldSettings

ListBoxFieldSettingsModel

Get or set the listbox field settings.

locale

string

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

measurementSettings

MeasurementSettingsModel

Defines the settings of measurement annotation.

pageCount

number

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

passwordFieldSettings

PasswordFieldSettingsModel

Get or set the password field settings.

perimeterSettings

PerimeterSettingsModel

Defines the settings of perimeter annotation.

polygonSettings

PolygonSettingsModel

Defines the settings of polygon annotation.

printMode

string

Specifies the print mode in the PDF Viewer.

radioButtonFieldSettings

RadioButtonFieldSettingsModel

Get or set the radio button field settings.

radiusSettings

RadiusSettingsModel

Defines the settings of radius annotation.

rectangleSettings

RectangleSettingsModel

Defines the settings of rectangle annotation.

restrictZoomRequest

boolean

restrict zoom request.

retryCount

number

Specifies the retry count for the failed requests.

scrollSettings

ScrollSettingsModel

Defines the scroll settings.

selectedItems

SelectorModel

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

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.

showNotificationDialog

boolean

If it is set as false then error message box is not displayed in PDF viewer control.

signatureFieldSettings

SignatureFieldSettingsModel

Get or set the signature field settings.

signatureFitMode

string

Specifies the signature mode in the PDF Viewer.

stampSettings

StampSettingsModel

Defines the settings of stamp annotation.

stickyNotesSettings

StickyNotesSettingsModel

Defines the settings of stickyNotes annotation.

strikethroughSettings

StrikethroughSettingsModel

Defines the settings of strikethrough annotation.

textFieldSettings

TextFieldSettingsModel

Get or set the text field settings.

textSearchColorSettings

TextSearchColorSettingsModel

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

tileRenderingSettings

TileRenderingSettingsModel

Defines the tile rendering settings.

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.

zoomMode

string

Specifies the rendering mode in the PDF Viewer.

zoomValue

number

Sets the initial loading zoom value from 10 to 400 in PdfViewer Control.

Contents
Contents