Class PdfViewer

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

PdfViewer

Namespace: Syncfusion.EJ2.PdfViewer

Assembly: Syncfusion.EJ2.dll

Syntax

public class PdfViewer : EJTagHelper

Constructors

PdfViewer()

Declaration

public PdfViewer()

Properties

AddSignature

Triggers when a signature is added to a page of a PDF document.

Declaration

public string AddSignature { get; set; }

Property Value

Type	Description
System.String	The default value is null

AjaxRequestFailed

Triggers when the AJAX request is failed.

Declaration

public string AjaxRequestFailed { get; set; }

Property Value

Type	Description
System.String	The default value is null

AjaxRequestInitiate

Triggers before the data is sent to the server.

Declaration

public string AjaxRequestInitiate { get; set; }

Property Value

Type	Description
System.String	The default value is null

AjaxRequestSettings

Defines the ajax Request settings of the PDF Viewer.

Declaration

public PdfViewerAjaxRequestSettings AjaxRequestSettings { get; set; }

Property Value

Type	Description
PdfViewerAjaxRequestSettings	The default value is null

AjaxRequestSuccess

Triggers on successful AJAX request.

Declaration

public string AjaxRequestSuccess { get; set; }

Property Value

Type	Description
System.String	The default value is null

AnnotationAdd

Triggers when an annotation is added to a PDF document's page.

Declaration

public string AnnotationAdd { get; set; }

Property Value

Type	Description
System.String	The default value is null

AnnotationDoubleClick

Triggers when the annotation is double clicked.

Declaration

public string AnnotationDoubleClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

AnnotationMouseLeave

Triggers when the user mouse moves away from the annotation object.

Declaration

public string AnnotationMouseLeave { get; set; }

Property Value

Type	Description
System.String	The default value is null

AnnotationMouseover

Triggers when the mouse is moved over the annotation object.

Declaration

public string AnnotationMouseover { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is null

AnnotationMoving

Triggers while moving an annotation.

Declaration

public string AnnotationMoving { get; set; }

Property Value

Type	Description
System.String	The default value is null

AnnotationPropertiesChange

Triggers when the annotation's property is modified on a PDF document page.

Declaration

public string AnnotationPropertiesChange { get; set; }

Property Value

Type	Description
System.String	The default value is null

AnnotationRemove

Triggers when an annotation is removed from a PDF document's page.

Declaration

public string AnnotationRemove { get; set; }

Property Value

Type	Description
System.String	The default value is null

AnnotationResize

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

Declaration

public string AnnotationResize { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is null

AnnotationSelectorSettings

Defines the settings of annotation selector.

Declaration

public PdfViewerAnnotationSelectorSettings AnnotationSelectorSettings { get; set; }

Property Value

Type	Description
PdfViewerAnnotationSelectorSettings	The default value is null

AnnotationSettings

Defines the settings of the annotations.

Declaration

public PdfViewerAnnotationSettings AnnotationSettings { get; set; }

Property Value

Type	Description
PdfViewerAnnotationSettings	The default value is null

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	The default value is null

AreaSettings

Defines the settings of area annotation.

Declaration

public PdfViewerAreaSettings AreaSettings { get; set; }

Property Value

Type	Description
PdfViewerAreaSettings	The default value is null

ArrowSettings

Defines the settings of arrow annotation.

Declaration

public PdfViewerArrowSettings ArrowSettings { get; set; }

Property Value

Type	Description
PdfViewerArrowSettings	The default value is null

BeforeAddFreeText

Triggers before adding a text in the freeText annotation.

Declaration

public string BeforeAddFreeText { get; set; }

Property Value

Type	Description
System.String	The default value is null

BookmarkClick

Triggers when the bookmark is clicked in the PDF Viewer's bookmark panel.

Declaration

public string BookmarkClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

ButtonFieldClick

Triggers when the button is clicked.

Declaration

public string ButtonFieldClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

CheckBoxFieldSettings

Get or set the check box field settings.

Declaration

public PdfViewerCheckBoxFieldSettings CheckBoxFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerCheckBoxFieldSettings	The default value is null

CircleSettings

Defines the settings of circle annotation.

Declaration

public PdfViewerCircleSettings CircleSettings { get; set; }

Property Value

Type	Description
PdfViewerCircleSettings	The default value is null

CommandManager

Defines a set of custom commands and binds them with a set of desired key gestures.

Declaration

public object CommandManager { get; set; }

Property Value

Type	Description
System.Object	The default value is null

CommentAdd

Triggers when a comment for the annotation is added to the comment panel.

Declaration

public string CommentAdd { get; set; }

Property Value

Type	Description
System.String	The default value is null

CommentDelete

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

Declaration

public string CommentDelete { get; set; }

Property Value

Type	Description
System.String	The default value is null

CommentEdit

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

Declaration

public string CommentEdit { get; set; }

Property Value

Type	Description
System.String	The default value is null

CommentSelect

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

Declaration

public string CommentSelect { get; set; }

Property Value

Type	Description
System.String	The default value is null

CommentStatusChanged

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

Declaration

public string CommentStatusChanged { get; set; }

Property Value

Type	Description
System.String	The default value is null

ContextMenuOption

Specifies the state of the ContextMenu in the PDF document.

Declaration

public ContextMenuAction ContextMenuOption { get; set; }

Property Value

Type	Description
ContextMenuAction	The default value is ContextMenuAction.RightClick

ContextMenuSettings

Defines the context menu settings.

Declaration

public PdfViewerContextMenuSettings ContextMenuSettings { get; set; }

Property Value

Type	Description
PdfViewerContextMenuSettings	The default value is null

Created

Triggers during the creation of the PDF viewer component.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is 0

CustomContextMenuBeforeOpen

Fires before the custom context menu option is opened.

Declaration

public string CustomContextMenuBeforeOpen { get; set; }

Property Value

Type	Description
System.String	The default value is null

CustomContextMenuSelect

Fires when a custom context menu option is selected.

Declaration

public string CustomContextMenuSelect { get; set; }

Property Value

Type	Description
System.String	The default value is null

CustomFonts

Specifies a collection of font names as strings. These fonts must be located in the resourceUrl folder.

Declaration

public string[] CustomFonts { get; set; }

Property Value

Type	Description
System.String[]	The default value is null

CustomStamp

Defines the stamp items of the PDF Viewer.

Declaration

public PdfViewerCustomStamp CustomStamp { get; set; }

Property Value

Type	Description
PdfViewerCustomStamp	The default value is null

CustomStampSettings

Defines the settings of customStamp annotation.

Declaration

public PdfViewerCustomStampSettings CustomStampSettings { get; set; }

Property Value

Type	Description
PdfViewerCustomStampSettings	The default value is null

DateTimeFormat

Customize desired date and time format

Declaration

public string DateTimeFormat { get; set; }

Property Value

Type	Description
System.String	The default value is null

DesignerMode

Enable or disable the interaction of form fields in the PDF Viewer.

Declaration

public bool DesignerMode { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

DisableContextMenuItems

Disables the menu items in the context menu.

Declaration

public object DisableContextMenuItems { get; set; }

Property Value

Type	Description
System.Object	The default value is null

DistanceSettings

Defines the settings of distance annotation.

Declaration

public PdfViewerDistanceSettings DistanceSettings { get; set; }

Property Value

Type	Description
PdfViewerDistanceSettings	The default value is null

DocumentLoad

Triggers while loading document into PDF viewer.

Declaration

public string DocumentLoad { get; set; }

Property Value

Type	Description
System.String	The default value is null

DocumentLoadFailed

Triggers while document loading failed in PdfViewer.

Declaration

public string DocumentLoadFailed { get; set; }

Property Value

Type	Description
System.String	The default value is null

DocumentPath

Sets the PDF document path for initial loading.

Declaration

public string DocumentPath { get; set; }

Property Value

Type	Description
System.String	The default value is null

DocumentUnload

Triggers while closing the document.

Declaration

public string DocumentUnload { get; set; }

Property Value

Type	Description
System.String	The default value is null

DownloadEnd

Triggers when the download actions are completed.

Declaration

public string DownloadEnd { get; set; }

Property Value

Type	Description
System.String	The default value is null

DownloadFileName

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

Declaration

public string DownloadFileName { get; set; }

Property Value

Type	Description
System.String	The default value is null

DownloadStart

Triggers when the download action is initiated.

Declaration

public string DownloadStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

DropdownFieldSettings

Get or set the dropdown field settings.

Declaration

public PdfViewerDropdownFieldSettings DropdownFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerDropdownFieldSettings	The default value is null

EnableAccessibilityTags

Determines whether accessibility tags are enabled or disabled. Accessibility tags can help make web content more accessible to users with disabilities.

Declaration

public bool EnableAccessibilityTags { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableAnnotation

Enable or disable the annotation in the PDF Viewer.

Declaration

public bool EnableAnnotation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is true

EnableAutoComplete

Enable or disables the auto complete option in form documents.

Declaration

public bool EnableAutoComplete { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableBookmark

Enables or disables the bookmark view in the PDF viewer

Declaration

public bool EnableBookmark { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableBookmarkStyles

Enables or disables the bookmark styles in the PDF viewer

Declaration

public bool EnableBookmarkStyles { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableCommentPanel

Enable or disables the Comment Panel of PdfViewer.

Declaration

public bool EnableCommentPanel { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableDesktopMode

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

Declaration

public bool EnableDesktopMode { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableDownload

Enable or disables the download option of PdfViewer.

Declaration

public bool EnableDownload { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableFormDesigner

Show or hide the form designer tool in the main toolbar of the PDF Viewer.

Declaration

public bool EnableFormDesigner { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is true

EnableFormFields

Enable or disable the form fields in the PDF Viewer.

Declaration

public bool EnableFormFields { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableFormFieldsValidation

Enable or disable the form fields validation.

Declaration

public bool EnableFormFieldsValidation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableFreeText

Enable or disable the free text annotation in the PDF Viewer.

Declaration

public bool EnableFreeText { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableHandwrittenSignature

Enables or disables the handwritten signature in PDF document.

Declaration

public bool EnableHandwrittenSignature { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableHyperlink

Enables or disables the hyperlinks in PDF document.

Declaration

public bool EnableHyperlink { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableImportAnnotationMeasurement

Enable or disable the customization of measure values in PDF Viewer.

Declaration

public bool EnableImportAnnotationMeasurement { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is true

EnableLocalStorage

Enable or disable session storage for PDF Viewer data. When true, the PDF Viewer stores data in an internal collection instead of session storage. When false, the default session storage mechanism is used.

Declaration

public bool EnableLocalStorage { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableMagnification

Enable or disable the Magnification module of PDF Viewer.

Declaration

public bool EnableMagnification { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableMeasureAnnotation

Enable or disable the calibrate annotation in the PDF Viewer.

Declaration

public bool EnableMeasureAnnotation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is false

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	The default value is false

EnableNavigation

Enable or disable the Navigation module of PDF Viewer.

Declaration

public bool EnableNavigation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableNavigationToolbar

Enable or disables the Navigation toolbar of PdfViewer.

Declaration

public bool EnableNavigationToolbar { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnablePageOrganizer

Enable or disable the page organizer in the PDF Viewer.

Declaration

public bool EnablePageOrganizer { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnablePersistence

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

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnablePinchZoom

Enable or disable the pinch zoom option in the PDF Viewer.

Declaration

public bool EnablePinchZoom { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnablePrint

Enable or disables the print option of PdfViewer.

Declaration

public bool EnablePrint { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is true

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableShapeAnnotation

Enable or disable the shape annotation in the PDF Viewer.

Declaration

public bool EnableShapeAnnotation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableShapeLabel

Enable or disable the Label for shapeAnnotations of PDF Viewer.

Declaration

public bool EnableShapeLabel { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableStampAnnotations

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

Declaration

public bool EnableStampAnnotations { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableStickyNotesAnnotation

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

Declaration

public bool EnableStickyNotesAnnotation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableTextMarkupAnnotation

Enable or disable the text markup annotation in the PDF Viewer.

Declaration

public bool EnableTextMarkupAnnotation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is false

EnableTextSearch

Enable or disable the text search in the PDF Viewer.

Declaration

public bool EnableTextSearch { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableTextSelection

Enable or disable the text selection in the PDF Viewer.

Declaration

public bool EnableTextSelection { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableThumbnail

Enables or disables the thumbnail view in the PDF viewer

Declaration

public bool EnableThumbnail { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableToolbar

Enable or disables the toolbar of PdfViewer.

Declaration

public bool EnableToolbar { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableZoomOptimization

Enable or disable the zoom optimization mode in PDF Viewer.

Declaration

public bool EnableZoomOptimization { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is null

ExportFailed

Triggers when the annotations export in a PDF document fails.

Declaration

public string ExportFailed { get; set; }

Property Value

Type	Description
System.String	The default value is null

ExportStart

Triggers when an exported annotation started in the PDF Viewer.

Declaration

public string ExportStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

ExportSuccess

Triggers when the annotations in a PDF document are successfully exported.

Declaration

public string ExportSuccess { get; set; }

Property Value

Type	Description
System.String	The default value is null

ExtractTextCompleted

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

Declaration

public string ExtractTextCompleted { get; set; }

Property Value

Type	Description
System.String	The default value is null

ExtractTextOption

Enables different levels of extract text for the Standalone PDF Viewer. The choice of extractTextCompleted determines the content of the textData.

Declaration

public ExtractTextOption ExtractTextOption { get; set; }

Property Value

Type	Description
ExtractTextOption	The default value is ExtractTextOption.TextAndBounds

FormFieldAdd

Triggers when a form field is added.

Declaration

public string FormFieldAdd { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldClick

Triggers when the form field is selected.

Declaration

public string FormFieldClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is null

FormFieldDoubleClick

Triggers when the form field is double-clicked.

Declaration

public string FormFieldDoubleClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldFocusOut

Triggers when focus out from the form fields.

Declaration

public string FormFieldFocusOut { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldMouseLeave

Triggers when the mouse cursor leaves the form field.

Declaration

public string FormFieldMouseLeave { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldMouseover

Triggers when the mouse cursor is over a form field.

Declaration

public string FormFieldMouseover { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldMove

Triggers when a form field is moved.

Declaration

public string FormFieldMove { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldPropertiesChange

Triggers when a property of form field is changed.

Declaration

public string FormFieldPropertiesChange { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldRemove

Triggers when a form field is removed.

Declaration

public string FormFieldRemove { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldResize

Triggers when a form field is resized.

Declaration

public string FormFieldResize { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldSelect

Triggers when a form field is selected.

Declaration

public string FormFieldSelect { get; set; }

Property Value

Type	Description
System.String	The default value is null

FormFieldUnselect

Triggers when a form field is unselected.

Declaration

public string FormFieldUnselect { get; set; }

Property Value

Type	Description
System.String	The default value is null

FreeTextSettings

Defines the settings of free text annotation.

Declaration

public PdfViewerFreeTextSettings FreeTextSettings { get; set; }

Property Value

Type	Description
PdfViewerFreeTextSettings	The default value is null

HandWrittenSignatureSettings

Defines the settings of handWrittenSignature.

Declaration

public PdfViewerHandWrittenSignatureSettings HandWrittenSignatureSettings { get; set; }

Property Value

Type	Description
PdfViewerHandWrittenSignatureSettings	The default value is null

Height

Defines the scrollable height of the PdfViewer control.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

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	The default value is false

HighlightSettings

Defines the settings of highlight annotation.

Declaration

public PdfViewerHighlightSettings HighlightSettings { get; set; }

Property Value

Type	Description
PdfViewerHighlightSettings	The default value is null

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
System.Object

HyperlinkClick

Triggers when a hyperlink in a PDF document is clicked.

Declaration

public string HyperlinkClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

HyperlinkMouseOver

Triggers when hyperlink in a PDF document is hovered.

Declaration

public string HyperlinkMouseOver { get; set; }

Property Value

Type	Description
System.String	The default value is null

HyperlinkOpenState

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

Declaration

public LinkTarget HyperlinkOpenState { get; set; }

Property Value

Type	Description
LinkTarget	The default value is LinkTarget.CurrentTab

ImportFailed

Triggers when the annotations imports in a PDF document fails.

Declaration

public string ImportFailed { get; set; }

Property Value

Type	Description
System.String	The default value is null

ImportStart

Triggers when an imported annotation started to appear in the PDF document.

Declaration

public string ImportStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

ImportSuccess

Triggers when the annotations in a PDF document are successfully imported.

Declaration

public string ImportSuccess { get; set; }

Property Value

Type	Description
System.String	The default value is null

InitialDialogSettings

Get or set the signature dialog settings for initial field.

Declaration

public object InitialDialogSettings { get; set; }

Property Value

Type	Description
System.Object	The default value is null

InitialFieldSettings

Get or set the initial field settings.

Declaration

public PdfViewerInitialFieldSettings InitialFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerInitialFieldSettings	The default value is null

InitialRenderPages

Initially renders the first N pages of the PDF document when the document is loaded.

Declaration

public double InitialRenderPages { get; set; }

Property Value

Type	Description
System.Double	The default value is 2

InkAnnotationSettings

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

Declaration

public PdfViewerInkAnnotationSettings InkAnnotationSettings { get; set; }

Property Value

Type	Description
PdfViewerInkAnnotationSettings	The default value is null

InteractionMode

Sets the interaction mode of the PDF Viewer.

Declaration

public InteractionMode InteractionMode { get; set; }

Property Value

Type	Description
InteractionMode	The default value is InteractionMode.TextSelection

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	The default value is false

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	The default value is false

IsBookmarkPanelOpen

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

Declaration

public bool IsBookmarkPanelOpen { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

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	The default value is false

IsDocumentEdited

Checks whether the PDF document is edited.

Declaration

public bool IsDocumentEdited { get; set; }

Property Value

Type	Description
System.Boolean	The default value is null

IsExtractText

Enable or disable the text extract from the PDF viewer.

Declaration

public bool IsExtractText { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IsFormDesignerToolbarVisible

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 IsFormDesignerToolbarVisible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IsFormFieldDocument

Enable if the PDF document contains form fields.

Declaration

public bool IsFormFieldDocument { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IsMaintainSelection

Maintain the selection of text markup annotation.

Declaration

public bool IsMaintainSelection { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IsPageOrganizerOpen

Specifies whether the page organizer dialog will be displayed upon the initial document loading in the PDF Viewer.

Declaration

public bool IsPageOrganizerOpen { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

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	The default value is false

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	The default value is false

IsValidFreeText

Checks if the freeText value is valid or not.

Declaration

public bool IsValidFreeText { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

KeyboardCustomCommands

Triggers when the customized keyboard command keys are pressed.

Declaration

public string KeyboardCustomCommands { get; set; }

Property Value

Type	Description
System.String	The default value is null

LineSettings

Defines the settings of line annotation.

Declaration

public PdfViewerLineSettings LineSettings { get; set; }

Property Value

Type	Description
PdfViewerLineSettings	The default value is null

ListBoxFieldSettings

Get or set the listbox field settings.

Declaration

public PdfViewerListBoxFieldSettings ListBoxFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerListBoxFieldSettings	The default value is null

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	The default value is ""

MaxZoom

Specifies the maximum allowable zoom level for the control, with a default value of 400.

Declaration

public double MaxZoom { get; set; }

Property Value

Type	Description
System.Double	The default value is 400

MeasurementSettings

Defines the settings of measurement annotation.

Declaration

public PdfViewerMeasurementSettings MeasurementSettings { get; set; }

Property Value

Type	Description
PdfViewerMeasurementSettings	The default value is null

MinZoom

Specifies the minimum acceptable zoom level for the control, with a default value of 10.

Declaration

public double MinZoom { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

MoveSignature

Triggers when a signature is moved across the page of a PDF document.

Declaration

public string MoveSignature { get; set; }

Property Value

Type	Description
System.String	The default value is null

PageChange

Triggers when there is change in current page number.

Declaration

public string PageChange { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is null

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	The default value is 0

PageMouseover

Triggers when moving the mouse over the page.

Declaration

public string PageMouseover { get; set; }

Property Value

Type	Description
System.String	The default value is null

PageOrganizerSaveAs

Triggers when the page organizer save as triggered.

Declaration

public string PageOrganizerSaveAs { get; set; }

Property Value

Type	Description
System.String	The default value is null

PageOrganizerSettings

This property allows for control over various page management functionalities within the PDF Viewer. By setting it to true, users will be able to delete, insert, rotate pages, rearrange pages. Conversely, setting it to false will disable these actions.

Declaration

public object PageOrganizerSettings { get; set; }

Property Value

Type	Description
System.Object	The default value is null

PageRenderComplete

Triggers upon completion of page rendering.

Declaration

public string PageRenderComplete { get; set; }

Property Value

Type	Description
System.String	The default value is null

PageRenderInitiate

Triggers upon the initiation of page rendering.

Declaration

public string PageRenderInitiate { get; set; }

Property Value

Type	Description
System.String	The default value is null

PasswordFieldSettings

Get or set the password field settings.

Declaration

public PdfViewerPasswordFieldSettings PasswordFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerPasswordFieldSettings	The default value is null

PerimeterSettings

Defines the settings of perimeter annotation.

Declaration

public PdfViewerPerimeterSettings PerimeterSettings { get; set; }

Property Value

Type	Description
PdfViewerPerimeterSettings	The default value is null

PolygonSettings

Defines the settings of polygon annotation.

Declaration

public PdfViewerPolygonSettings PolygonSettings { get; set; }

Property Value

Type	Description
PdfViewerPolygonSettings	The default value is null

PrintEnd

Triggers when the print actions are completed.

Declaration

public string PrintEnd { get; set; }

Property Value

Type	Description
System.String	The default value is null

PrintMode

Specifies the print mode in the PDF Viewer.

Declaration

public PrintMode PrintMode { get; set; }

Property Value

Type	Description
PrintMode	The default value is PrintMode.Default

PrintScaleFactor

Specifies the document printing quality. The default printing quality is set to 1.0. This limit varies from 0.5 to 5.0. If an invalid value is specified, the default value of 1.0 will be used. For documents with smaller page dimensions, a higher print quality is recommended.

Declaration

public double PrintScaleFactor { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

PrintStart

Triggers when the print action is initiated.

Declaration

public string PrintStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

RadioButtonFieldSettings

Get or set the radio button field settings.

Declaration

public PdfViewerRadioButtonFieldSettings RadioButtonFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerRadioButtonFieldSettings	The default value is null

RadiusSettings

Defines the settings of radius annotation.

Declaration

public PdfViewerRadiusSettings RadiusSettings { get; set; }

Property Value

Type	Description
PdfViewerRadiusSettings	The default value is null

RectangleSettings

Defines the settings of rectangle annotation.

Declaration

public PdfViewerRectangleSettings RectangleSettings { get; set; }

Property Value

Type	Description
PdfViewerRectangleSettings	The default value is null

RemoveSignature

Triggers when the signature is removed from the page of a PDF document.

Declaration

public string RemoveSignature { get; set; }

Property Value

Type	Description
System.String	The default value is null

ResizeSignature

Triggers when the signature is resized and placed on a page of a PDF document.

Declaration

public string ResizeSignature { get; set; }

Property Value

Type	Description
System.String	The default value is null

ResourcesLoaded

Triggers after loading the Pdfium resources.

Declaration

public string ResourcesLoaded { get; set; }

Property Value

Type	Description
System.String	The default value is null

ResourceUrl

Set the resource URL for assets or the public directory. The standalone PDF Viewer will load its custom resources from this URL.

Declaration

public string ResourceUrl { get; set; }

Property Value

Type	Description
System.String	The default value is ""

RestrictZoomRequest

restrict zoom request.

Declaration

public bool RestrictZoomRequest { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

RetryCount

Specifies the retry count for the failed requests.

Declaration

public double RetryCount { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

RetryStatusCodes

Specifies the response status codes for retrying a failed request with a "3xx", "4xx", or "5xx" response status code. The value can have multiple values, such as [500, 401, 400], and the default value is 500.

Declaration

public double[] RetryStatusCodes { get; set; }

Property Value

Type	Description
System.Double[]	The default value is null

RetryTimeout

Gets or sets the timeout for retries in seconds.

Declaration

public double RetryTimeout { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

ScrollSettings

Defines the scroll settings.

Declaration

public PdfViewerScrollSettings ScrollSettings { get; set; }

Property Value

Type	Description
PdfViewerScrollSettings	The default value is null

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	The default value is null

ServerActionSettings

Defines the settings of the PDF Viewer service.

Declaration

public PdfViewerServerActionSettings ServerActionSettings { get; set; }

Property Value

Type	Description
PdfViewerServerActionSettings	The default value is null

ServiceUrl

Defines the service url of the PdfViewer control.

Declaration

public string ServiceUrl { get; set; }

Property Value

Type	Description
System.String	The default value is null

ShapeLabelSettings

Defines the settings of shape label.

Declaration

public PdfViewerShapeLabelSettings ShapeLabelSettings { get; set; }

Property Value

Type	Description
PdfViewerShapeLabelSettings	The default value is null

ShowDigitalSignatureAppearance

Show or hide the digital signature appearance in the document.

Declaration

public bool ShowDigitalSignatureAppearance { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is true

SignatureDialogSettings

Get or set the signature dialog settings for signature field.

Declaration

public PdfViewerSignatureDialogSettings SignatureDialogSettings { get; set; }

Property Value

Type	Description
PdfViewerSignatureDialogSettings	The default value is null

SignatureFieldSettings

Get or set the signature field settings.

Declaration

public PdfViewerSignatureFieldSettings SignatureFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerSignatureFieldSettings	The default value is null

SignatureFitMode

Specifies the signature mode in the PDF Viewer.

Declaration

public SignatureFitMode SignatureFitMode { get; set; }

Property Value

Type	Description
SignatureFitMode	The default value is SignatureFitMode.Default

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	The default value is null

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	The default value is null

SignatureUnselect

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

Declaration

public string SignatureUnselect { get; set; }

Property Value

Type	Description
System.String	The default value is null

StampSettings

Defines the settings of stamp annotation.

Declaration

public PdfViewerStampSettings StampSettings { get; set; }

Property Value

Type	Description
PdfViewerStampSettings	The default value is null

StickyNotesSettings

Defines the settings of stickyNotes annotation.

Declaration

public PdfViewerStickyNotesSettings StickyNotesSettings { get; set; }

Property Value

Type	Description
PdfViewerStickyNotesSettings	The default value is null

StrikethroughSettings

Defines the settings of strikethrough annotation.

Declaration

public PdfViewerStrikethroughSettings StrikethroughSettings { get; set; }

Property Value

Type	Description
PdfViewerStrikethroughSettings	The default value is null

TextFieldSettings

Get or set the text field settings.

Declaration

public PdfViewerTextFieldSettings TextFieldSettings { get; set; }

Property Value

Type	Description
PdfViewerTextFieldSettings	The default value is null

TextSearchColorSettings

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

Declaration

public PdfViewerTextSearchColorSettings TextSearchColorSettings { get; set; }

Property Value

Type	Description
PdfViewerTextSearchColorSettings	The default value is null

TextSearchComplete

Triggers when the text search is completed.

Declaration

public string TextSearchComplete { get; set; }

Property Value

Type	Description
System.String	The default value is null

TextSearchHighlight

Triggers when the text search text is highlighted.

Declaration

public string TextSearchHighlight { get; set; }

Property Value

Type	Description
System.String	The default value is null

TextSearchStart

Triggers when the text search is initiated.

Declaration

public string TextSearchStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

TextSelectionEnd

Triggers when the text selection is complete.

Declaration

public string TextSelectionEnd { get; set; }

Property Value

Type	Description
System.String	The default value is null

TextSelectionStart

Triggers when the text selection is initiated.

Declaration

public string TextSelectionStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

ThumbnailClick

Triggers when the thumbnail in the PDF Viewer's thumbnail panel is clicked.

Declaration

public string ThumbnailClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

TileRenderingSettings

Defines the tile rendering settings.

Declaration

public PdfViewerTileRenderingSettings TileRenderingSettings { get; set; }

Property Value

Type	Description
PdfViewerTileRenderingSettings	The default value is null

ToolbarClick

Triggers when custom toolbar item is clicked.

Declaration

public string ToolbarClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

ToolbarSettings

Defines the settings of the PDF Viewer toolbar.

Declaration

public PdfViewerToolbarSettings ToolbarSettings { get; set; }

Property Value

Type	Description
PdfViewerToolbarSettings	The default value is null

UnderlineSettings

Defines the settings of underline annotation.

Declaration

public PdfViewerUnderlineSettings UnderlineSettings { get; set; }

Property Value

Type	Description
PdfViewerUnderlineSettings	The default value is null

ValidateFormFields

Triggers when validation is failed.

Declaration

public string ValidateFormFields { get; set; }

Property Value

Type	Description
System.String	The default value is null

VolumeSettings

Defines the settings of volume annotation.

Declaration

public PdfViewerVolumeSettings VolumeSettings { get; set; }

Property Value

Type	Description
PdfViewerVolumeSettings	The default value is null

Width

Defines the scrollable width of the PdfViewer control.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

ZoomChange

Triggers When the magnification value changes.

Declaration

public string ZoomChange { get; set; }

Property Value

Type	Description
System.String	The default value is null

ZoomMode

Specifies the rendering mode in the PDF Viewer.

Declaration

public ZoomMode ZoomMode { get; set; }

Property Value

Type	Description
ZoomMode	The default value is ZoomMode.Default

ZoomValue

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

Declaration

public double ZoomValue { get; set; }

Property Value

Type	Description
System.Double	The default value is 0