ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfViewerBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PdfViewerBuilder

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

    Constructors

    PdfViewerBuilder()

    Declaration
    public PdfViewerBuilder()

    PdfViewerBuilder(PdfViewer)

    Declaration
    public PdfViewerBuilder(PdfViewer model)
    Parameters
    Type Name Description
    PdfViewer model

    Fields

    model

    Declaration
    public PdfViewer model
    Field Value
    Type Description
    PdfViewer

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

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

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    AddSignature(String)

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

    Declaration
    public PdfViewerBuilder AddSignature(string addSignature)
    Parameters
    Type Name Description
    System.String addSignature
    Returns
    Type Description
    PdfViewerBuilder

    AjaxRequestFailed(String)

    Triggers when the AJAX request is failed.

    Declaration
    public PdfViewerBuilder AjaxRequestFailed(string ajaxRequestFailed)
    Parameters
    Type Name Description
    System.String ajaxRequestFailed
    Returns
    Type Description
    PdfViewerBuilder

    AjaxRequestInitiate(String)

    Triggers before the data send in to the server.

    Declaration
    public PdfViewerBuilder AjaxRequestInitiate(string ajaxRequestInitiate)
    Parameters
    Type Name Description
    System.String ajaxRequestInitiate
    Returns
    Type Description
    PdfViewerBuilder

    AjaxRequestSettings(PdfViewerAjaxRequestSettings)

    Defines the ajax Request settings of the PdfViewer.

    Declaration
    public PdfViewerBuilder AjaxRequestSettings(PdfViewerAjaxRequestSettings ajaxRequestSettings)
    Parameters
    Type Name Description
    PdfViewerAjaxRequestSettings ajaxRequestSettings
    Returns
    Type Description
    PdfViewerBuilder

    AjaxRequestSettings(Action<PdfViewerAjaxRequestSettingsBuilder>)

    Declaration
    public PdfViewerBuilder AjaxRequestSettings(Action<PdfViewerAjaxRequestSettingsBuilder> ajaxRequestSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerAjaxRequestSettingsBuilder> ajaxRequestSettings
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationAdd(String)

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

    Declaration
    public PdfViewerBuilder AnnotationAdd(string annotationAdd)
    Parameters
    Type Name Description
    System.String annotationAdd
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationDoubleClick(String)

    Triggers an event when the annotation is double click.

    Declaration
    public PdfViewerBuilder AnnotationDoubleClick(string annotationDoubleClick)
    Parameters
    Type Name Description
    System.String annotationDoubleClick
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationMouseLeave(String)

    Triggers when mouse over the annotation object.

    Declaration
    public PdfViewerBuilder AnnotationMouseLeave(string annotationMouseLeave)
    Parameters
    Type Name Description
    System.String annotationMouseLeave
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationMouseover(String)

    Triggers when mouse over the annotation object.

    Declaration
    public PdfViewerBuilder AnnotationMouseover(string annotationMouseover)
    Parameters
    Type Name Description
    System.String annotationMouseover
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationMove(String)

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

    Declaration
    public PdfViewerBuilder AnnotationMove(string annotationMove)
    Parameters
    Type Name Description
    System.String annotationMove
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationPropertiesChange(String)

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

    Declaration
    public PdfViewerBuilder AnnotationPropertiesChange(string annotationPropertiesChange)
    Parameters
    Type Name Description
    System.String annotationPropertiesChange
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationRemove(String)

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

    Declaration
    public PdfViewerBuilder AnnotationRemove(string annotationRemove)
    Parameters
    Type Name Description
    System.String annotationRemove
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationResize(String)

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

    Declaration
    public PdfViewerBuilder AnnotationResize(string annotationResize)
    Parameters
    Type Name Description
    System.String annotationResize
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationSelect(String)

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

    Declaration
    public PdfViewerBuilder AnnotationSelect(string annotationSelect)
    Parameters
    Type Name Description
    System.String annotationSelect
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationSelectorSettings(PdfViewerAnnotationSelectorSettings)

    Defines the settings of annotation selector.

    Declaration
    public PdfViewerBuilder AnnotationSelectorSettings(PdfViewerAnnotationSelectorSettings annotationSelectorSettings)
    Parameters
    Type Name Description
    PdfViewerAnnotationSelectorSettings annotationSelectorSettings
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationSelectorSettings(Action<PdfViewerAnnotationSelectorSettingsBuilder>)

    Declaration
    public PdfViewerBuilder AnnotationSelectorSettings(Action<PdfViewerAnnotationSelectorSettingsBuilder> annotationSelectorSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerAnnotationSelectorSettingsBuilder> annotationSelectorSettings
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationSettings(Object)

    Defines the settings of the annotations.

    Declaration
    public PdfViewerBuilder AnnotationSettings(object annotationSettings)
    Parameters
    Type Name Description
    System.Object annotationSettings
    Returns
    Type Description
    PdfViewerBuilder

    AnnotationUnSelect(String)

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

    Declaration
    public PdfViewerBuilder AnnotationUnSelect(string annotationUnSelect)
    Parameters
    Type Name Description
    System.String annotationUnSelect
    Returns
    Type Description
    PdfViewerBuilder

    AreaSettings(PdfViewerAreaSettings)

    Defines the settings of area annotation.

    Declaration
    public PdfViewerBuilder AreaSettings(PdfViewerAreaSettings areaSettings)
    Parameters
    Type Name Description
    PdfViewerAreaSettings areaSettings
    Returns
    Type Description
    PdfViewerBuilder

    AreaSettings(Action<PdfViewerAreaSettingsBuilder>)

    Declaration
    public PdfViewerBuilder AreaSettings(Action<PdfViewerAreaSettingsBuilder> areaSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerAreaSettingsBuilder> areaSettings
    Returns
    Type Description
    PdfViewerBuilder

    ArrowSettings(PdfViewerArrowSettings)

    Defines the settings of arrow annotation.

    Declaration
    public PdfViewerBuilder ArrowSettings(PdfViewerArrowSettings arrowSettings)
    Parameters
    Type Name Description
    PdfViewerArrowSettings arrowSettings
    Returns
    Type Description
    PdfViewerBuilder

    ArrowSettings(Action<PdfViewerArrowSettingsBuilder>)

    Declaration
    public PdfViewerBuilder ArrowSettings(Action<PdfViewerArrowSettingsBuilder> arrowSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerArrowSettingsBuilder> arrowSettings
    Returns
    Type Description
    PdfViewerBuilder

    BeforeAddFreeText(String)

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

    Declaration
    public PdfViewerBuilder BeforeAddFreeText(string beforeAddFreeText)
    Parameters
    Type Name Description
    System.String beforeAddFreeText
    Returns
    Type Description
    PdfViewerBuilder

    BookmarkClick(String)

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

    Declaration
    public PdfViewerBuilder BookmarkClick(string bookmarkClick)
    Parameters
    Type Name Description
    System.String bookmarkClick
    Returns
    Type Description
    PdfViewerBuilder

    ButtonFieldClick(String)

    Triggers an event when the button is clicked.

    Declaration
    public PdfViewerBuilder ButtonFieldClick(string buttonFieldClick)
    Parameters
    Type Name Description
    System.String buttonFieldClick
    Returns
    Type Description
    PdfViewerBuilder

    CircleSettings(PdfViewerCircleSettings)

    Defines the settings of circle annotation.

    Declaration
    public PdfViewerBuilder CircleSettings(PdfViewerCircleSettings circleSettings)
    Parameters
    Type Name Description
    PdfViewerCircleSettings circleSettings
    Returns
    Type Description
    PdfViewerBuilder

    CircleSettings(Action<PdfViewerCircleSettingsBuilder>)

    Declaration
    public PdfViewerBuilder CircleSettings(Action<PdfViewerCircleSettingsBuilder> circleSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerCircleSettingsBuilder> circleSettings
    Returns
    Type Description
    PdfViewerBuilder

    CommentAdd(String)

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

    Declaration
    public PdfViewerBuilder CommentAdd(string commentAdd)
    Parameters
    Type Name Description
    System.String commentAdd
    Returns
    Type Description
    PdfViewerBuilder

    CommentDelete(String)

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

    Declaration
    public PdfViewerBuilder CommentDelete(string commentDelete)
    Parameters
    Type Name Description
    System.String commentDelete
    Returns
    Type Description
    PdfViewerBuilder

    CommentEdit(String)

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

    Declaration
    public PdfViewerBuilder CommentEdit(string commentEdit)
    Parameters
    Type Name Description
    System.String commentEdit
    Returns
    Type Description
    PdfViewerBuilder

    CommentSelect(String)

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

    Declaration
    public PdfViewerBuilder CommentSelect(string commentSelect)
    Parameters
    Type Name Description
    System.String commentSelect
    Returns
    Type Description
    PdfViewerBuilder

    CommentStatusChanged(String)

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

    Declaration
    public PdfViewerBuilder CommentStatusChanged(string commentStatusChanged)
    Parameters
    Type Name Description
    System.String commentStatusChanged
    Returns
    Type Description
    PdfViewerBuilder

    ContextMenuOption(ContextMenuAction)

    Specifies the state of the ContextMenu in the PDF document.

    Declaration
    public PdfViewerBuilder ContextMenuOption(ContextMenuAction contextMenuOption)
    Parameters
    Type Name Description
    ContextMenuAction contextMenuOption
    Returns
    Type Description
    PdfViewerBuilder

    ContextMenuSettings(Object)

    Defines the context menu settings.

    Declaration
    public PdfViewerBuilder ContextMenuSettings(object contextMenuSettings)
    Parameters
    Type Name Description
    System.Object contextMenuSettings
    Returns
    Type Description
    PdfViewerBuilder

    CurrentPageNumber(Double)

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

    Declaration
    public PdfViewerBuilder CurrentPageNumber(double currentPageNumber)
    Parameters
    Type Name Description
    System.Double currentPageNumber
    Returns
    Type Description
    PdfViewerBuilder

    CustomStamp(Object)

    Defines the stamp items of the PdfViewer.

    Declaration
    public PdfViewerBuilder CustomStamp(object customStamp)
    Parameters
    Type Name Description
    System.Object customStamp
    Returns
    Type Description
    PdfViewerBuilder

    CustomStampSettings(PdfViewerCustomStampSettings)

    Defines the settings of customStamp annotation.

    Declaration
    public PdfViewerBuilder CustomStampSettings(PdfViewerCustomStampSettings customStampSettings)
    Parameters
    Type Name Description
    PdfViewerCustomStampSettings customStampSettings
    Returns
    Type Description
    PdfViewerBuilder

    CustomStampSettings(Action<PdfViewerCustomStampSettingsBuilder>)

    Declaration
    public PdfViewerBuilder CustomStampSettings(Action<PdfViewerCustomStampSettingsBuilder> customStampSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerCustomStampSettingsBuilder> customStampSettings
    Returns
    Type Description
    PdfViewerBuilder

    DateTimeFormat(String)

    Customize desired date and time format

    Declaration
    public PdfViewerBuilder DateTimeFormat(string dateTimeFormat)
    Parameters
    Type Name Description
    System.String dateTimeFormat
    Returns
    Type Description
    PdfViewerBuilder

    DisableContextMenuItems(Object)

    enable or disable context menu Items

    Declaration
    public PdfViewerBuilder DisableContextMenuItems(object disableContextMenuItems)
    Parameters
    Type Name Description
    System.Object disableContextMenuItems
    Returns
    Type Description
    PdfViewerBuilder

    DistanceSettings(PdfViewerDistanceSettings)

    Defines the settings of distance annotation.

    Declaration
    public PdfViewerBuilder DistanceSettings(PdfViewerDistanceSettings distanceSettings)
    Parameters
    Type Name Description
    PdfViewerDistanceSettings distanceSettings
    Returns
    Type Description
    PdfViewerBuilder

    DistanceSettings(Action<PdfViewerDistanceSettingsBuilder>)

    Declaration
    public PdfViewerBuilder DistanceSettings(Action<PdfViewerDistanceSettingsBuilder> distanceSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerDistanceSettingsBuilder> distanceSettings
    Returns
    Type Description
    PdfViewerBuilder

    DocumentLoad(String)

    Triggers while loading document into PdfViewer.

    Declaration
    public PdfViewerBuilder DocumentLoad(string documentLoad)
    Parameters
    Type Name Description
    System.String documentLoad
    Returns
    Type Description
    PdfViewerBuilder

    DocumentLoadFailed(String)

    Triggers while loading document got failed in PdfViewer.

    Declaration
    public PdfViewerBuilder DocumentLoadFailed(string documentLoadFailed)
    Parameters
    Type Name Description
    System.String documentLoadFailed
    Returns
    Type Description
    PdfViewerBuilder

    DocumentPath(String)

    Sets the PDF document path for initial loading.

    Declaration
    public PdfViewerBuilder DocumentPath(string documentPath)
    Parameters
    Type Name Description
    System.String documentPath
    Returns
    Type Description
    PdfViewerBuilder

    DocumentUnload(String)

    Triggers while close the document

    Declaration
    public PdfViewerBuilder DocumentUnload(string documentUnload)
    Parameters
    Type Name Description
    System.String documentUnload
    Returns
    Type Description
    PdfViewerBuilder

    DownloadEnd(String)

    Triggers an event when the download actions is finished.

    Declaration
    public PdfViewerBuilder DownloadEnd(string downloadEnd)
    Parameters
    Type Name Description
    System.String downloadEnd
    Returns
    Type Description
    PdfViewerBuilder

    DownloadFileName(String)

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

    Declaration
    public PdfViewerBuilder DownloadFileName(string downloadFileName)
    Parameters
    Type Name Description
    System.String downloadFileName
    Returns
    Type Description
    PdfViewerBuilder

    DownloadStart(String)

    Triggers an event when the download action is started.

    Declaration
    public PdfViewerBuilder DownloadStart(string downloadStart)
    Parameters
    Type Name Description
    System.String downloadStart
    Returns
    Type Description
    PdfViewerBuilder

    EnableAnnotation(Boolean)

    Enable or disable the annotation in the Pdfviewer.

    Declaration
    public PdfViewerBuilder EnableAnnotation(bool enableAnnotation = true)
    Parameters
    Type Name Description
    System.Boolean enableAnnotation
    Returns
    Type Description
    PdfViewerBuilder

    EnableAnnotationToolbar(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableAnnotationToolbar(bool enableAnnotationToolbar = true)
    Parameters
    Type Name Description
    System.Boolean enableAnnotationToolbar
    Returns
    Type Description
    PdfViewerBuilder

    EnableAutoComplete(Boolean)

    Enable or disables the auto complete option in form documents.

    Declaration
    public PdfViewerBuilder EnableAutoComplete(bool enableAutoComplete = true)
    Parameters
    Type Name Description
    System.Boolean enableAutoComplete
    Returns
    Type Description
    PdfViewerBuilder

    EnableBookmark(Boolean)

    Enables or disables the bookmark view in the PDF viewer

    Declaration
    public PdfViewerBuilder EnableBookmark(bool enableBookmark = true)
    Parameters
    Type Name Description
    System.Boolean enableBookmark
    Returns
    Type Description
    PdfViewerBuilder

    EnableBookmarkStyles(Boolean)

    Enables or disables the bookmark styles in the PDF viewer

    Declaration
    public PdfViewerBuilder EnableBookmarkStyles(bool enableBookmarkStyles = true)
    Parameters
    Type Name Description
    System.Boolean enableBookmarkStyles
    Returns
    Type Description
    PdfViewerBuilder

    EnableCommentPanel(Boolean)

    Enable or disables the Comment Panel of PdfViewer.

    Declaration
    public PdfViewerBuilder EnableCommentPanel(bool enableCommentPanel = true)
    Parameters
    Type Name Description
    System.Boolean enableCommentPanel
    Returns
    Type Description
    PdfViewerBuilder

    EnableDesktopMode(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableDesktopMode(bool enableDesktopMode = true)
    Parameters
    Type Name Description
    System.Boolean enableDesktopMode
    Returns
    Type Description
    PdfViewerBuilder

    EnableDownload(Boolean)

    Enable or disables the download option of PdfViewer.

    Declaration
    public PdfViewerBuilder EnableDownload(bool enableDownload = true)
    Parameters
    Type Name Description
    System.Boolean enableDownload
    Returns
    Type Description
    PdfViewerBuilder

    EnableFormFields(Boolean)

    Enable or disable the form fields in the Pdfviewer.

    Declaration
    public PdfViewerBuilder EnableFormFields(bool enableFormFields = true)
    Parameters
    Type Name Description
    System.Boolean enableFormFields
    Returns
    Type Description
    PdfViewerBuilder

    EnableFormFieldsValidation(Boolean)

    Enable or disable the form fields validation.

    Declaration
    public PdfViewerBuilder EnableFormFieldsValidation(bool enableFormFieldsValidation = true)
    Parameters
    Type Name Description
    System.Boolean enableFormFieldsValidation
    Returns
    Type Description
    PdfViewerBuilder

    EnableFreeText(Boolean)

    Enable or disable the free text annotation in the Pdfviewer.

    Declaration
    public PdfViewerBuilder EnableFreeText(bool enableFreeText = true)
    Parameters
    Type Name Description
    System.Boolean enableFreeText
    Returns
    Type Description
    PdfViewerBuilder

    EnableHandwrittenSignature(Boolean)

    Enables or disables the handwritten signature in PDF document.

    Declaration
    public PdfViewerBuilder EnableHandwrittenSignature(bool enableHandwrittenSignature = true)
    Parameters
    Type Name Description
    System.Boolean enableHandwrittenSignature
    Returns
    Type Description
    PdfViewerBuilder

    EnableHyperlink(Boolean)

    Enables or disables the hyperlinks in PDF document.

    Declaration
    public PdfViewerBuilder EnableHyperlink(bool enableHyperlink = true)
    Parameters
    Type Name Description
    System.Boolean enableHyperlink
    Returns
    Type Description
    PdfViewerBuilder

    EnableImportAnnotationMeasurement(Boolean)

    Enable or disables the customization of measure values in PdfViewer.

    Declaration
    public PdfViewerBuilder EnableImportAnnotationMeasurement(bool enableImportAnnotationMeasurement = true)
    Parameters
    Type Name Description
    System.Boolean enableImportAnnotationMeasurement
    Returns
    Type Description
    PdfViewerBuilder

    EnableInkAnnotation(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableInkAnnotation(bool enableInkAnnotation = true)
    Parameters
    Type Name Description
    System.Boolean enableInkAnnotation
    Returns
    Type Description
    PdfViewerBuilder

    EnableMagnification(Boolean)

    Enable or disables the Magnification module of PdfViewer.

    Declaration
    public PdfViewerBuilder EnableMagnification(bool enableMagnification = true)
    Parameters
    Type Name Description
    System.Boolean enableMagnification
    Returns
    Type Description
    PdfViewerBuilder

    EnableMeasureAnnotation(Boolean)

    Enable or disables the calibrate annotation in the PdfViewer.

    Declaration
    public PdfViewerBuilder EnableMeasureAnnotation(bool enableMeasureAnnotation = true)
    Parameters
    Type Name Description
    System.Boolean enableMeasureAnnotation
    Returns
    Type Description
    PdfViewerBuilder

    EnableMultiLineOverlap(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableMultiLineOverlap(bool enableMultiLineOverlap = true)
    Parameters
    Type Name Description
    System.Boolean enableMultiLineOverlap
    Returns
    Type Description
    PdfViewerBuilder

    EnableMultiPageAnnotation(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableMultiPageAnnotation(bool enableMultiPageAnnotation = true)
    Parameters
    Type Name Description
    System.Boolean enableMultiPageAnnotation
    Returns
    Type Description
    PdfViewerBuilder

    EnableNavigation(Boolean)

    Enable or disables the Navigation module of PdfViewer.

    Declaration
    public PdfViewerBuilder EnableNavigation(bool enableNavigation = true)
    Parameters
    Type Name Description
    System.Boolean enableNavigation
    Returns
    Type Description
    PdfViewerBuilder

    EnableNavigationToolbar(Boolean)

    Enable or disables the Navigation toolbar of PdfViewer.

    Declaration
    public PdfViewerBuilder EnableNavigationToolbar(bool enableNavigationToolbar = true)
    Parameters
    Type Name Description
    System.Boolean enableNavigationToolbar
    Returns
    Type Description
    PdfViewerBuilder

    EnablePersistence(Boolean)

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

    Declaration
    public PdfViewerBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    PdfViewerBuilder

    EnablePinchZoom(Boolean)

    Enable or disables the Pinch zoom of PdfViewer.

    Declaration
    public PdfViewerBuilder EnablePinchZoom(bool enablePinchZoom = true)
    Parameters
    Type Name Description
    System.Boolean enablePinchZoom
    Returns
    Type Description
    PdfViewerBuilder

    EnablePrint(Boolean)

    Enable or disables the print option of PdfViewer.

    Declaration
    public PdfViewerBuilder EnablePrint(bool enablePrint = true)
    Parameters
    Type Name Description
    System.Boolean enablePrint
    Returns
    Type Description
    PdfViewerBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public PdfViewerBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    PdfViewerBuilder

    EnableShapeAnnotation(Boolean)

    Enable or disables the shape annotation in the PdfViewer.

    Declaration
    public PdfViewerBuilder EnableShapeAnnotation(bool enableShapeAnnotation = true)
    Parameters
    Type Name Description
    System.Boolean enableShapeAnnotation
    Returns
    Type Description
    PdfViewerBuilder

    EnableShapeLabel(Boolean)

    Enable or disables the Label for shapeAnnotations of PdfViewer.

    Declaration
    public PdfViewerBuilder EnableShapeLabel(bool enableShapeLabel = true)
    Parameters
    Type Name Description
    System.Boolean enableShapeLabel
    Returns
    Type Description
    PdfViewerBuilder

    EnableStampAnnotations(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableStampAnnotations(bool enableStampAnnotations = true)
    Parameters
    Type Name Description
    System.Boolean enableStampAnnotations
    Returns
    Type Description
    PdfViewerBuilder

    EnableStickyNotesAnnotation(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableStickyNotesAnnotation(bool enableStickyNotesAnnotation = true)
    Parameters
    Type Name Description
    System.Boolean enableStickyNotesAnnotation
    Returns
    Type Description
    PdfViewerBuilder

    EnableTextMarkupAnnotation(Boolean)

    Enable or disables the text markup annotation in the PdfViewer.

    Declaration
    public PdfViewerBuilder EnableTextMarkupAnnotation(bool enableTextMarkupAnnotation = true)
    Parameters
    Type Name Description
    System.Boolean enableTextMarkupAnnotation
    Returns
    Type Description
    PdfViewerBuilder

    EnableTextMarkupResizer(Boolean)

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

    Declaration
    public PdfViewerBuilder EnableTextMarkupResizer(bool enableTextMarkupResizer = true)
    Parameters
    Type Name Description
    System.Boolean enableTextMarkupResizer
    Returns
    Type Description
    PdfViewerBuilder

    EnableTextSearch(Boolean)

    Enable or disables the text search in the PdfViewer.

    Declaration
    public PdfViewerBuilder EnableTextSearch(bool enableTextSearch = true)
    Parameters
    Type Name Description
    System.Boolean enableTextSearch
    Returns
    Type Description
    PdfViewerBuilder

    EnableTextSelection(Boolean)

    Enable or disables the text selection in the PdfViewer.

    Declaration
    public PdfViewerBuilder EnableTextSelection(bool enableTextSelection = true)
    Parameters
    Type Name Description
    System.Boolean enableTextSelection
    Returns
    Type Description
    PdfViewerBuilder

    EnableThumbnail(Boolean)

    Enables or disables the thumbnail view in the PDF viewer

    Declaration
    public PdfViewerBuilder EnableThumbnail(bool enableThumbnail = true)
    Parameters
    Type Name Description
    System.Boolean enableThumbnail
    Returns
    Type Description
    PdfViewerBuilder

    EnableToolbar(Boolean)

    Enable or disables the toolbar of PdfViewer.

    Declaration
    public PdfViewerBuilder EnableToolbar(bool enableToolbar = true)
    Parameters
    Type Name Description
    System.Boolean enableToolbar
    Returns
    Type Description
    PdfViewerBuilder

    EnableZoomOptimization(Boolean)

    Enable or disable the zoom optimization mode in PDF Viewer.

    Declaration
    public PdfViewerBuilder EnableZoomOptimization(bool enableZoomOptimization = true)
    Parameters
    Type Name Description
    System.Boolean enableZoomOptimization
    Returns
    Type Description
    PdfViewerBuilder

    ExportFailed(String)

    Triggers when an export annotations failed in the PDF Viewer.

    Declaration
    public PdfViewerBuilder ExportFailed(string exportFailed)
    Parameters
    Type Name Description
    System.String exportFailed
    Returns
    Type Description
    PdfViewerBuilder

    ExportStart(String)

    Triggers when an exported annotations started in the PDF Viewer.

    Declaration
    public PdfViewerBuilder ExportStart(string exportStart)
    Parameters
    Type Name Description
    System.String exportStart
    Returns
    Type Description
    PdfViewerBuilder

    ExportSuccess(String)

    Triggers when an export annotations succeed in the PDF Viewer.

    Declaration
    public PdfViewerBuilder ExportSuccess(string exportSuccess)
    Parameters
    Type Name Description
    System.String exportSuccess
    Returns
    Type Description
    PdfViewerBuilder

    ExtractTextCompleted(String)

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

    Declaration
    public PdfViewerBuilder ExtractTextCompleted(string extractTextCompleted)
    Parameters
    Type Name Description
    System.String extractTextCompleted
    Returns
    Type Description
    PdfViewerBuilder

    FormFieldCollections(PdfViewerFormFieldCollections)

    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 PdfViewerBuilder FormFieldCollections(PdfViewerFormFieldCollections formFieldCollections)
    Parameters
    Type Name Description
    PdfViewerFormFieldCollections formFieldCollections
    Returns
    Type Description
    PdfViewerBuilder

    FormFieldCollections(Action<PdfViewerFormFieldCollectionsBuilder>)

    Declaration
    public PdfViewerBuilder FormFieldCollections(Action<PdfViewerFormFieldCollectionsBuilder> formFieldCollections)
    Parameters
    Type Name Description
    System.Action<PdfViewerFormFieldCollectionsBuilder> formFieldCollections
    Returns
    Type Description
    PdfViewerBuilder

    FormFieldFocusOut(String)

    Triggers when focus out from the form fields.

    Declaration
    public PdfViewerBuilder FormFieldFocusOut(string formFieldFocusOut)
    Parameters
    Type Name Description
    System.String formFieldFocusOut
    Returns
    Type Description
    PdfViewerBuilder

    FreeTextSettings(PdfViewerFreeTextSettings)

    Defines the settings of free text annotation.

    Declaration
    public PdfViewerBuilder FreeTextSettings(PdfViewerFreeTextSettings freeTextSettings)
    Parameters
    Type Name Description
    PdfViewerFreeTextSettings freeTextSettings
    Returns
    Type Description
    PdfViewerBuilder

    FreeTextSettings(Action<PdfViewerFreeTextSettingsBuilder>)

    Declaration
    public PdfViewerBuilder FreeTextSettings(Action<PdfViewerFreeTextSettingsBuilder> freeTextSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerFreeTextSettingsBuilder> freeTextSettings
    Returns
    Type Description
    PdfViewerBuilder

    HandWrittenSignatureSettings(PdfViewerHandWrittenSignatureSettings)

    Defines the settings of handWrittenSignature.

    Declaration
    public PdfViewerBuilder HandWrittenSignatureSettings(PdfViewerHandWrittenSignatureSettings handWrittenSignatureSettings)
    Parameters
    Type Name Description
    PdfViewerHandWrittenSignatureSettings handWrittenSignatureSettings
    Returns
    Type Description
    PdfViewerBuilder

    HandWrittenSignatureSettings(Action<PdfViewerHandWrittenSignatureSettingsBuilder>)

    Declaration
    public PdfViewerBuilder HandWrittenSignatureSettings(Action<PdfViewerHandWrittenSignatureSettingsBuilder> handWrittenSignatureSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerHandWrittenSignatureSettingsBuilder> handWrittenSignatureSettings
    Returns
    Type Description
    PdfViewerBuilder

    Height(Double)

    Defines the scrollable height of the PdfViewer control.

    Declaration
    public PdfViewerBuilder Height(double height)
    Parameters
    Type Name Description
    System.Double height
    Returns
    Type Description
    PdfViewerBuilder

    Height(String)

    Defines the scrollable height of the PdfViewer control.

    Declaration
    public PdfViewerBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    PdfViewerBuilder

    HideSaveSignature(Boolean)

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

    Declaration
    public PdfViewerBuilder HideSaveSignature(bool hideSaveSignature = true)
    Parameters
    Type Name Description
    System.Boolean hideSaveSignature
    Returns
    Type Description
    PdfViewerBuilder

    HighlightSettings(PdfViewerHighlightSettings)

    Defines the settings of highlight annotation.

    Declaration
    public PdfViewerBuilder HighlightSettings(PdfViewerHighlightSettings highlightSettings)
    Parameters
    Type Name Description
    PdfViewerHighlightSettings highlightSettings
    Returns
    Type Description
    PdfViewerBuilder

    HighlightSettings(Action<PdfViewerHighlightSettingsBuilder>)

    Declaration
    public PdfViewerBuilder HighlightSettings(Action<PdfViewerHighlightSettingsBuilder> highlightSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerHighlightSettingsBuilder> highlightSettings
    Returns
    Type Description
    PdfViewerBuilder

    HtmlAttributes(Object)

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

    Declaration
    public PdfViewerBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    PdfViewerBuilder

    HyperlinkClick(String)

    Triggers when hyperlink in the PDF Document is clicked

    Declaration
    public PdfViewerBuilder HyperlinkClick(string hyperlinkClick)
    Parameters
    Type Name Description
    System.String hyperlinkClick
    Returns
    Type Description
    PdfViewerBuilder

    HyperlinkMouseOver(String)

    Triggers when hyperlink in the PDF Document is hovered

    Declaration
    public PdfViewerBuilder HyperlinkMouseOver(string hyperlinkMouseOver)
    Parameters
    Type Name Description
    System.String hyperlinkMouseOver
    Returns
    Type Description
    PdfViewerBuilder

    HyperlinkOpenState(LinkTarget)

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

    Declaration
    public PdfViewerBuilder HyperlinkOpenState(LinkTarget hyperlinkOpenState)
    Parameters
    Type Name Description
    LinkTarget hyperlinkOpenState
    Returns
    Type Description
    PdfViewerBuilder

    ImportFailed(String)

    Triggers when an imports annotations failed in the PDF document.

    Declaration
    public PdfViewerBuilder ImportFailed(string importFailed)
    Parameters
    Type Name Description
    System.String importFailed
    Returns
    Type Description
    PdfViewerBuilder

    ImportStart(String)

    Triggers when an imported annotations started in the PDF document.

    Declaration
    public PdfViewerBuilder ImportStart(string importStart)
    Parameters
    Type Name Description
    System.String importStart
    Returns
    Type Description
    PdfViewerBuilder

    ImportSuccess(String)

    Triggers when an imports annotations succeed in the PDF document.

    Declaration
    public PdfViewerBuilder ImportSuccess(string importSuccess)
    Parameters
    Type Name Description
    System.String importSuccess
    Returns
    Type Description
    PdfViewerBuilder

    InkAnnotationSettings(Object)

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

    Declaration
    public PdfViewerBuilder InkAnnotationSettings(object inkAnnotationSettings)
    Parameters
    Type Name Description
    System.Object inkAnnotationSettings
    Returns
    Type Description
    PdfViewerBuilder

    InteractionMode(InteractionMode)

    Sets the interaction mode of the PdfViewer

    Declaration
    public PdfViewerBuilder InteractionMode(InteractionMode interactionMode)
    Parameters
    Type Name Description
    InteractionMode interactionMode
    Returns
    Type Description
    PdfViewerBuilder

    IsAnnotationToolbarOpen(Boolean)

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

    Declaration
    public PdfViewerBuilder IsAnnotationToolbarOpen(bool isAnnotationToolbarOpen = true)
    Parameters
    Type Name Description
    System.Boolean isAnnotationToolbarOpen
    Returns
    Type Description
    PdfViewerBuilder

    IsBookmarkPanelOpen(Boolean)

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

    Declaration
    public PdfViewerBuilder IsBookmarkPanelOpen(bool isBookmarkPanelOpen = true)
    Parameters
    Type Name Description
    System.Boolean isBookmarkPanelOpen
    Returns
    Type Description
    PdfViewerBuilder

    IsCommandPanelOpen(Boolean)

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

    Declaration
    public PdfViewerBuilder IsCommandPanelOpen(bool isCommandPanelOpen = true)
    Parameters
    Type Name Description
    System.Boolean isCommandPanelOpen
    Returns
    Type Description
    PdfViewerBuilder

    IsDocumentEdited(Boolean)

    Checks whether the PDF document is edited.

    Declaration
    public PdfViewerBuilder IsDocumentEdited(bool isDocumentEdited = true)
    Parameters
    Type Name Description
    System.Boolean isDocumentEdited
    Returns
    Type Description
    PdfViewerBuilder

    IsExtractText(Boolean)

    Enable or disables the get the document text collections.

    Declaration
    public PdfViewerBuilder IsExtractText(bool isExtractText = true)
    Parameters
    Type Name Description
    System.Boolean isExtractText
    Returns
    Type Description
    PdfViewerBuilder

    IsFormFieldDocument(Boolean)

    Enable if the PDF document contains form fields.

    Declaration
    public PdfViewerBuilder IsFormFieldDocument(bool isFormFieldDocument = true)
    Parameters
    Type Name Description
    System.Boolean isFormFieldDocument
    Returns
    Type Description
    PdfViewerBuilder

    IsMaintainSelection(Boolean)

    Maintain the selection of text markup annotation.

    Declaration
    public PdfViewerBuilder IsMaintainSelection(bool isMaintainSelection = true)
    Parameters
    Type Name Description
    System.Boolean isMaintainSelection
    Returns
    Type Description
    PdfViewerBuilder

    IsSignatureEditable(Boolean)

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

    Declaration
    public PdfViewerBuilder IsSignatureEditable(bool isSignatureEditable = true)
    Parameters
    Type Name Description
    System.Boolean isSignatureEditable
    Returns
    Type Description
    PdfViewerBuilder

    IsThumbnailViewOpen(Boolean)

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

    Declaration
    public PdfViewerBuilder IsThumbnailViewOpen(bool isThumbnailViewOpen = true)
    Parameters
    Type Name Description
    System.Boolean isThumbnailViewOpen
    Returns
    Type Description
    PdfViewerBuilder

    IsValidFreeText(Boolean)

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

    Declaration
    public PdfViewerBuilder IsValidFreeText(bool isValidFreeText = true)
    Parameters
    Type Name Description
    System.Boolean isValidFreeText
    Returns
    Type Description
    PdfViewerBuilder

    LineSettings(PdfViewerLineSettings)

    Defines the settings of line annotation.

    Declaration
    public PdfViewerBuilder LineSettings(PdfViewerLineSettings lineSettings)
    Parameters
    Type Name Description
    PdfViewerLineSettings lineSettings
    Returns
    Type Description
    PdfViewerBuilder

    LineSettings(Action<PdfViewerLineSettingsBuilder>)

    Declaration
    public PdfViewerBuilder LineSettings(Action<PdfViewerLineSettingsBuilder> lineSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerLineSettingsBuilder> lineSettings
    Returns
    Type Description
    PdfViewerBuilder

    Locale(String)

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

    Declaration
    public PdfViewerBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    PdfViewerBuilder

    MeasurementSettings(PdfViewerMeasurementSettings)

    Defines the settings of measurement annotation.

    Declaration
    public PdfViewerBuilder MeasurementSettings(PdfViewerMeasurementSettings measurementSettings)
    Parameters
    Type Name Description
    PdfViewerMeasurementSettings measurementSettings
    Returns
    Type Description
    PdfViewerBuilder

    MeasurementSettings(Action<PdfViewerMeasurementSettingsBuilder>)

    Declaration
    public PdfViewerBuilder MeasurementSettings(Action<PdfViewerMeasurementSettingsBuilder> measurementSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerMeasurementSettingsBuilder> measurementSettings
    Returns
    Type Description
    PdfViewerBuilder

    MoveSignature(String)

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

    Declaration
    public PdfViewerBuilder MoveSignature(string moveSignature)
    Parameters
    Type Name Description
    System.String moveSignature
    Returns
    Type Description
    PdfViewerBuilder

    PageChange(String)

    Triggers when there is change in current page number.

    Declaration
    public PdfViewerBuilder PageChange(string pageChange)
    Parameters
    Type Name Description
    System.String pageChange
    Returns
    Type Description
    PdfViewerBuilder

    PageClick(String)

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

    Declaration
    public PdfViewerBuilder PageClick(string pageClick)
    Parameters
    Type Name Description
    System.String pageClick
    Returns
    Type Description
    PdfViewerBuilder

    PageCount(Double)

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

    Declaration
    public PdfViewerBuilder PageCount(double pageCount)
    Parameters
    Type Name Description
    System.Double pageCount
    Returns
    Type Description
    PdfViewerBuilder

    PageMouseover(String)

    Triggers when mouse over the page.

    Declaration
    public PdfViewerBuilder PageMouseover(string pageMouseover)
    Parameters
    Type Name Description
    System.String pageMouseover
    Returns
    Type Description
    PdfViewerBuilder

    PerimeterSettings(PdfViewerPerimeterSettings)

    Defines the settings of perimeter annotation.

    Declaration
    public PdfViewerBuilder PerimeterSettings(PdfViewerPerimeterSettings perimeterSettings)
    Parameters
    Type Name Description
    PdfViewerPerimeterSettings perimeterSettings
    Returns
    Type Description
    PdfViewerBuilder

    PerimeterSettings(Action<PdfViewerPerimeterSettingsBuilder>)

    Declaration
    public PdfViewerBuilder PerimeterSettings(Action<PdfViewerPerimeterSettingsBuilder> perimeterSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerPerimeterSettingsBuilder> perimeterSettings
    Returns
    Type Description
    PdfViewerBuilder

    PolygonSettings(PdfViewerPolygonSettings)

    Defines the settings of polygon annotation.

    Declaration
    public PdfViewerBuilder PolygonSettings(PdfViewerPolygonSettings polygonSettings)
    Parameters
    Type Name Description
    PdfViewerPolygonSettings polygonSettings
    Returns
    Type Description
    PdfViewerBuilder

    PolygonSettings(Action<PdfViewerPolygonSettingsBuilder>)

    Declaration
    public PdfViewerBuilder PolygonSettings(Action<PdfViewerPolygonSettingsBuilder> polygonSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerPolygonSettingsBuilder> polygonSettings
    Returns
    Type Description
    PdfViewerBuilder

    PrintEnd(String)

    Triggers an event when the print actions is finished.

    Declaration
    public PdfViewerBuilder PrintEnd(string printEnd)
    Parameters
    Type Name Description
    System.String printEnd
    Returns
    Type Description
    PdfViewerBuilder

    PrintMode(PrintMode)

    Specifies the print mode in the PDF Viewer.

    Declaration
    public PdfViewerBuilder PrintMode(PrintMode printMode)
    Parameters
    Type Name Description
    PrintMode printMode
    Returns
    Type Description
    PdfViewerBuilder

    PrintStart(String)

    Triggers an event when the print action is started.

    Declaration
    public PdfViewerBuilder PrintStart(string printStart)
    Parameters
    Type Name Description
    System.String printStart
    Returns
    Type Description
    PdfViewerBuilder

    RadiusSettings(PdfViewerRadiusSettings)

    Defines the settings of radius annotation.

    Declaration
    public PdfViewerBuilder RadiusSettings(PdfViewerRadiusSettings radiusSettings)
    Parameters
    Type Name Description
    PdfViewerRadiusSettings radiusSettings
    Returns
    Type Description
    PdfViewerBuilder

    RadiusSettings(Action<PdfViewerRadiusSettingsBuilder>)

    Declaration
    public PdfViewerBuilder RadiusSettings(Action<PdfViewerRadiusSettingsBuilder> radiusSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerRadiusSettingsBuilder> radiusSettings
    Returns
    Type Description
    PdfViewerBuilder

    RectangleSettings(PdfViewerRectangleSettings)

    Defines the settings of rectangle annotation.

    Declaration
    public PdfViewerBuilder RectangleSettings(PdfViewerRectangleSettings rectangleSettings)
    Parameters
    Type Name Description
    PdfViewerRectangleSettings rectangleSettings
    Returns
    Type Description
    PdfViewerBuilder

    RectangleSettings(Action<PdfViewerRectangleSettingsBuilder>)

    Declaration
    public PdfViewerBuilder RectangleSettings(Action<PdfViewerRectangleSettingsBuilder> rectangleSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerRectangleSettingsBuilder> rectangleSettings
    Returns
    Type Description
    PdfViewerBuilder

    RemoveSignature(String)

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

    Declaration
    public PdfViewerBuilder RemoveSignature(string removeSignature)
    Parameters
    Type Name Description
    System.String removeSignature
    Returns
    Type Description
    PdfViewerBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    ResizeSignature(String)

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

    Declaration
    public PdfViewerBuilder ResizeSignature(string resizeSignature)
    Parameters
    Type Name Description
    System.String resizeSignature
    Returns
    Type Description
    PdfViewerBuilder

    RestrictZoomRequest(Boolean)

    restrict zoom request.

    Declaration
    public PdfViewerBuilder RestrictZoomRequest(bool restrictZoomRequest = true)
    Parameters
    Type Name Description
    System.Boolean restrictZoomRequest
    Returns
    Type Description
    PdfViewerBuilder

    RetryCount(Double)

    Specifies the retry count for the failed requests.

    Declaration
    public PdfViewerBuilder RetryCount(double retryCount)
    Parameters
    Type Name Description
    System.Double retryCount
    Returns
    Type Description
    PdfViewerBuilder

    ScrollSettings(Object)

    Defines the scroll settings.

    Declaration
    public PdfViewerBuilder ScrollSettings(object scrollSettings)
    Parameters
    Type Name Description
    System.Object scrollSettings
    Returns
    Type Description
    PdfViewerBuilder

    SelectedItems(Object)

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

    Declaration
    public PdfViewerBuilder SelectedItems(object selectedItems)
    Parameters
    Type Name Description
    System.Object selectedItems
    Returns
    Type Description
    PdfViewerBuilder

    ServerActionSettings(PdfViewerServerActionSettings)

    Defines the settings of the PdfViewer service.

    Declaration
    public PdfViewerBuilder ServerActionSettings(PdfViewerServerActionSettings serverActionSettings)
    Parameters
    Type Name Description
    PdfViewerServerActionSettings serverActionSettings
    Returns
    Type Description
    PdfViewerBuilder

    ServerActionSettings(Action<PdfViewerServerActionSettingsBuilder>)

    Declaration
    public PdfViewerBuilder ServerActionSettings(Action<PdfViewerServerActionSettingsBuilder> serverActionSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerServerActionSettingsBuilder> serverActionSettings
    Returns
    Type Description
    PdfViewerBuilder

    ServiceUrl(String)

    Defines the service url of the PdfViewer control.

    Declaration
    public PdfViewerBuilder ServiceUrl(string serviceUrl)
    Parameters
    Type Name Description
    System.String serviceUrl
    Returns
    Type Description
    PdfViewerBuilder

    ShapeLabelSettings(PdfViewerShapeLabelSettings)

    Defines the settings of shape label.

    Declaration
    public PdfViewerBuilder ShapeLabelSettings(PdfViewerShapeLabelSettings shapeLabelSettings)
    Parameters
    Type Name Description
    PdfViewerShapeLabelSettings shapeLabelSettings
    Returns
    Type Description
    PdfViewerBuilder

    ShapeLabelSettings(Action<PdfViewerShapeLabelSettingsBuilder>)

    Declaration
    public PdfViewerBuilder ShapeLabelSettings(Action<PdfViewerShapeLabelSettingsBuilder> shapeLabelSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerShapeLabelSettingsBuilder> shapeLabelSettings
    Returns
    Type Description
    PdfViewerBuilder

    ShowNotificationDialog(Boolean)

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

    Declaration
    public PdfViewerBuilder ShowNotificationDialog(bool showNotificationDialog = true)
    Parameters
    Type Name Description
    System.Boolean showNotificationDialog
    Returns
    Type Description
    PdfViewerBuilder

    SignatureFieldSettings(Object)

    Defines the properties of signature field

    Declaration
    public PdfViewerBuilder SignatureFieldSettings(object signatureFieldSettings)
    Parameters
    Type Name Description
    System.Object signatureFieldSettings
    Returns
    Type Description
    PdfViewerBuilder

    SignatureFitMode(SignatureFitMode)

    Specifies the signature mode in the PDF Viewer.

    Declaration
    public PdfViewerBuilder SignatureFitMode(SignatureFitMode signatureFitMode)
    Parameters
    Type Name Description
    SignatureFitMode signatureFitMode
    Returns
    Type Description
    PdfViewerBuilder

    SignaturePropertiesChange(String)

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

    Declaration
    public PdfViewerBuilder SignaturePropertiesChange(string signaturePropertiesChange)
    Parameters
    Type Name Description
    System.String signaturePropertiesChange
    Returns
    Type Description
    PdfViewerBuilder

    SignatureSelect(String)

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

    Declaration
    public PdfViewerBuilder SignatureSelect(string signatureSelect)
    Parameters
    Type Name Description
    System.String signatureSelect
    Returns
    Type Description
    PdfViewerBuilder

    StampSettings(PdfViewerStampSettings)

    Defines the settings of stamp annotation.

    Declaration
    public PdfViewerBuilder StampSettings(PdfViewerStampSettings stampSettings)
    Parameters
    Type Name Description
    PdfViewerStampSettings stampSettings
    Returns
    Type Description
    PdfViewerBuilder

    StampSettings(Action<PdfViewerStampSettingsBuilder>)

    Declaration
    public PdfViewerBuilder StampSettings(Action<PdfViewerStampSettingsBuilder> stampSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerStampSettingsBuilder> stampSettings
    Returns
    Type Description
    PdfViewerBuilder

    StickyNotesSettings(PdfViewerStickyNotesSettings)

    Defines the settings of stickyNotes annotation.

    Declaration
    public PdfViewerBuilder StickyNotesSettings(PdfViewerStickyNotesSettings stickyNotesSettings)
    Parameters
    Type Name Description
    PdfViewerStickyNotesSettings stickyNotesSettings
    Returns
    Type Description
    PdfViewerBuilder

    StickyNotesSettings(Action<PdfViewerStickyNotesSettingsBuilder>)

    Declaration
    public PdfViewerBuilder StickyNotesSettings(Action<PdfViewerStickyNotesSettingsBuilder> stickyNotesSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerStickyNotesSettingsBuilder> stickyNotesSettings
    Returns
    Type Description
    PdfViewerBuilder

    StrikethroughSettings(PdfViewerStrikethroughSettings)

    Defines the settings of strikethrough annotation.

    Declaration
    public PdfViewerBuilder StrikethroughSettings(PdfViewerStrikethroughSettings strikethroughSettings)
    Parameters
    Type Name Description
    PdfViewerStrikethroughSettings strikethroughSettings
    Returns
    Type Description
    PdfViewerBuilder

    StrikethroughSettings(Action<PdfViewerStrikethroughSettingsBuilder>)

    Declaration
    public PdfViewerBuilder StrikethroughSettings(Action<PdfViewerStrikethroughSettingsBuilder> strikethroughSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerStrikethroughSettingsBuilder> strikethroughSettings
    Returns
    Type Description
    PdfViewerBuilder

    TextSearchColorSettings(PdfViewerTextSearchColorSettings)

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

    Declaration
    public PdfViewerBuilder TextSearchColorSettings(PdfViewerTextSearchColorSettings textSearchColorSettings)
    Parameters
    Type Name Description
    PdfViewerTextSearchColorSettings textSearchColorSettings
    Returns
    Type Description
    PdfViewerBuilder

    TextSearchColorSettings(Action<PdfViewerTextSearchColorSettingsBuilder>)

    Declaration
    public PdfViewerBuilder TextSearchColorSettings(Action<PdfViewerTextSearchColorSettingsBuilder> textSearchColorSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerTextSearchColorSettingsBuilder> textSearchColorSettings
    Returns
    Type Description
    PdfViewerBuilder

    TextSearchComplete(String)

    Triggers an event when the text search is completed.

    Declaration
    public PdfViewerBuilder TextSearchComplete(string textSearchComplete)
    Parameters
    Type Name Description
    System.String textSearchComplete
    Returns
    Type Description
    PdfViewerBuilder

    TextSearchHighlight(String)

    Triggers an event when the text search text is highlighted.

    Declaration
    public PdfViewerBuilder TextSearchHighlight(string textSearchHighlight)
    Parameters
    Type Name Description
    System.String textSearchHighlight
    Returns
    Type Description
    PdfViewerBuilder

    TextSearchStart(String)

    Triggers an event when the text search is started.

    Declaration
    public PdfViewerBuilder TextSearchStart(string textSearchStart)
    Parameters
    Type Name Description
    System.String textSearchStart
    Returns
    Type Description
    PdfViewerBuilder

    TextSelectionEnd(String)

    Triggers an event when the text selection is finished.

    Declaration
    public PdfViewerBuilder TextSelectionEnd(string textSelectionEnd)
    Parameters
    Type Name Description
    System.String textSelectionEnd
    Returns
    Type Description
    PdfViewerBuilder

    TextSelectionStart(String)

    Triggers an event when the text selection is started.

    Declaration
    public PdfViewerBuilder TextSelectionStart(string textSelectionStart)
    Parameters
    Type Name Description
    System.String textSelectionStart
    Returns
    Type Description
    PdfViewerBuilder

    ThumbnailClick(String)

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

    Declaration
    public PdfViewerBuilder ThumbnailClick(string thumbnailClick)
    Parameters
    Type Name Description
    System.String thumbnailClick
    Returns
    Type Description
    PdfViewerBuilder

    TileRenderingSettings(Object)

    Defines the tile rendering settings.

    Declaration
    public PdfViewerBuilder TileRenderingSettings(object tileRenderingSettings)
    Parameters
    Type Name Description
    System.Object tileRenderingSettings
    Returns
    Type Description
    PdfViewerBuilder

    ToolbarSettings(PdfViewerToolbarSettings)

    Defines the settings of the PdfViewer toolbar.

    Declaration
    public PdfViewerBuilder ToolbarSettings(PdfViewerToolbarSettings toolbarSettings)
    Parameters
    Type Name Description
    PdfViewerToolbarSettings toolbarSettings
    Returns
    Type Description
    PdfViewerBuilder

    ToolbarSettings(Action<PdfViewerToolbarSettingsBuilder>)

    Declaration
    public PdfViewerBuilder ToolbarSettings(Action<PdfViewerToolbarSettingsBuilder> toolbarSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerToolbarSettingsBuilder> toolbarSettings
    Returns
    Type Description
    PdfViewerBuilder

    UnderlineSettings(PdfViewerUnderlineSettings)

    Defines the settings of underline annotation.

    Declaration
    public PdfViewerBuilder UnderlineSettings(PdfViewerUnderlineSettings underlineSettings)
    Parameters
    Type Name Description
    PdfViewerUnderlineSettings underlineSettings
    Returns
    Type Description
    PdfViewerBuilder

    UnderlineSettings(Action<PdfViewerUnderlineSettingsBuilder>)

    Declaration
    public PdfViewerBuilder UnderlineSettings(Action<PdfViewerUnderlineSettingsBuilder> underlineSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerUnderlineSettingsBuilder> underlineSettings
    Returns
    Type Description
    PdfViewerBuilder

    ValidateFormFields(String)

    Triggers when validation is failed.

    Declaration
    public PdfViewerBuilder ValidateFormFields(string validateFormFields)
    Parameters
    Type Name Description
    System.String validateFormFields
    Returns
    Type Description
    PdfViewerBuilder

    VolumeSettings(PdfViewerVolumeSettings)

    Defines the settings of volume annotation.

    Declaration
    public PdfViewerBuilder VolumeSettings(PdfViewerVolumeSettings volumeSettings)
    Parameters
    Type Name Description
    PdfViewerVolumeSettings volumeSettings
    Returns
    Type Description
    PdfViewerBuilder

    VolumeSettings(Action<PdfViewerVolumeSettingsBuilder>)

    Declaration
    public PdfViewerBuilder VolumeSettings(Action<PdfViewerVolumeSettingsBuilder> volumeSettings)
    Parameters
    Type Name Description
    System.Action<PdfViewerVolumeSettingsBuilder> volumeSettings
    Returns
    Type Description
    PdfViewerBuilder

    Width(Double)

    Defines the scrollable width of the PdfViewer control.

    Declaration
    public PdfViewerBuilder Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    PdfViewerBuilder

    Width(String)

    Defines the scrollable width of the PdfViewer control.

    Declaration
    public PdfViewerBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    PdfViewerBuilder

    ZoomChange(String)

    Triggers when there is change in the magnification value.

    Declaration
    public PdfViewerBuilder ZoomChange(string zoomChange)
    Parameters
    Type Name Description
    System.String zoomChange
    Returns
    Type Description
    PdfViewerBuilder

    ZoomMode(ZoomMode)

    Specifies the rendering mode in the PDF Viewer.

    Declaration
    public PdfViewerBuilder ZoomMode(ZoomMode zoomMode)
    Parameters
    Type Name Description
    ZoomMode zoomMode
    Returns
    Type Description
    PdfViewerBuilder

    ZoomValue(Double)

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

    Declaration
    public PdfViewerBuilder ZoomValue(double zoomValue)
    Parameters
    Type Name Description
    System.Double zoomValue
    Returns
    Type Description
    PdfViewerBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved