Class PdfViewer

Inheritance
System.Object
EJTagHelper
PdfViewer
Inherited Members
Namespace: Syncfusion.EJ2.PdfViewer
Assembly: Syncfusion.EJ2.dll
Syntax
public class PdfViewer : EJTagHelper

Constructors

PdfViewer()

Declaration
public PdfViewer()

Properties

AddSignature

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

Declaration
public string AddSignature { get; set; }
Property Value
Type Description
System.String

AjaxRequestFailed

Triggers when the AJAX request is failed.

Declaration
public string AjaxRequestFailed { get; set; }
Property Value
Type Description
System.String

AjaxRequestInitiate

Triggers before the data send in to the server.

Declaration
public string AjaxRequestInitiate { get; set; }
Property Value
Type Description
System.String

AjaxRequestSettings

Defines the ajax Request settings of the PdfViewer.

Declaration
public PdfViewerAjaxRequestSettings AjaxRequestSettings { get; set; }
Property Value
Type Description
PdfViewerAjaxRequestSettings

AjaxRequestSuccess

Event triggers on successful AJAX request

Declaration
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
public string AnnotationAdd { get; set; }
Property Value
Type Description
System.String

AnnotationDoubleClick

Triggers an event when the annotation is double click.

Declaration
public string AnnotationDoubleClick { get; set; }
Property Value
Type Description
System.String

AnnotationMouseLeave

Triggers when mouse over the annotation object.

Declaration
public string AnnotationMouseLeave { get; set; }
Property Value
Type Description
System.String

AnnotationMouseover

Triggers when mouse over the annotation object.

Declaration
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
public string AnnotationMove { get; set; }
Property Value
Type Description
System.String

AnnotationMoving

Triggers while moving an annotation.

Declaration
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
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
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
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
public string AnnotationSelect { get; set; }
Property Value
Type Description
System.String

AnnotationSelectorSettings

Defines the settings of annotation selector.

Declaration
public PdfViewerAnnotationSelectorSettings AnnotationSelectorSettings { get; set; }
Property Value
Type Description
PdfViewerAnnotationSelectorSettings

AnnotationSettings

Defines the settings of the annotations.

Declaration
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
public string AnnotationUnSelect { get; set; }
Property Value
Type Description
System.String

AreaSettings

Defines the settings of area annotation.

Declaration
public PdfViewerAreaSettings AreaSettings { get; set; }
Property Value
Type Description
PdfViewerAreaSettings

ArrowSettings

Defines the settings of arrow annotation.

Declaration
public PdfViewerArrowSettings ArrowSettings { get; set; }
Property Value
Type Description
PdfViewerArrowSettings

BeforeAddFreeText

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

Declaration
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
public string BookmarkClick { get; set; }
Property Value
Type Description
System.String

ButtonFieldClick

Triggers an event when the button is clicked.

Declaration
public string ButtonFieldClick { get; set; }
Property Value
Type Description
System.String

CheckBoxFieldSettings

Get or set the check box field settings.

Declaration
public object CheckBoxFieldSettings { get; set; }
Property Value
Type Description
System.Object

CircleSettings

Defines the settings of circle annotation.

Declaration
public PdfViewerCircleSettings CircleSettings { get; set; }
Property Value
Type Description
PdfViewerCircleSettings

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

CommentAdd

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

Declaration
public string CommentAdd { get; set; }
Property Value
Type Description
System.String

CommentDelete

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

Declaration
public string CommentDelete { get; set; }
Property Value
Type Description
System.String

CommentEdit

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

Declaration
public string CommentEdit { get; set; }
Property Value
Type Description
System.String

CommentSelect

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

Declaration
public string CommentSelect { get; set; }
Property Value
Type Description
System.String

CommentStatusChanged

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

Declaration
public string CommentStatusChanged { get; set; }
Property Value
Type Description
System.String

ContextMenuOption

Specifies the state of the ContextMenu in the PDF document.

Declaration
public ContextMenuAction ContextMenuOption { get; set; }
Property Value
Type Description
ContextMenuAction

ContextMenuSettings

Defines the context menu settings.

Declaration
public object ContextMenuSettings { get; set; }
Property Value
Type Description
System.Object

Created

Triggers while created the PdfViewer component.

Declaration
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
public double CurrentPageNumber { get; set; }
Property Value
Type Description
System.Double

CustomStamp

Defines the stamp items of the PdfViewer.

Declaration
public object CustomStamp { get; set; }
Property Value
Type Description
System.Object

CustomStampSettings

Defines the settings of customStamp annotation.

Declaration
public PdfViewerCustomStampSettings CustomStampSettings { get; set; }
Property Value
Type Description
PdfViewerCustomStampSettings

DateTimeFormat

Customize desired date and time format

Declaration
public string DateTimeFormat { get; set; }
Property Value
Type Description
System.String

DesignerMode

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

Declaration
public bool DesignerMode { get; set; }
Property Value
Type Description
System.Boolean

DisableContextMenuItems

enable or disable context menu Items

Declaration
public object DisableContextMenuItems { get; set; }
Property Value
Type Description
System.Object

DistanceSettings

Defines the settings of distance annotation.

Declaration
public PdfViewerDistanceSettings DistanceSettings { get; set; }
Property Value
Type Description
PdfViewerDistanceSettings

DocumentLoad

Triggers while loading document into PdfViewer.

Declaration
public string DocumentLoad { get; set; }
Property Value
Type Description
System.String

DocumentLoadFailed

Triggers while loading document got failed in PdfViewer.

Declaration
public string DocumentLoadFailed { get; set; }
Property Value
Type Description
System.String

DocumentPath

Sets the PDF document path for initial loading.

Declaration
public string DocumentPath { get; set; }
Property Value
Type Description
System.String

DocumentUnload

Triggers while close the document

Declaration
public string DocumentUnload { get; set; }
Property Value
Type Description
System.String

DownloadEnd

Triggers an event when the download actions is finished.

Declaration
public string DownloadEnd { get; set; }
Property Value
Type Description
System.String

DownloadFileName

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

Declaration
public string DownloadFileName { get; set; }
Property Value
Type Description
System.String

DownloadStart

Triggers an event when the download action is started.

Declaration
public string DownloadStart { get; set; }
Property Value
Type Description
System.String

DropdownFieldSettings

Get or set the dropdown field settings.

Declaration
public object DropdownFieldSettings { get; set; }
Property Value
Type Description
System.Object

EnableAnnotation

Enable or disable the annotation in the Pdfviewer.

Declaration
public bool EnableAnnotation { get; set; }
Property Value
Type Description
System.Boolean

EnableAnnotationToolbar

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

Declaration
public bool EnableAnnotationToolbar { get; set; }
Property Value
Type Description
System.Boolean

EnableAutoComplete

Enable or disables the auto complete option in form documents.

Declaration
public bool EnableAutoComplete { get; set; }
Property Value
Type Description
System.Boolean

EnableBookmark

Enables or disables the bookmark view in the PDF viewer

Declaration
public bool EnableBookmark { get; set; }
Property Value
Type Description
System.Boolean

EnableBookmarkStyles

Enables or disables the bookmark styles in the PDF viewer

Declaration
public bool EnableBookmarkStyles { get; set; }
Property Value
Type Description
System.Boolean

EnableCommentPanel

Enable or disables the Comment Panel of PdfViewer.

Declaration
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
public bool EnableDesktopMode { get; set; }
Property Value
Type Description
System.Boolean

EnableDownload

Enable or disables the download option of PdfViewer.

Declaration
public bool EnableDownload { get; set; }
Property Value
Type Description
System.Boolean

EnableFormDesigner

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

Declaration
public bool EnableFormDesigner { get; set; }
Property Value
Type Description
System.Boolean

EnableFormDesignerToolbar

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

Declaration
public bool EnableFormDesignerToolbar { get; set; }
Property Value
Type Description
System.Boolean

EnableFormFields

Enable or disable the form fields in the Pdfviewer.

Declaration
public bool EnableFormFields { get; set; }
Property Value
Type Description
System.Boolean

EnableFormFieldsValidation

Enable or disable the form fields validation.

Declaration
public bool EnableFormFieldsValidation { get; set; }
Property Value
Type Description
System.Boolean

EnableFreeText

Enable or disable the free text annotation in the Pdfviewer.

Declaration
public bool EnableFreeText { get; set; }
Property Value
Type Description
System.Boolean

EnableHandwrittenSignature

Enables or disables the handwritten signature in PDF document.

Declaration
public bool EnableHandwrittenSignature { get; set; }
Property Value
Type Description
System.Boolean

Enables or disables the hyperlinks in PDF document.

Declaration
public bool EnableHyperlink { get; set; }
Property Value
Type Description
System.Boolean

EnableImportAnnotationMeasurement

Enable or disables the customization of measure values in PdfViewer.

Declaration
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
public bool EnableInkAnnotation { get; set; }
Property Value
Type Description
System.Boolean

EnableMagnification

Enable or disables the Magnification module of PdfViewer.

Declaration
public bool EnableMagnification { get; set; }
Property Value
Type Description
System.Boolean

EnableMeasureAnnotation

Enable or disables the calibrate annotation in the PdfViewer.

Declaration
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
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
public bool EnableMultiPageAnnotation { get; set; }
Property Value
Type Description
System.Boolean

EnableNavigation

Enable or disables the Navigation module of PdfViewer.

Declaration
public bool EnableNavigation { get; set; }
Property Value
Type Description
System.Boolean

EnableNavigationToolbar

Enable or disables the Navigation toolbar of PdfViewer.

Declaration
public bool EnableNavigationToolbar { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

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

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnablePinchZoom

Enable or disables the Pinch zoom of PdfViewer.

Declaration
public bool EnablePinchZoom { get; set; }
Property Value
Type Description
System.Boolean

EnablePrint

Enable or disables the print option of PdfViewer.

Declaration
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
public bool EnablePrintRotation { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

EnableShapeAnnotation

Enable or disables the shape annotation in the PdfViewer.

Declaration
public bool EnableShapeAnnotation { get; set; }
Property Value
Type Description
System.Boolean

EnableShapeLabel

Enable or disables the Label for shapeAnnotations of PdfViewer.

Declaration
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
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
public bool EnableStickyNotesAnnotation { get; set; }
Property Value
Type Description
System.Boolean

EnableTextMarkupAnnotation

Enable or disables the text markup annotation in the PdfViewer.

Declaration
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
public bool EnableTextMarkupResizer { get; set; }
Property Value
Type Description
System.Boolean

EnableTextSearch

Enable or disables the text search in the PdfViewer.

Declaration
public bool EnableTextSearch { get; set; }
Property Value
Type Description
System.Boolean

EnableTextSelection

Enable or disables the text selection in the PdfViewer.

Declaration
public bool EnableTextSelection { get; set; }
Property Value
Type Description
System.Boolean

EnableThumbnail

Enables or disables the thumbnail view in the PDF viewer

Declaration
public bool EnableThumbnail { get; set; }
Property Value
Type Description
System.Boolean

EnableToolbar

Enable or disables the toolbar of PdfViewer.

Declaration
public bool EnableToolbar { get; set; }
Property Value
Type Description
System.Boolean

EnableZoomOptimization

Enable or disable the zoom optimization mode in PDF Viewer.

Declaration
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
public string ExportAnnotationFileName { get; set; }
Property Value
Type Description
System.String

ExportFailed

Triggers when an export annotations failed in the PDF Viewer.

Declaration
public string ExportFailed { get; set; }
Property Value
Type Description
System.String

ExportStart

Triggers when an exported annotations started in the PDF Viewer.

Declaration
public string ExportStart { get; set; }
Property Value
Type Description
System.String

ExportSuccess

Triggers when an export annotations succeed in the PDF Viewer.

Declaration
public string ExportSuccess { get; set; }
Property Value
Type Description
System.String

ExtractTextCompleted

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

Declaration
public string ExtractTextCompleted { get; set; }
Property Value
Type Description
System.String

FormFieldAdd

The event is triggered when a form field is added.

Declaration
public string FormFieldAdd { get; set; }
Property Value
Type Description
System.String

FormFieldClick

Triggers an event when the form field is clicked.

Declaration
public string FormFieldClick { get; set; }
Property Value
Type Description
System.String

FormFieldCollections

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
public PdfViewerFormFieldCollections FormFieldCollections { get; set; }
Property Value
Type Description
PdfViewerFormFieldCollections

FormFieldDoubleClick

Triggers an event when the form field is double-clicked.

Declaration
public string FormFieldDoubleClick { get; set; }
Property Value
Type Description
System.String

FormFieldFocusOut

Triggers when focus out from the form fields.

Declaration
public string FormFieldFocusOut { get; set; }
Property Value
Type Description
System.String

FormFieldMouseLeave

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

Declaration
public string FormFieldMouseLeave { get; set; }
Property Value
Type Description
System.String

FormFieldMouseover

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

Declaration
public string FormFieldMouseover { get; set; }
Property Value
Type Description
System.String

FormFieldMove

The event is triggered when a form field is moved.

Declaration
public string FormFieldMove { get; set; }
Property Value
Type Description
System.String

FormFieldPropertiesChange

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

Declaration
public string FormFieldPropertiesChange { get; set; }
Property Value
Type Description
System.String

FormFieldRemove

The event is triggered when a form field is removed.

Declaration
public string FormFieldRemove { get; set; }
Property Value
Type Description
System.String

FormFieldResize

The event is triggered when a form field is resized.

Declaration
public string FormFieldResize { get; set; }
Property Value
Type Description
System.String

FormFieldSelect

The event is triggered when a form field is selected.

Declaration
public string FormFieldSelect { get; set; }
Property Value
Type Description
System.String

FormFieldUnselect

The event is triggered when a form field is unselected.

Declaration
public string FormFieldUnselect { get; set; }
Property Value
Type Description
System.String

FreeTextSettings

Defines the settings of free text annotation.

Declaration
public PdfViewerFreeTextSettings FreeTextSettings { get; set; }
Property Value
Type Description
PdfViewerFreeTextSettings

HandWrittenSignatureSettings

Defines the settings of handWrittenSignature.

Declaration
public PdfViewerHandWrittenSignatureSettings HandWrittenSignatureSettings { get; set; }
Property Value
Type Description
PdfViewerHandWrittenSignatureSettings

Height

Defines the scrollable height of the PdfViewer control.

Declaration
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
public bool HideSaveSignature { get; set; }
Property Value
Type Description
System.Boolean

HighlightSettings

Defines the settings of highlight annotation.

Declaration
public PdfViewerHighlightSettings HighlightSettings { get; set; }
Property Value
Type Description
PdfViewerHighlightSettings

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

HyperlinkClick

Triggers when hyperlink in the PDF Document is clicked

Declaration
public string HyperlinkClick { get; set; }
Property Value
Type Description
System.String

HyperlinkMouseOver

Triggers when hyperlink in the PDF Document is hovered

Declaration
public string HyperlinkMouseOver { get; set; }
Property Value
Type Description
System.String

HyperlinkOpenState

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

Declaration
public LinkTarget HyperlinkOpenState { get; set; }
Property Value
Type Description
LinkTarget

ImportFailed

Triggers when an imports annotations failed in the PDF document.

Declaration
public string ImportFailed { get; set; }
Property Value
Type Description
System.String

ImportStart

Triggers when an imported annotations started in the PDF document.

Declaration
public string ImportStart { get; set; }
Property Value
Type Description
System.String

ImportSuccess

Triggers when an imports annotations succeed in the PDF document.

Declaration
public string ImportSuccess { get; set; }
Property Value
Type Description
System.String

InitialDialogSettings

Get or set the signature dialog settings for initial field.

Declaration
public object InitialDialogSettings { get; set; }
Property Value
Type Description
System.Object

InitialFieldSettings

Get or set the initial field settings.

Declaration
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
public object InkAnnotationSettings { get; set; }
Property Value
Type Description
System.Object

InteractionMode

Sets the interaction mode of the PdfViewer

Declaration
public InteractionMode InteractionMode { get; set; }
Property Value
Type Description
InteractionMode

IsAnnotationToolbarOpen

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

Declaration
public bool IsAnnotationToolbarOpen { get; set; }
Property Value
Type Description
System.Boolean

IsAnnotationToolbarVisible

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

Declaration
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
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
public bool IsCommandPanelOpen { get; set; }
Property Value
Type Description
System.Boolean

IsDocumentEdited

Checks whether the PDF document is edited.

Declaration
public bool IsDocumentEdited { get; set; }
Property Value
Type Description
System.Boolean

IsExtractText

Enable or disables the get the document text collections.

Declaration
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

IsFormFieldDocument

Enable if the PDF document contains form fields.

Declaration
public bool IsFormFieldDocument { get; set; }
Property Value
Type Description
System.Boolean

IsMaintainSelection

Maintain the selection of text markup annotation.

Declaration
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
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
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
public bool IsValidFreeText { get; set; }
Property Value
Type Description
System.Boolean

LineSettings

Defines the settings of line annotation.

Declaration
public PdfViewerLineSettings LineSettings { get; set; }
Property Value
Type Description
PdfViewerLineSettings

ListBoxFieldSettings

Get or set the listbox field settings.

Declaration
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
public string Locale { get; set; }
Property Value
Type Description
System.String

MeasurementSettings

Defines the settings of measurement annotation.

Declaration
public PdfViewerMeasurementSettings MeasurementSettings { get; set; }
Property Value
Type Description
PdfViewerMeasurementSettings

MoveSignature

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

Declaration
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
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
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
public double PageCount { get; set; }
Property Value
Type Description
System.Double

PageMouseover

Triggers when mouse over the page.

Declaration
public string PageMouseover { get; set; }
Property Value
Type Description
System.String

PasswordFieldSettings

Get or set the password field settings.

Declaration
public object PasswordFieldSettings { get; set; }
Property Value
Type Description
System.Object

PerimeterSettings

Defines the settings of perimeter annotation.

Declaration
public PdfViewerPerimeterSettings PerimeterSettings { get; set; }
Property Value
Type Description
PdfViewerPerimeterSettings

PolygonSettings

Defines the settings of polygon annotation.

Declaration
public PdfViewerPolygonSettings PolygonSettings { get; set; }
Property Value
Type Description
PdfViewerPolygonSettings

PrintEnd

Triggers an event when the print actions is finished.

Declaration
public string PrintEnd { get; set; }
Property Value
Type Description
System.String

PrintMode

Specifies the print mode in the PDF Viewer.

Declaration
public PrintMode PrintMode { get; set; }
Property Value
Type Description
PrintMode

PrintStart

Triggers an event when the print action is started.

Declaration
public string PrintStart { get; set; }
Property Value
Type Description
System.String

RadioButtonFieldSettings

Get or set the radio button field settings.

Declaration
public object RadioButtonFieldSettings { get; set; }
Property Value
Type Description
System.Object

RadiusSettings

Defines the settings of radius annotation.

Declaration
public PdfViewerRadiusSettings RadiusSettings { get; set; }
Property Value
Type Description
PdfViewerRadiusSettings

RectangleSettings

Defines the settings of rectangle annotation.

Declaration
public PdfViewerRectangleSettings RectangleSettings { get; set; }
Property Value
Type Description
PdfViewerRectangleSettings

RemoveSignature

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

Declaration
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
public string ResizeSignature { get; set; }
Property Value
Type Description
System.String

RestrictZoomRequest

restrict zoom request.

Declaration
public bool RestrictZoomRequest { get; set; }
Property Value
Type Description
System.Boolean

RetryCount

Specifies the retry count for the failed requests.

Declaration
public double RetryCount { get; set; }
Property Value
Type Description
System.Double

ScrollSettings

Defines the scroll settings.

Declaration
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
public object SelectedItems { get; set; }
Property Value
Type Description
System.Object

ServerActionSettings

Defines the settings of the PdfViewer service.

Declaration
public PdfViewerServerActionSettings ServerActionSettings { get; set; }
Property Value
Type Description
PdfViewerServerActionSettings

ServiceUrl

Defines the service url of the PdfViewer control.

Declaration
public string ServiceUrl { get; set; }
Property Value
Type Description
System.String

ShapeLabelSettings

Defines the settings of shape label.

Declaration
public PdfViewerShapeLabelSettings ShapeLabelSettings { get; set; }
Property Value
Type Description
PdfViewerShapeLabelSettings

ShowNotificationDialog

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

Declaration
public bool ShowNotificationDialog { get; set; }
Property Value
Type Description
System.Boolean

SignatureDialogSettings

Get or set the signature dialog settings for signature field.

Declaration
public object SignatureDialogSettings { get; set; }
Property Value
Type Description
System.Object

SignatureFieldSettings

Get or set the signature field settings.

Declaration
public object SignatureFieldSettings { get; set; }
Property Value
Type Description
System.Object

SignatureFitMode

Specifies the signature mode in the PDF Viewer.

Declaration
public SignatureFitMode SignatureFitMode { get; set; }
Property Value
Type Description
SignatureFitMode

SignaturePropertiesChange

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

Declaration
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
public string SignatureSelect { get; set; }
Property Value
Type Description
System.String

StampSettings

Defines the settings of stamp annotation.

Declaration
public PdfViewerStampSettings StampSettings { get; set; }
Property Value
Type Description
PdfViewerStampSettings

StickyNotesSettings

Defines the settings of stickyNotes annotation.

Declaration
public PdfViewerStickyNotesSettings StickyNotesSettings { get; set; }
Property Value
Type Description
PdfViewerStickyNotesSettings

StrikethroughSettings

Defines the settings of strikethrough annotation.

Declaration
public PdfViewerStrikethroughSettings StrikethroughSettings { get; set; }
Property Value
Type Description
PdfViewerStrikethroughSettings

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

TextFieldSettings

Get or set the text field settings.

Declaration
public object TextFieldSettings { get; set; }
Property Value
Type Description
System.Object

TextSearchColorSettings

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

Declaration
public PdfViewerTextSearchColorSettings TextSearchColorSettings { get; set; }
Property Value
Type Description
PdfViewerTextSearchColorSettings

TextSearchComplete

Triggers an event when the text search is completed.

Declaration
public string TextSearchComplete { get; set; }
Property Value
Type Description
System.String

TextSearchHighlight

Triggers an event when the text search text is highlighted.

Declaration
public string TextSearchHighlight { get; set; }
Property Value
Type Description
System.String

TextSearchStart

Triggers an event when the text search is started.

Declaration
public string TextSearchStart { get; set; }
Property Value
Type Description
System.String

TextSelectionEnd

Triggers an event when the text selection is finished.

Declaration
public string TextSelectionEnd { get; set; }
Property Value
Type Description
System.String

TextSelectionStart

Triggers an event when the text selection is started.

Declaration
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
public string ThumbnailClick { get; set; }
Property Value
Type Description
System.String

TileRenderingSettings

Defines the tile rendering settings.

Declaration
public object TileRenderingSettings { get; set; }
Property Value
Type Description
System.Object

ToolbarSettings

Defines the settings of the PdfViewer toolbar.

Declaration
public PdfViewerToolbarSettings ToolbarSettings { get; set; }
Property Value
Type Description
PdfViewerToolbarSettings

UnderlineSettings

Defines the settings of underline annotation.

Declaration
public PdfViewerUnderlineSettings UnderlineSettings { get; set; }
Property Value
Type Description
PdfViewerUnderlineSettings

ValidateFormFields

Triggers when validation is failed.

Declaration
public string ValidateFormFields { get; set; }
Property Value
Type Description
System.String

VolumeSettings

Defines the settings of volume annotation.

Declaration
public PdfViewerVolumeSettings VolumeSettings { get; set; }
Property Value
Type Description
PdfViewerVolumeSettings

Width

Defines the scrollable width of the PdfViewer control.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

ZoomChange

Triggers when there is change in the magnification value.

Declaration
public string ZoomChange { get; set; }
Property Value
Type Description
System.String

ZoomMode

Specifies the rendering mode in the PDF Viewer.

Declaration
public ZoomMode ZoomMode { get; set; }
Property Value
Type Description
ZoomMode

ZoomValue

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

Declaration
public double ZoomValue { get; set; }
Property Value
Type Description
System.Double