Class PdfViewer
Inheritance
System.Object
PdfViewer
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syncfusion.EJ2.dll
Syntax
public class PdfViewer : EJTagHelper
Constructors
PdfViewer()
Declaration
Properties
AddSignature
Triggers when signature is added over the page of the PDF document.
Declaration
[HtmlAttributeName("addSignature")]
public string AddSignature { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AjaxRequestFailed
Triggers when the AJAX request is failed.
Declaration
[HtmlAttributeName("ajaxRequestFailed")]
public string AjaxRequestFailed { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AjaxRequestInitiate
Triggers before the data send in to the server.
Declaration
[HtmlAttributeName("ajaxRequestInitiate")]
public string AjaxRequestInitiate { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AjaxRequestSettings
Defines the ajax Request settings of the PdfViewer.
Declaration
[HtmlAttributeName("ajaxRequestSettings")]
public PdfViewerAjaxRequestSettings AjaxRequestSettings { get; set; }
Property Value
AjaxRequestSuccess
Event triggers on successful AJAX request
Declaration
[HtmlAttributeName("ajaxRequestSuccess")]
public string AjaxRequestSuccess { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationAdd
Triggers when an annotation is added over the page of the PDF document.
Declaration
[HtmlAttributeName("annotationAdd")]
public string AnnotationAdd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationDoubleClick
Triggers an event when the annotation is double click.
Declaration
[HtmlAttributeName("annotationDoubleClick")]
public string AnnotationDoubleClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationMouseLeave
Triggers when mouse over the annotation object.
Declaration
[HtmlAttributeName("annotationMouseLeave")]
public string AnnotationMouseLeave { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationMouseover
Triggers when mouse over the annotation object.
Declaration
[HtmlAttributeName("annotationMouseover")]
public string AnnotationMouseover { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationMove
Triggers when an annotation is moved over the page of the PDF document.
Declaration
[HtmlAttributeName("annotationMove")]
public string AnnotationMove { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationMoving
Triggers while moving an annotation.
Declaration
[HtmlAttributeName("annotationMoving")]
public string AnnotationMoving { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationPropertiesChange
Triggers when the property of the annotation is changed in the page of the PDF document.
Declaration
[HtmlAttributeName("annotationPropertiesChange")]
public string AnnotationPropertiesChange { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationRemove
Triggers when an annotation is removed from the page of the PDF document.
Declaration
[HtmlAttributeName("annotationRemove")]
public string AnnotationRemove { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationResize
Triggers when an annotation is resized over the page of the PDF document.
Declaration
[HtmlAttributeName("annotationResize")]
public string AnnotationResize { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationSelect
Triggers when an annotation is selected over the page of the PDF document.
Declaration
[HtmlAttributeName("annotationSelect")]
public string AnnotationSelect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationSelectorSettings
Defines the settings of annotation selector.
Declaration
[HtmlAttributeName("annotationSelectorSettings")]
public PdfViewerAnnotationSelectorSettings AnnotationSelectorSettings { get; set; }
Property Value
AnnotationSettings
Defines the settings of the annotations.
Declaration
[HtmlAttributeName("annotationSettings")]
public object AnnotationSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
AnnotationUnSelect
Triggers when an annotation is unselected over the page of the PDF document.
Declaration
[HtmlAttributeName("annotationUnSelect")]
public string AnnotationUnSelect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AreaSettings
Defines the settings of area annotation.
Declaration
[HtmlAttributeName("areaSettings")]
public PdfViewerAreaSettings AreaSettings { get; set; }
Property Value
ArrowSettings
Defines the settings of arrow annotation.
Declaration
[HtmlAttributeName("arrowSettings")]
public PdfViewerArrowSettings ArrowSettings { get; set; }
Property Value
BeforeAddFreeText
Triggers the event before adding a text in the freeText annotation.
Declaration
[HtmlAttributeName("beforeAddFreeText")]
public string BeforeAddFreeText { get; set; }
Property Value
| Type |
Description |
| System.String |
|
BookmarkClick
Triggers an event when the bookmark is clicked in the bookmark panel of PDF Viewer.
Declaration
[HtmlAttributeName("bookmarkClick")]
public string BookmarkClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers an event when the button is clicked.
Declaration
[HtmlAttributeName("buttonFieldClick")]
public string ButtonFieldClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CheckBoxFieldSettings
Get or set the check box field settings.
Declaration
[HtmlAttributeName("checkBoxFieldSettings")]
public object CheckBoxFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
CircleSettings
Defines the settings of circle annotation.
Declaration
[HtmlAttributeName("circleSettings")]
public PdfViewerCircleSettings CircleSettings { get; set; }
Property Value
ClassName
Declaration
protected override string ClassName { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
Triggers when the comment is added for the annotation in the comment panel.
Declaration
[HtmlAttributeName("commentAdd")]
public string CommentAdd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers when the comment is deleted for the annotation in the comment panel.
Declaration
[HtmlAttributeName("commentDelete")]
public string CommentDelete { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers when the comment is edited for the annotation in the comment panel.
Declaration
[HtmlAttributeName("commentEdit")]
public string CommentEdit { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers when the comment is selected for the annotation in the comment panel.
Declaration
[HtmlAttributeName("commentSelect")]
public string CommentSelect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers when the comment for status is changed for the annotation in the comment panel.
Declaration
[HtmlAttributeName("commentStatusChanged")]
public string CommentStatusChanged { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Specifies the state of the ContextMenu in the PDF document.
Declaration
[HtmlAttributeName("contextMenuOption")]
public ContextMenuAction ContextMenuOption { get; set; }
Property Value
Defines the context menu settings.
Declaration
[HtmlAttributeName("contextMenuSettings")]
public object ContextMenuSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
Created
Triggers while created the PdfViewer component.
Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CurrentPageNumber
Returns the current page number of the document displayed in the PdfViewer control.
Declaration
[HtmlAttributeName("currentPageNumber")]
public double CurrentPageNumber { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
CustomStamp
Defines the stamp items of the PdfViewer.
Declaration
[HtmlAttributeName("customStamp")]
public object CustomStamp { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
CustomStampSettings
Defines the settings of customStamp annotation.
Declaration
[HtmlAttributeName("customStampSettings")]
public PdfViewerCustomStampSettings CustomStampSettings { get; set; }
Property Value
Customize desired date and time format
Declaration
[HtmlAttributeName("dateTimeFormat")]
public string DateTimeFormat { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DesignerMode
Enable or disable the interaction of form fields in the Pdfviewer.
Declaration
[HtmlAttributeName("designerMode")]
public bool DesignerMode { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
enable or disable context menu Items
Declaration
[HtmlAttributeName("disableContextMenuItems")]
public object DisableContextMenuItems { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
DistanceSettings
Defines the settings of distance annotation.
Declaration
[HtmlAttributeName("distanceSettings")]
public PdfViewerDistanceSettings DistanceSettings { get; set; }
Property Value
DocumentLoad
Triggers while loading document into PdfViewer.
Declaration
[HtmlAttributeName("documentLoad")]
public string DocumentLoad { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DocumentLoadFailed
Triggers while loading document got failed in PdfViewer.
Declaration
[HtmlAttributeName("documentLoadFailed")]
public string DocumentLoadFailed { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DocumentPath
Sets the PDF document path for initial loading.
Declaration
[HtmlAttributeName("documentPath")]
public string DocumentPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DocumentUnload
Triggers while close the document
Declaration
[HtmlAttributeName("documentUnload")]
public string DocumentUnload { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DownloadEnd
Triggers an event when the download actions is finished.
Declaration
[HtmlAttributeName("downloadEnd")]
public string DownloadEnd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DownloadFileName
Gets or sets the download file name in the PdfViewer control.
Declaration
[HtmlAttributeName("downloadFileName")]
public string DownloadFileName { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DownloadStart
Triggers an event when the download action is started.
Declaration
[HtmlAttributeName("downloadStart")]
public string DownloadStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DropdownFieldSettings
Get or set the dropdown field settings.
Declaration
[HtmlAttributeName("DropdownFieldSettings")]
public object DropdownFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
EnableAnnotation
Enable or disable the annotation in the Pdfviewer.
Declaration
[HtmlAttributeName("enableAnnotation")]
public bool EnableAnnotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.
Declaration
[HtmlAttributeName("enableAnnotationToolbar")]
public bool EnableAnnotationToolbar { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableAutoComplete
Enable or disables the auto complete option in form documents.
Declaration
[HtmlAttributeName("enableAutoComplete")]
public bool EnableAutoComplete { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableBookmark
Enables or disables the bookmark view in the PDF viewer
Declaration
[HtmlAttributeName("enableBookmark")]
public bool EnableBookmark { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableBookmarkStyles
Enables or disables the bookmark styles in the PDF viewer
Declaration
[HtmlAttributeName("enableBookmarkStyles")]
public bool EnableBookmarkStyles { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Enable or disables the Comment Panel of PdfViewer.
Declaration
[HtmlAttributeName("enableCommentPanel")]
public bool EnableCommentPanel { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableDesktopMode
Gets or sets a boolean value to show or hide desktop toolbar in mobile devices. FALSE by default.
Declaration
[HtmlAttributeName("enableDesktopMode")]
public bool EnableDesktopMode { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableDownload
Enable or disables the download option of PdfViewer.
Declaration
[HtmlAttributeName("enableDownload")]
public bool EnableDownload { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Get or set a boolean value to enable or disable the form designer. TRUE by default.
Declaration
[HtmlAttributeName("enableFormDesigner")]
public bool EnableFormDesigner { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Opens the form designer toolbar when the PDF document is loaded in the PDF Viewer control initially.
Declaration
[HtmlAttributeName("enableFormDesignerToolbar")]
public bool EnableFormDesignerToolbar { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Enable or disable the form fields in the Pdfviewer.
Declaration
[HtmlAttributeName("enableFormFields")]
public bool EnableFormFields { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Enable or disable the form fields validation.
Declaration
[HtmlAttributeName("enableFormFieldsValidation")]
public bool EnableFormFieldsValidation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableFreeText
Enable or disable the free text annotation in the Pdfviewer.
Declaration
[HtmlAttributeName("enableFreeText")]
public bool EnableFreeText { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableHandwrittenSignature
Enables or disables the handwritten signature in PDF document.
Declaration
[HtmlAttributeName("enableHandwrittenSignature")]
public bool EnableHandwrittenSignature { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableHyperlink
Enables or disables the hyperlinks in PDF document.
Declaration
[HtmlAttributeName("enableHyperlink")]
public bool EnableHyperlink { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableImportAnnotationMeasurement
Enable or disables the customization of measure values in PdfViewer.
Declaration
[HtmlAttributeName("enableImportAnnotationMeasurement")]
public bool EnableImportAnnotationMeasurement { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableInkAnnotation
If it is set as false, then the ink annotation support in the PDF Viewer will be disabled. By default it is true.
Declaration
[HtmlAttributeName("enableInkAnnotation")]
public bool EnableInkAnnotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableMagnification
Enable or disables the Magnification module of PdfViewer.
Declaration
[HtmlAttributeName("enableMagnification")]
public bool EnableMagnification { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableMeasureAnnotation
Enable or disables the calibrate annotation in the PdfViewer.
Declaration
[HtmlAttributeName("enableMeasureAnnotation")]
public bool EnableMeasureAnnotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableMultiLineOverlap
Enable or disable the multi line text markup annotations in overlapping collections.
Declaration
[HtmlAttributeName("enableMultiLineOverlap")]
public bool EnableMultiLineOverlap { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableMultiPageAnnotation
Enables or disables the multi-page text markup annotation selection in UI.
Declaration
[HtmlAttributeName("enableMultiPageAnnotation")]
public bool EnableMultiPageAnnotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableNavigation
Enable or disables the Navigation module of PdfViewer.
Declaration
[HtmlAttributeName("enableNavigation")]
public bool EnableNavigation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Enable or disables the Navigation toolbar of PdfViewer.
Declaration
[HtmlAttributeName("enableNavigationToolbar")]
public bool EnableNavigationToolbar { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnablePinchZoom
Enable or disables the Pinch zoom of PdfViewer.
Declaration
[HtmlAttributeName("enablePinchZoom")]
public bool EnablePinchZoom { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnablePrint
Enable or disables the print option of PdfViewer.
Declaration
[HtmlAttributeName("enablePrint")]
public bool EnablePrint { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnablePrintRotation
If it is set as FALSE, will suppress the page rotation of Landscape document on print action. By default it is TRUE.
Declaration
[HtmlAttributeName("enablePrintRotation")]
public bool EnablePrintRotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableShapeAnnotation
Enable or disables the shape annotation in the PdfViewer.
Declaration
[HtmlAttributeName("enableShapeAnnotation")]
public bool EnableShapeAnnotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableShapeLabel
Enable or disables the Label for shapeAnnotations of PdfViewer.
Declaration
[HtmlAttributeName("enableShapeLabel")]
public bool EnableShapeLabel { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableStampAnnotations
Enables and disables the stamp annotations when the PDF viewer control is loaded initially.
Declaration
[HtmlAttributeName("enableStampAnnotations")]
public bool EnableStampAnnotations { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableStickyNotesAnnotation
Enables and disables the stickyNotes annotations when the PDF viewer control is loaded initially.
Declaration
[HtmlAttributeName("enableStickyNotesAnnotation")]
public bool EnableStickyNotesAnnotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableTextMarkupAnnotation
Enable or disables the text markup annotation in the PdfViewer.
Declaration
[HtmlAttributeName("enableTextMarkupAnnotation")]
public bool EnableTextMarkupAnnotation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableTextMarkupResizer
Enable or disable the text markup resizer to modify the bounds in UI.
Declaration
[HtmlAttributeName("enableTextMarkupResizer")]
public bool EnableTextMarkupResizer { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableTextSearch
Enable or disables the text search in the PdfViewer.
Declaration
[HtmlAttributeName("enableTextSearch")]
public bool EnableTextSearch { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableTextSelection
Enable or disables the text selection in the PdfViewer.
Declaration
[HtmlAttributeName("enableTextSelection")]
public bool EnableTextSelection { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableThumbnail
Enables or disables the thumbnail view in the PDF viewer
Declaration
[HtmlAttributeName("enableThumbnail")]
public bool EnableThumbnail { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Enable or disables the toolbar of PdfViewer.
Declaration
[HtmlAttributeName("enableToolbar")]
public bool EnableToolbar { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableZoomOptimization
Enable or disable the zoom optimization mode in PDF Viewer.
Declaration
[HtmlAttributeName("enableZoomOptimization")]
public bool EnableZoomOptimization { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
ExportAnnotationFileName
Gets or sets the export annotations JSON file name in the PdfViewer control.
Declaration
[HtmlAttributeName("exportAnnotationFileName")]
public string ExportAnnotationFileName { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ExportFailed
Triggers when an export annotations failed in the PDF Viewer.
Declaration
[HtmlAttributeName("exportFailed")]
public string ExportFailed { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ExportStart
Triggers when an exported annotations started in the PDF Viewer.
Declaration
[HtmlAttributeName("exportStart")]
public string ExportStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ExportSuccess
Triggers when an export annotations succeed in the PDF Viewer.
Declaration
[HtmlAttributeName("exportSuccess")]
public string ExportSuccess { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers when an text extraction is completed in the PDF Viewer.
Declaration
[HtmlAttributeName("extractTextCompleted")]
public string ExtractTextCompleted { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a form field is added.
Declaration
[HtmlAttributeName("formFieldAdd")]
public string FormFieldAdd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers an event when the form field is clicked.
Declaration
[HtmlAttributeName("formFieldClick")]
public string FormFieldClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Gets the form fields present in the loaded PDF document. It used to get the form fields id, name, type and it's values.
Declaration
[HtmlAttributeName("formFieldCollections")]
public PdfViewerFormFieldCollections FormFieldCollections { get; set; }
Property Value
Triggers an event when the form field is double-clicked.
Declaration
[HtmlAttributeName("formFieldDoubleClick")]
public string FormFieldDoubleClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers when focus out from the form fields.
Declaration
[HtmlAttributeName("formFieldFocusOut")]
public string FormFieldFocusOut { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a mouse cursor leaves form field.
Declaration
[HtmlAttributeName("formFieldMouseLeave")]
public string FormFieldMouseLeave { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a mouse cursor is over a form field.
Declaration
[HtmlAttributeName("formFieldMouseover")]
public string FormFieldMouseover { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a form field is moved.
Declaration
[HtmlAttributeName("formFieldMove")]
public string FormFieldMove { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a property of form field is changed.
Declaration
[HtmlAttributeName("formFieldPropertiesChange")]
public string FormFieldPropertiesChange { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a form field is removed.
Declaration
[HtmlAttributeName("formFieldRemove")]
public string FormFieldRemove { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a form field is resized.
Declaration
[HtmlAttributeName("formFieldResize")]
public string FormFieldResize { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a form field is selected.
Declaration
[HtmlAttributeName("formFieldSelect")]
public string FormFieldSelect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
The event is triggered when a form field is unselected.
Declaration
[HtmlAttributeName("formFieldUnselect")]
public string FormFieldUnselect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
FreeTextSettings
Defines the settings of free text annotation.
Declaration
[HtmlAttributeName("freeTextSettings")]
public PdfViewerFreeTextSettings FreeTextSettings { get; set; }
Property Value
HandWrittenSignatureSettings
Defines the settings of handWrittenSignature.
Declaration
[HtmlAttributeName("handWrittenSignatureSettings")]
public PdfViewerHandWrittenSignatureSettings HandWrittenSignatureSettings { get; set; }
Property Value
Height
Defines the scrollable height of the PdfViewer control.
Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HideSaveSignature
Gets or sets a boolean value to show or hide the save signature check box option in the signature dialog.
FALSE by default
Declaration
[HtmlAttributeName("hideSaveSignature")]
public bool HideSaveSignature { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
HighlightSettings
Defines the settings of highlight annotation.
Declaration
[HtmlAttributeName("highlightSettings")]
public PdfViewerHighlightSettings HighlightSettings { get; set; }
Property Value
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
HyperlinkClick
Triggers when hyperlink in the PDF Document is clicked
Declaration
[HtmlAttributeName("hyperlinkClick")]
public string HyperlinkClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HyperlinkMouseOver
Triggers when hyperlink in the PDF Document is hovered
Declaration
[HtmlAttributeName("hyperlinkMouseOver")]
public string HyperlinkMouseOver { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HyperlinkOpenState
Specifies the open state of the hyperlink in the PDF document.
Declaration
[HtmlAttributeName("hyperlinkOpenState")]
public LinkTarget HyperlinkOpenState { get; set; }
Property Value
ImportFailed
Triggers when an imports annotations failed in the PDF document.
Declaration
[HtmlAttributeName("importFailed")]
public string ImportFailed { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ImportStart
Triggers when an imported annotations started in the PDF document.
Declaration
[HtmlAttributeName("importStart")]
public string ImportStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ImportSuccess
Triggers when an imports annotations succeed in the PDF document.
Declaration
[HtmlAttributeName("importSuccess")]
public string ImportSuccess { get; set; }
Property Value
| Type |
Description |
| System.String |
|
InitialDialogSettings
Get or set the signature dialog settings for initial field.
Declaration
[HtmlAttributeName("initialDialogSettings")]
public object InitialDialogSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
InitialFieldSettings
Get or set the initial field settings.
Declaration
[HtmlAttributeName("initialFieldSettings")]
public object InitialFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
InkAnnotationSettings
Defines the ink annotation settings for PDF Viewer.It used to customize the strokeColor, thickness, opacity of the ink annotation.
Declaration
[HtmlAttributeName("inkAnnotationSettings")]
public object InkAnnotationSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
InteractionMode
Sets the interaction mode of the PdfViewer
Declaration
[HtmlAttributeName("interactionMode")]
public InteractionMode InteractionMode { get; set; }
Property Value
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially.
Declaration
[HtmlAttributeName("isAnnotationToolbarOpen")]
public bool IsAnnotationToolbarOpen { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Opens the annotation toolbar when the PDF document is loaded in the PDF Viewer control initially
and get the annotation Toolbar Visible status.
Declaration
[HtmlAttributeName("isAnnotationToolbarVisible")]
public bool IsAnnotationToolbarVisible { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsBookmarkPanelOpen
Gets or sets a boolean value to show or hide the bookmark panel while loading a document. FALSE by default.
Declaration
[HtmlAttributeName("isBookmarkPanelOpen")]
public bool IsBookmarkPanelOpen { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsCommandPanelOpen
If it set as true, then the command panel show at initial document loading in the PDF viewer
Declaration
[HtmlAttributeName("isCommandPanelOpen")]
public bool IsCommandPanelOpen { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsDocumentEdited
Checks whether the PDF document is edited.
Declaration
[HtmlAttributeName("isDocumentEdited")]
public bool IsDocumentEdited { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Enable or disables the get the document text collections.
Declaration
[HtmlAttributeName("isExtractText")]
public bool IsExtractText { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsFor
Declaration
protected override bool IsFor { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Overrides
Enable if the PDF document contains form fields.
Declaration
[HtmlAttributeName("isFormFieldDocument")]
public bool IsFormFieldDocument { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsMaintainSelection
Maintain the selection of text markup annotation.
Declaration
[HtmlAttributeName("isMaintainSelection")]
public bool IsMaintainSelection { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsSignatureEditable
Enables or disable saving Hand Written signature as editable in the PDF.
Declaration
[HtmlAttributeName("isSignatureEditable")]
public bool IsSignatureEditable { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsThumbnailViewOpen
If it set as true, then the thumbnail view show at initial document loading in the PDF viewer
Declaration
[HtmlAttributeName("isThumbnailViewOpen")]
public bool IsThumbnailViewOpen { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsValidFreeText
Checks if the freeText value is valid or not. FALSE by default
Declaration
[HtmlAttributeName("isValidFreeText")]
public bool IsValidFreeText { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
LineSettings
Defines the settings of line annotation.
Declaration
[HtmlAttributeName("lineSettings")]
public PdfViewerLineSettings LineSettings { get; set; }
Property Value
ListBoxFieldSettings
Get or set the listbox field settings.
Declaration
[HtmlAttributeName("listBoxFieldSettings")]
public object ListBoxFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
[HtmlAttributeName("locale")]
public string Locale { get; set; }
Property Value
| Type |
Description |
| System.String |
|
MeasurementSettings
Defines the settings of measurement annotation.
Declaration
[HtmlAttributeName("measurementSettings")]
public PdfViewerMeasurementSettings MeasurementSettings { get; set; }
Property Value
MoveSignature
Triggers when an signature is moved over the page of the PDF document.
Declaration
[HtmlAttributeName("moveSignature")]
public string MoveSignature { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NameSpace
Declaration
protected override string NameSpace { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
PageChange
Triggers when there is change in current page number.
Declaration
[HtmlAttributeName("pageChange")]
public string PageChange { get; set; }
Property Value
| Type |
Description |
| System.String |
|
PageClick
Triggers when the mouse click is performed over the page of the PDF document.
Declaration
[HtmlAttributeName("pageClick")]
public string PageClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
PageCount
gets the page count of the document loaded in the PdfViewer control.
Declaration
[HtmlAttributeName("pageCount")]
public double PageCount { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
PageMouseover
Triggers when mouse over the page.
Declaration
[HtmlAttributeName("pageMouseover")]
public string PageMouseover { get; set; }
Property Value
| Type |
Description |
| System.String |
|
PasswordFieldSettings
Get or set the password field settings.
Declaration
[HtmlAttributeName("passwordFieldSettings")]
public object PasswordFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
PerimeterSettings
Defines the settings of perimeter annotation.
Declaration
[HtmlAttributeName("perimeterSettings")]
public PdfViewerPerimeterSettings PerimeterSettings { get; set; }
Property Value
PolygonSettings
Defines the settings of polygon annotation.
Declaration
[HtmlAttributeName("polygonSettings")]
public PdfViewerPolygonSettings PolygonSettings { get; set; }
Property Value
PrintEnd
Triggers an event when the print actions is finished.
Declaration
[HtmlAttributeName("printEnd")]
public string PrintEnd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
PrintMode
Specifies the print mode in the PDF Viewer.
Declaration
[HtmlAttributeName("printMode")]
public PrintMode PrintMode { get; set; }
Property Value
PrintStart
Triggers an event when the print action is started.
Declaration
[HtmlAttributeName("printStart")]
public string PrintStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Get or set the radio button field settings.
Declaration
[HtmlAttributeName("radioButtonFieldSettings")]
public object RadioButtonFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
RadiusSettings
Defines the settings of radius annotation.
Declaration
[HtmlAttributeName("radiusSettings")]
public PdfViewerRadiusSettings RadiusSettings { get; set; }
Property Value
RectangleSettings
Defines the settings of rectangle annotation.
Declaration
[HtmlAttributeName("rectangleSettings")]
public PdfViewerRectangleSettings RectangleSettings { get; set; }
Property Value
RemoveSignature
Triggers when signature is removed over the page of the PDF document.
Declaration
[HtmlAttributeName("removeSignature")]
public string RemoveSignature { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ResizeSignature
Triggers when signature is resized over the page of the PDF document.
Declaration
[HtmlAttributeName("resizeSignature")]
public string ResizeSignature { get; set; }
Property Value
| Type |
Description |
| System.String |
|
RestrictZoomRequest
Declaration
[HtmlAttributeName("restrictZoomRequest")]
public bool RestrictZoomRequest { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
RetryCount
Specifies the retry count for the failed requests.
Declaration
[HtmlAttributeName("retryCount")]
public double RetryCount { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
Defines the scroll settings.
Declaration
[HtmlAttributeName("scrollSettings")]
public object ScrollSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
SelectedItems
Defines the collection of selected items, size and position of the selector
Declaration
[HtmlAttributeName("selectedItems")]
public object SelectedItems { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
ServerActionSettings
Defines the settings of the PdfViewer service.
Declaration
[HtmlAttributeName("serverActionSettings")]
public PdfViewerServerActionSettings ServerActionSettings { get; set; }
Property Value
ServiceUrl
Defines the service url of the PdfViewer control.
Declaration
[HtmlAttributeName("serviceUrl")]
public string ServiceUrl { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ShapeLabelSettings
Defines the settings of shape label.
Declaration
[HtmlAttributeName("shapeLabelSettings")]
public PdfViewerShapeLabelSettings ShapeLabelSettings { get; set; }
Property Value
ShowNotificationDialog
If it is set as false then error message box is not displayed in PDF viewer control.
Declaration
[HtmlAttributeName("showNotificationDialog")]
public bool ShowNotificationDialog { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
SignatureDialogSettings
Get or set the signature dialog settings for signature field.
Declaration
[HtmlAttributeName("signatureDialogSettings")]
public object SignatureDialogSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
SignatureFieldSettings
Get or set the signature field settings.
Declaration
[HtmlAttributeName("signatureFieldSettings")]
public object SignatureFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
SignatureFitMode
Specifies the signature mode in the PDF Viewer.
Declaration
[HtmlAttributeName("signatureFitMode")]
public SignatureFitMode SignatureFitMode { get; set; }
Property Value
SignaturePropertiesChange
Triggers when the property of the signature is changed in the page of the PDF document.
Declaration
[HtmlAttributeName("signaturePropertiesChange")]
public string SignaturePropertiesChange { get; set; }
Property Value
| Type |
Description |
| System.String |
|
SignatureSelect
Triggers when signature is selected over the page of the PDF document.
Declaration
[HtmlAttributeName("signatureSelect")]
public string SignatureSelect { get; set; }
Property Value
| Type |
Description |
| System.String |
|
StampSettings
Defines the settings of stamp annotation.
Declaration
[HtmlAttributeName("stampSettings")]
public PdfViewerStampSettings StampSettings { get; set; }
Property Value
StickyNotesSettings
Defines the settings of stickyNotes annotation.
Declaration
[HtmlAttributeName("stickyNotesSettings")]
public PdfViewerStickyNotesSettings StickyNotesSettings { get; set; }
Property Value
StrikethroughSettings
Defines the settings of strikethrough annotation.
Declaration
[HtmlAttributeName("strikethroughSettings")]
public PdfViewerStrikethroughSettings StrikethroughSettings { get; set; }
Property Value
TagName
Declaration
protected override string TagName { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
TextFieldSettings
Get or set the text field settings.
Declaration
[HtmlAttributeName("textFieldSettings")]
public object TextFieldSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
TextSearchColorSettings
Sets the settings for the color of the text search highlight.
Declaration
[HtmlAttributeName("textSearchColorSettings")]
public PdfViewerTextSearchColorSettings TextSearchColorSettings { get; set; }
Property Value
TextSearchComplete
Triggers an event when the text search is completed.
Declaration
[HtmlAttributeName("textSearchComplete")]
public string TextSearchComplete { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TextSearchHighlight
Triggers an event when the text search text is highlighted.
Declaration
[HtmlAttributeName("textSearchHighlight")]
public string TextSearchHighlight { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TextSearchStart
Triggers an event when the text search is started.
Declaration
[HtmlAttributeName("textSearchStart")]
public string TextSearchStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TextSelectionEnd
Triggers an event when the text selection is finished.
Declaration
[HtmlAttributeName("textSelectionEnd")]
public string TextSelectionEnd { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TextSelectionStart
Triggers an event when the text selection is started.
Declaration
[HtmlAttributeName("textSelectionStart")]
public string TextSelectionStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ThumbnailClick
Triggers an event when the thumbnail is clicked in the thumbnail panel of PDF Viewer.
Declaration
[HtmlAttributeName("thumbnailClick")]
public string ThumbnailClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TileRenderingSettings
Defines the tile rendering settings.
Declaration
[HtmlAttributeName("tileRenderingSettings")]
public object TileRenderingSettings { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
Defines the settings of the PdfViewer toolbar.
Declaration
[HtmlAttributeName("toolbarSettings")]
public PdfViewerToolbarSettings ToolbarSettings { get; set; }
Property Value
UnderlineSettings
Defines the settings of underline annotation.
Declaration
[HtmlAttributeName("underlineSettings")]
public PdfViewerUnderlineSettings UnderlineSettings { get; set; }
Property Value
Triggers when validation is failed.
Declaration
[HtmlAttributeName("validateFormFields")]
public string ValidateFormFields { get; set; }
Property Value
| Type |
Description |
| System.String |
|
VolumeSettings
Defines the settings of volume annotation.
Declaration
[HtmlAttributeName("volumeSettings")]
public PdfViewerVolumeSettings VolumeSettings { get; set; }
Property Value
Width
Defines the scrollable width of the PdfViewer control.
Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ZoomChange
Triggers when there is change in the magnification value.
Declaration
[HtmlAttributeName("zoomChange")]
public string ZoomChange { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ZoomMode
Specifies the rendering mode in the PDF Viewer.
Declaration
[HtmlAttributeName("zoomMode")]
public ZoomMode ZoomMode { get; set; }
Property Value
ZoomValue
Sets the initial loading zoom value from 10 to 400 in PdfViewer Control.
Declaration
[HtmlAttributeName("zoomValue")]
public double ZoomValue { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
