Class PdfViewerBuilder
Inheritance
System.Object
PdfViewerBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class PdfViewerBuilder : ControlBuilder
Constructors
PdfViewerBuilder()
Declaration
public PdfViewerBuilder()
PdfViewerBuilder(PdfViewer)
Declaration
public PdfViewerBuilder(PdfViewer model)
Parameters
Fields
model
Declaration
Field Value
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
Methods
AddSignature(String)
Triggers when a signature is added to a page of a PDF document.
Declaration
public PdfViewerBuilder AddSignature(string addSignature)
Parameters
| Type |
Name |
Description |
| System.String |
addSignature |
|
Returns
AjaxRequestFailed(String)
Triggers when the AJAX request is failed.
Declaration
public PdfViewerBuilder AjaxRequestFailed(string ajaxRequestFailed)
Parameters
| Type |
Name |
Description |
| System.String |
ajaxRequestFailed |
|
Returns
AjaxRequestInitiate(String)
Triggers before the data is sent to the server.
Declaration
public PdfViewerBuilder AjaxRequestInitiate(string ajaxRequestInitiate)
Parameters
| Type |
Name |
Description |
| System.String |
ajaxRequestInitiate |
|
Returns
AjaxRequestSettings(PdfViewerAjaxRequestSettings)
Defines the ajax Request settings of the PDF Viewer.
Declaration
public PdfViewerBuilder AjaxRequestSettings(PdfViewerAjaxRequestSettings ajaxRequestSettings)
Parameters
Returns
AjaxRequestSettings(Action<PdfViewerAjaxRequestSettingsBuilder>)
Declaration
public PdfViewerBuilder AjaxRequestSettings(Action<PdfViewerAjaxRequestSettingsBuilder> ajaxRequestSettings)
Parameters
Returns
AjaxRequestSuccess(String)
Triggers on successful AJAX request.
Declaration
public PdfViewerBuilder AjaxRequestSuccess(string ajaxRequestSuccess)
Parameters
| Type |
Name |
Description |
| System.String |
ajaxRequestSuccess |
|
Returns
AnnotationAdd(String)
Triggers when an annotation is added to a PDF document's page.
Declaration
public PdfViewerBuilder AnnotationAdd(string annotationAdd)
Parameters
| Type |
Name |
Description |
| System.String |
annotationAdd |
|
Returns
AnnotationDoubleClick(String)
Triggers when the annotation is double clicked.
Declaration
public PdfViewerBuilder AnnotationDoubleClick(string annotationDoubleClick)
Parameters
| Type |
Name |
Description |
| System.String |
annotationDoubleClick |
|
Returns
AnnotationMouseLeave(String)
Triggers when the user mouse moves away from the annotation object.
Declaration
public PdfViewerBuilder AnnotationMouseLeave(string annotationMouseLeave)
Parameters
| Type |
Name |
Description |
| System.String |
annotationMouseLeave |
|
Returns
AnnotationMouseover(String)
Triggers when the mouse is moved over the annotation object.
Declaration
public PdfViewerBuilder AnnotationMouseover(string annotationMouseover)
Parameters
| Type |
Name |
Description |
| System.String |
annotationMouseover |
|
Returns
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
AnnotationMoving(String)
Triggers while moving an annotation.
Declaration
public PdfViewerBuilder AnnotationMoving(string annotationMoving)
Parameters
| Type |
Name |
Description |
| System.String |
annotationMoving |
|
Returns
AnnotationPropertiesChange(String)
Triggers when the annotation's property is modified on a PDF document page.
Declaration
public PdfViewerBuilder AnnotationPropertiesChange(string annotationPropertiesChange)
Parameters
| Type |
Name |
Description |
| System.String |
annotationPropertiesChange |
|
Returns
AnnotationRemove(String)
Triggers when an annotation is removed from a PDF document's page.
Declaration
public PdfViewerBuilder AnnotationRemove(string annotationRemove)
Parameters
| Type |
Name |
Description |
| System.String |
annotationRemove |
|
Returns
AnnotationResize(String)
Triggers when an annotation is resized over the page of a PDF document.
Declaration
public PdfViewerBuilder AnnotationResize(string annotationResize)
Parameters
| Type |
Name |
Description |
| System.String |
annotationResize |
|
Returns
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
AnnotationSelectorSettings(PdfViewerAnnotationSelectorSettings)
Defines the settings of annotation selector.
Declaration
public PdfViewerBuilder AnnotationSelectorSettings(PdfViewerAnnotationSelectorSettings annotationSelectorSettings)
Parameters
Returns
AnnotationSelectorSettings(Action<PdfViewerAnnotationSelectorSettingsBuilder>)
Declaration
public PdfViewerBuilder AnnotationSelectorSettings(Action<PdfViewerAnnotationSelectorSettingsBuilder> annotationSelectorSettings)
Parameters
Returns
AnnotationSettings(PdfViewerAnnotationSettings)
Defines the settings of the annotations.
Declaration
public PdfViewerBuilder AnnotationSettings(PdfViewerAnnotationSettings annotationSettings)
Parameters
Returns
AnnotationSettings(Action<PdfViewerAnnotationSettingsBuilder>)
Declaration
public PdfViewerBuilder AnnotationSettings(Action<PdfViewerAnnotationSettingsBuilder> annotationSettings)
Parameters
Returns
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
AreaSettings(PdfViewerAreaSettings)
Defines the settings of area annotation.
Declaration
public PdfViewerBuilder AreaSettings(PdfViewerAreaSettings areaSettings)
Parameters
Returns
AreaSettings(Action<PdfViewerAreaSettingsBuilder>)
Declaration
public PdfViewerBuilder AreaSettings(Action<PdfViewerAreaSettingsBuilder> areaSettings)
Parameters
Returns
ArrowSettings(PdfViewerArrowSettings)
Defines the settings of arrow annotation.
Declaration
public PdfViewerBuilder ArrowSettings(PdfViewerArrowSettings arrowSettings)
Parameters
Returns
ArrowSettings(Action<PdfViewerArrowSettingsBuilder>)
Declaration
public PdfViewerBuilder ArrowSettings(Action<PdfViewerArrowSettingsBuilder> arrowSettings)
Parameters
Returns
BeforeAddFreeText(String)
Triggers before adding a text in the freeText annotation.
Declaration
public PdfViewerBuilder BeforeAddFreeText(string beforeAddFreeText)
Parameters
| Type |
Name |
Description |
| System.String |
beforeAddFreeText |
|
Returns
BookmarkClick(String)
Triggers when the bookmark is clicked in the PDF Viewer's bookmark panel.
Declaration
public PdfViewerBuilder BookmarkClick(string bookmarkClick)
Parameters
| Type |
Name |
Description |
| System.String |
bookmarkClick |
|
Returns
Triggers when the button is clicked.
Declaration
public PdfViewerBuilder ButtonFieldClick(string buttonFieldClick)
Parameters
| Type |
Name |
Description |
| System.String |
buttonFieldClick |
|
Returns
CheckBoxFieldSettings(PdfViewerCheckBoxFieldSettings)
Get or set the check box field settings.
Declaration
public PdfViewerBuilder CheckBoxFieldSettings(PdfViewerCheckBoxFieldSettings checkBoxFieldSettings)
Parameters
Returns
CheckBoxFieldSettings(Action<PdfViewerCheckBoxFieldSettingsBuilder>)
Declaration
public PdfViewerBuilder CheckBoxFieldSettings(Action<PdfViewerCheckBoxFieldSettingsBuilder> checkBoxFieldSettings)
Parameters
Returns
CircleSettings(PdfViewerCircleSettings)
Defines the settings of circle annotation.
Declaration
public PdfViewerBuilder CircleSettings(PdfViewerCircleSettings circleSettings)
Parameters
Returns
CircleSettings(Action<PdfViewerCircleSettingsBuilder>)
Declaration
public PdfViewerBuilder CircleSettings(Action<PdfViewerCircleSettingsBuilder> circleSettings)
Parameters
Returns
Triggers when a comment for the annotation is added to the comment panel.
Declaration
public PdfViewerBuilder CommentAdd(string commentAdd)
Parameters
| Type |
Name |
Description |
| System.String |
commentAdd |
|
Returns
Triggers when the comment for the annotation in the comment panel is deleted.
Declaration
public PdfViewerBuilder CommentDelete(string commentDelete)
Parameters
| Type |
Name |
Description |
| System.String |
commentDelete |
|
Returns
Triggers when the comment for the annotation in the comment panel is edited.
Declaration
public PdfViewerBuilder CommentEdit(string commentEdit)
Parameters
| Type |
Name |
Description |
| System.String |
commentEdit |
|
Returns
Triggers when the comment for the annotation in the comment panel is selected.
Declaration
public PdfViewerBuilder CommentSelect(string commentSelect)
Parameters
| Type |
Name |
Description |
| System.String |
commentSelect |
|
Returns
Triggers when the annotation's comment for status is changed in the comment panel.
Declaration
public PdfViewerBuilder CommentStatusChanged(string commentStatusChanged)
Parameters
| Type |
Name |
Description |
| System.String |
commentStatusChanged |
|
Returns
Specifies the state of the ContextMenu in the PDF document.
Declaration
public PdfViewerBuilder ContextMenuOption(ContextMenuAction contextMenuOption)
Parameters
Returns
Defines the context menu settings.
Declaration
public PdfViewerBuilder ContextMenuSettings(PdfViewerContextMenuSettings contextMenuSettings)
Parameters
Returns
Declaration
public PdfViewerBuilder ContextMenuSettings(Action<PdfViewerContextMenuSettingsBuilder> contextMenuSettings)
Parameters
Returns
Created(String)
Triggers during the creation of the PDF viewer component.
Declaration
public PdfViewerBuilder Created(string created)
Parameters
| Type |
Name |
Description |
| System.String |
created |
|
Returns
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
CustomStamp(PdfViewerCustomStamp)
Defines the stamp items of the PDF Viewer.
Declaration
public PdfViewerBuilder CustomStamp(PdfViewerCustomStamp customStamp)
Parameters
Returns
CustomStamp(Action<PdfViewerCustomStampBuilder>)
Declaration
public PdfViewerBuilder CustomStamp(Action<PdfViewerCustomStampBuilder> customStamp)
Parameters
Returns
CustomStampSettings(PdfViewerCustomStampSettings)
Defines the settings of customStamp annotation.
Declaration
public PdfViewerBuilder CustomStampSettings(PdfViewerCustomStampSettings customStampSettings)
Parameters
Returns
CustomStampSettings(Action<PdfViewerCustomStampSettingsBuilder>)
Declaration
public PdfViewerBuilder CustomStampSettings(Action<PdfViewerCustomStampSettingsBuilder> customStampSettings)
Parameters
Returns
Customize desired date and time format
Declaration
public PdfViewerBuilder DateTimeFormat(string dateTimeFormat)
Parameters
| Type |
Name |
Description |
| System.String |
dateTimeFormat |
|
Returns
DesignerMode(Boolean)
Enable or disable the interaction of form fields in the PDF Viewer.
Declaration
public PdfViewerBuilder DesignerMode(bool designerMode = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
designerMode |
|
Returns
Disables the menu items in the context menu.
Declaration
public PdfViewerBuilder DisableContextMenuItems(object disableContextMenuItems)
Parameters
| Type |
Name |
Description |
| System.Object |
disableContextMenuItems |
|
Returns
DistanceSettings(PdfViewerDistanceSettings)
Defines the settings of distance annotation.
Declaration
public PdfViewerBuilder DistanceSettings(PdfViewerDistanceSettings distanceSettings)
Parameters
Returns
DistanceSettings(Action<PdfViewerDistanceSettingsBuilder>)
Declaration
public PdfViewerBuilder DistanceSettings(Action<PdfViewerDistanceSettingsBuilder> distanceSettings)
Parameters
Returns
DocumentLoad(String)
Triggers while loading document into PDF viewer.
Declaration
public PdfViewerBuilder DocumentLoad(string documentLoad)
Parameters
| Type |
Name |
Description |
| System.String |
documentLoad |
|
Returns
DocumentLoadFailed(String)
Triggers while document loading failed in PdfViewer.
Declaration
public PdfViewerBuilder DocumentLoadFailed(string documentLoadFailed)
Parameters
| Type |
Name |
Description |
| System.String |
documentLoadFailed |
|
Returns
DocumentPath(String)
Sets the PDF document path for initial loading.
Declaration
public PdfViewerBuilder DocumentPath(string documentPath)
Parameters
| Type |
Name |
Description |
| System.String |
documentPath |
|
Returns
DocumentUnload(String)
Triggers while closing the document.
Declaration
public PdfViewerBuilder DocumentUnload(string documentUnload)
Parameters
| Type |
Name |
Description |
| System.String |
documentUnload |
|
Returns
DownloadEnd(String)
Triggers when the download actions are completed.
Declaration
public PdfViewerBuilder DownloadEnd(string downloadEnd)
Parameters
| Type |
Name |
Description |
| System.String |
downloadEnd |
|
Returns
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
DownloadStart(String)
Triggers when the download action is initiated.
Declaration
public PdfViewerBuilder DownloadStart(string downloadStart)
Parameters
| Type |
Name |
Description |
| System.String |
downloadStart |
|
Returns
DropdownFieldSettings(PdfViewerDropdownFieldSettings)
Get or set the dropdown field settings.
Declaration
public PdfViewerBuilder DropdownFieldSettings(PdfViewerDropdownFieldSettings DropdownFieldSettings)
Parameters
Returns
DropdownFieldSettings(Action<PdfViewerDropdownFieldSettingsBuilder>)
Declaration
public PdfViewerBuilder DropdownFieldSettings(Action<PdfViewerDropdownFieldSettingsBuilder> DropdownFieldSettings)
Parameters
Returns
Determines whether accessibility tags are enabled or disabled.
Accessibility tags can help make web content more accessible to users with disabilities.
Declaration
public PdfViewerBuilder EnableAccessibilityTags(bool enableAccessibilityTags = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableAccessibilityTags |
|
Returns
EnableAnnotation(Boolean)
Enable or disable the annotation in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableAnnotation(bool enableAnnotation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableAnnotation |
|
Returns
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
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
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
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
Enable or disables the Comment Panel of PdfViewer.
Declaration
public PdfViewerBuilder EnableCommentPanel(bool enableCommentPanel = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableCommentPanel |
|
Returns
EnableDesktopMode(Boolean)
Gets or sets a boolean value to show or hide desktop toolbar in mobile devices.
Declaration
public PdfViewerBuilder EnableDesktopMode(bool enableDesktopMode = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableDesktopMode |
|
Returns
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
Show or hide the form designer tool in the main toolbar of the PDF Viewer.
Declaration
public PdfViewerBuilder EnableFormDesigner(bool enableFormDesigner = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableFormDesigner |
|
Returns
Opens the form designer toolbar when the PDF document is loaded in the PDF Viewer control initially.
Declaration
public PdfViewerBuilder EnableFormDesignerToolbar(bool enableFormDesignerToolbar = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableFormDesignerToolbar |
|
Returns
Enable or disable the form fields in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableFormFields(bool enableFormFields = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableFormFields |
|
Returns
Enable or disable the form fields validation.
Declaration
public PdfViewerBuilder EnableFormFieldsValidation(bool enableFormFieldsValidation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableFormFieldsValidation |
|
Returns
EnableFreeText(Boolean)
Enable or disable the free text annotation in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableFreeText(bool enableFreeText = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableFreeText |
|
Returns
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
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
EnableImportAnnotationMeasurement(Boolean)
Enable or disable the customization of measure values in PDF Viewer.
Declaration
public PdfViewerBuilder EnableImportAnnotationMeasurement(bool enableImportAnnotationMeasurement = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableImportAnnotationMeasurement |
|
Returns
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
EnableMagnification(Boolean)
Enable or disable the Magnification module of PDF Viewer.
Declaration
public PdfViewerBuilder EnableMagnification(bool enableMagnification = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableMagnification |
|
Returns
EnableMeasureAnnotation(Boolean)
Enable or disable the calibrate annotation in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableMeasureAnnotation(bool enableMeasureAnnotation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableMeasureAnnotation |
|
Returns
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
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
EnableNavigation(Boolean)
Enable or disable the Navigation module of PDF Viewer.
Declaration
public PdfViewerBuilder EnableNavigation(bool enableNavigation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableNavigation |
|
Returns
Enable or disables the Navigation toolbar of PdfViewer.
Declaration
public PdfViewerBuilder EnableNavigationToolbar(bool enableNavigationToolbar = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableNavigationToolbar |
|
Returns
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
EnablePinchZoom(Boolean)
Enable or disable the pinch zoom option in the PDF Viewer.
Declaration
public PdfViewerBuilder EnablePinchZoom(bool enablePinchZoom = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enablePinchZoom |
|
Returns
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
EnablePrintRotation(Boolean)
If it is set as FALSE, will suppress the page rotation of Landscape document on print action. By default it is TRUE.
Declaration
public PdfViewerBuilder EnablePrintRotation(bool enablePrintRotation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enablePrintRotation |
|
Returns
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
EnableShapeAnnotation(Boolean)
Enable or disable the shape annotation in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableShapeAnnotation(bool enableShapeAnnotation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableShapeAnnotation |
|
Returns
EnableShapeLabel(Boolean)
Enable or disable the Label for shapeAnnotations of PDF Viewer.
Declaration
public PdfViewerBuilder EnableShapeLabel(bool enableShapeLabel = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableShapeLabel |
|
Returns
EnableStampAnnotations(Boolean)
Enables and disable 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
EnableStickyNotesAnnotation(Boolean)
Enables and disable 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
EnableTextMarkupAnnotation(Boolean)
Enable or disable the text markup annotation in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableTextMarkupAnnotation(bool enableTextMarkupAnnotation = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTextMarkupAnnotation |
|
Returns
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
EnableTextSearch(Boolean)
Enable or disable the text search in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableTextSearch(bool enableTextSearch = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTextSearch |
|
Returns
EnableTextSelection(Boolean)
Enable or disable the text selection in the PDF Viewer.
Declaration
public PdfViewerBuilder EnableTextSelection(bool enableTextSelection = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTextSelection |
|
Returns
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
Enable or disables the toolbar of PdfViewer.
Declaration
public PdfViewerBuilder EnableToolbar(bool enableToolbar = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableToolbar |
|
Returns
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
ExportAnnotationFileName(String)
Gets or sets the export annotations JSON file name in the PdfViewer control.
Declaration
public PdfViewerBuilder ExportAnnotationFileName(string exportAnnotationFileName)
Parameters
| Type |
Name |
Description |
| System.String |
exportAnnotationFileName |
|
Returns
ExportFailed(String)
Triggers when the annotations export in a PDF document fails.
Declaration
public PdfViewerBuilder ExportFailed(string exportFailed)
Parameters
| Type |
Name |
Description |
| System.String |
exportFailed |
|
Returns
ExportStart(String)
Triggers when an exported annotation started in the PDF Viewer.
Declaration
public PdfViewerBuilder ExportStart(string exportStart)
Parameters
| Type |
Name |
Description |
| System.String |
exportStart |
|
Returns
ExportSuccess(String)
Triggers when the annotations in a PDF document are successfully exported.
Declaration
public PdfViewerBuilder ExportSuccess(string exportSuccess)
Parameters
| Type |
Name |
Description |
| System.String |
exportSuccess |
|
Returns
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
Triggers when a form field is added.
Declaration
public PdfViewerBuilder FormFieldAdd(string formFieldAdd)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldAdd |
|
Returns
Triggers when the form field is selected.
Declaration
public PdfViewerBuilder FormFieldClick(string formFieldClick)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldClick |
|
Returns
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
Returns
Declaration
public PdfViewerBuilder FormFieldCollections(Action<PdfViewerFormFieldCollectionsBuilder> formFieldCollections)
Parameters
Returns
Triggers when the form field is double-clicked.
Declaration
public PdfViewerBuilder FormFieldDoubleClick(string formFieldDoubleClick)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldDoubleClick |
|
Returns
Triggers when focus out from the form fields.
Declaration
public PdfViewerBuilder FormFieldFocusOut(string formFieldFocusOut)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldFocusOut |
|
Returns
Triggers when the mouse cursor leaves the form field.
Declaration
public PdfViewerBuilder FormFieldMouseLeave(string formFieldMouseLeave)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldMouseLeave |
|
Returns
Triggers when the mouse cursor is over a form field.
Declaration
public PdfViewerBuilder FormFieldMouseover(string formFieldMouseover)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldMouseover |
|
Returns
Triggers when a form field is moved.
Declaration
public PdfViewerBuilder FormFieldMove(string formFieldMove)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldMove |
|
Returns
Triggers when a property of form field is changed.
Declaration
public PdfViewerBuilder FormFieldPropertiesChange(string formFieldPropertiesChange)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldPropertiesChange |
|
Returns
Triggers when a form field is removed.
Declaration
public PdfViewerBuilder FormFieldRemove(string formFieldRemove)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldRemove |
|
Returns
Triggers when a form field is resized.
Declaration
public PdfViewerBuilder FormFieldResize(string formFieldResize)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldResize |
|
Returns
Triggers when a form field is selected.
Declaration
public PdfViewerBuilder FormFieldSelect(string formFieldSelect)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldSelect |
|
Returns
Triggers when a form field is unselected.
Declaration
public PdfViewerBuilder FormFieldUnselect(string formFieldUnselect)
Parameters
| Type |
Name |
Description |
| System.String |
formFieldUnselect |
|
Returns
FreeTextSettings(PdfViewerFreeTextSettings)
Defines the settings of free text annotation.
Declaration
public PdfViewerBuilder FreeTextSettings(PdfViewerFreeTextSettings freeTextSettings)
Parameters
Returns
FreeTextSettings(Action<PdfViewerFreeTextSettingsBuilder>)
Declaration
public PdfViewerBuilder FreeTextSettings(Action<PdfViewerFreeTextSettingsBuilder> freeTextSettings)
Parameters
Returns
HandWrittenSignatureSettings(PdfViewerHandWrittenSignatureSettings)
Defines the settings of handWrittenSignature.
Declaration
public PdfViewerBuilder HandWrittenSignatureSettings(PdfViewerHandWrittenSignatureSettings handWrittenSignatureSettings)
Parameters
Returns
HandWrittenSignatureSettings(Action<PdfViewerHandWrittenSignatureSettingsBuilder>)
Declaration
public PdfViewerBuilder HandWrittenSignatureSettings(Action<PdfViewerHandWrittenSignatureSettingsBuilder> handWrittenSignatureSettings)
Parameters
Returns
Height(Double)
Defines the scrollable height of the PdfViewer control.
Declaration
public PdfViewerBuilder Height(double height)
Parameters
| Type |
Name |
Description |
| System.Double |
height |
|
Returns
Height(String)
Defines the scrollable height of the PdfViewer control.
Declaration
public PdfViewerBuilder Height(string height)
Parameters
| Type |
Name |
Description |
| System.String |
height |
|
Returns
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
HighlightSettings(PdfViewerHighlightSettings)
Defines the settings of highlight annotation.
Declaration
public PdfViewerBuilder HighlightSettings(PdfViewerHighlightSettings highlightSettings)
Parameters
Returns
HighlightSettings(Action<PdfViewerHighlightSettingsBuilder>)
Declaration
public PdfViewerBuilder HighlightSettings(Action<PdfViewerHighlightSettingsBuilder> highlightSettings)
Parameters
Returns
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
HyperlinkClick(String)
Triggers when a hyperlink in a PDF document is clicked.
Declaration
public PdfViewerBuilder HyperlinkClick(string hyperlinkClick)
Parameters
| Type |
Name |
Description |
| System.String |
hyperlinkClick |
|
Returns
HyperlinkMouseOver(String)
Triggers when hyperlink in a PDF document is hovered.
Declaration
public PdfViewerBuilder HyperlinkMouseOver(string hyperlinkMouseOver)
Parameters
| Type |
Name |
Description |
| System.String |
hyperlinkMouseOver |
|
Returns
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
ImportFailed(String)
Triggers when the annotations imports in a PDF document fails.
Declaration
public PdfViewerBuilder ImportFailed(string importFailed)
Parameters
| Type |
Name |
Description |
| System.String |
importFailed |
|
Returns
ImportStart(String)
Triggers when an imported annotation started to appear in the PDF document.
Declaration
public PdfViewerBuilder ImportStart(string importStart)
Parameters
| Type |
Name |
Description |
| System.String |
importStart |
|
Returns
ImportSuccess(String)
Triggers when the annotations in a PDF document are successfully imported.
Declaration
public PdfViewerBuilder ImportSuccess(string importSuccess)
Parameters
| Type |
Name |
Description |
| System.String |
importSuccess |
|
Returns
InitialDialogSettings(Object)
Get or set the signature dialog settings for initial field.
Declaration
public PdfViewerBuilder InitialDialogSettings(object initialDialogSettings)
Parameters
| Type |
Name |
Description |
| System.Object |
initialDialogSettings |
|
Returns
InitialFieldSettings(PdfViewerInitialFieldSettings)
Get or set the initial field settings.
Declaration
public PdfViewerBuilder InitialFieldSettings(PdfViewerInitialFieldSettings initialFieldSettings)
Parameters
Returns
InitialFieldSettings(Action<PdfViewerInitialFieldSettingsBuilder>)
Declaration
public PdfViewerBuilder InitialFieldSettings(Action<PdfViewerInitialFieldSettingsBuilder> initialFieldSettings)
Parameters
Returns
InitialRenderPages(Double)
Initially renders the first N pages of the PDF document when the document is loaded.
Declaration
public PdfViewerBuilder InitialRenderPages(double initialRenderPages)
Parameters
| Type |
Name |
Description |
| System.Double |
initialRenderPages |
|
Returns
InkAnnotationSettings(PdfViewerInkAnnotationSettings)
Defines the ink annotation settings for PDF Viewer.It used to customize the strokeColor, thickness, opacity of the ink annotation.
Declaration
public PdfViewerBuilder InkAnnotationSettings(PdfViewerInkAnnotationSettings inkAnnotationSettings)
Parameters
Returns
InkAnnotationSettings(Action<PdfViewerInkAnnotationSettingsBuilder>)
Declaration
public PdfViewerBuilder InkAnnotationSettings(Action<PdfViewerInkAnnotationSettingsBuilder> inkAnnotationSettings)
Parameters
Returns
InteractionMode(InteractionMode)
Sets the interaction mode of the PDF Viewer.
Declaration
public PdfViewerBuilder InteractionMode(InteractionMode interactionMode)
Parameters
Returns
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
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 PdfViewerBuilder IsAnnotationToolbarVisible(bool isAnnotationToolbarVisible = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isAnnotationToolbarVisible |
|
Returns
IsBookmarkPanelOpen(Boolean)
Gets or sets a boolean value to show or hide the bookmark panel while loading a document.
Declaration
public PdfViewerBuilder IsBookmarkPanelOpen(bool isBookmarkPanelOpen = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isBookmarkPanelOpen |
|
Returns
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
IsDocumentEdited(Boolean)
Checks whether the PDF document is edited.
Declaration
public PdfViewerBuilder IsDocumentEdited(bool isDocumentEdited = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isDocumentEdited |
|
Returns
Enable or disable the text extract from the PDF viewer.
Declaration
public PdfViewerBuilder IsExtractText(bool isExtractText = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isExtractText |
|
Returns
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 PdfViewerBuilder IsFormDesignerToolbarVisible(bool isFormDesignerToolbarVisible = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isFormDesignerToolbarVisible |
|
Returns
Enable if the PDF document contains form fields.
Declaration
public PdfViewerBuilder IsFormFieldDocument(bool isFormFieldDocument = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isFormFieldDocument |
|
Returns
IsMaintainSelection(Boolean)
Maintain the selection of text markup annotation.
Declaration
public PdfViewerBuilder IsMaintainSelection(bool isMaintainSelection = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isMaintainSelection |
|
Returns
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
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
IsValidFreeText(Boolean)
Checks if the freeText value is valid or not.
Declaration
public PdfViewerBuilder IsValidFreeText(bool isValidFreeText = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isValidFreeText |
|
Returns
LineSettings(PdfViewerLineSettings)
Defines the settings of line annotation.
Declaration
public PdfViewerBuilder LineSettings(PdfViewerLineSettings lineSettings)
Parameters
Returns
LineSettings(Action<PdfViewerLineSettingsBuilder>)
Declaration
public PdfViewerBuilder LineSettings(Action<PdfViewerLineSettingsBuilder> lineSettings)
Parameters
Returns
ListBoxFieldSettings(PdfViewerListBoxFieldSettings)
Get or set the listbox field settings.
Declaration
public PdfViewerBuilder ListBoxFieldSettings(PdfViewerListBoxFieldSettings listBoxFieldSettings)
Parameters
Returns
ListBoxFieldSettings(Action<PdfViewerListBoxFieldSettingsBuilder>)
Declaration
public PdfViewerBuilder ListBoxFieldSettings(Action<PdfViewerListBoxFieldSettingsBuilder> listBoxFieldSettings)
Parameters
Returns
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
MeasurementSettings(PdfViewerMeasurementSettings)
Defines the settings of measurement annotation.
Declaration
public PdfViewerBuilder MeasurementSettings(PdfViewerMeasurementSettings measurementSettings)
Parameters
Returns
MeasurementSettings(Action<PdfViewerMeasurementSettingsBuilder>)
Declaration
public PdfViewerBuilder MeasurementSettings(Action<PdfViewerMeasurementSettingsBuilder> measurementSettings)
Parameters
Returns
MoveSignature(String)
Triggers when a signature is moved across the page of a PDF document.
Declaration
public PdfViewerBuilder MoveSignature(string moveSignature)
Parameters
| Type |
Name |
Description |
| System.String |
moveSignature |
|
Returns
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
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
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
PageMouseover(String)
Triggers when moving the mouse over the page.
Declaration
public PdfViewerBuilder PageMouseover(string pageMouseover)
Parameters
| Type |
Name |
Description |
| System.String |
pageMouseover |
|
Returns
PasswordFieldSettings(PdfViewerPasswordFieldSettings)
Get or set the password field settings.
Declaration
public PdfViewerBuilder PasswordFieldSettings(PdfViewerPasswordFieldSettings passwordFieldSettings)
Parameters
Returns
PasswordFieldSettings(Action<PdfViewerPasswordFieldSettingsBuilder>)
Declaration
public PdfViewerBuilder PasswordFieldSettings(Action<PdfViewerPasswordFieldSettingsBuilder> passwordFieldSettings)
Parameters
Returns
PerimeterSettings(PdfViewerPerimeterSettings)
Defines the settings of perimeter annotation.
Declaration
public PdfViewerBuilder PerimeterSettings(PdfViewerPerimeterSettings perimeterSettings)
Parameters
Returns
PerimeterSettings(Action<PdfViewerPerimeterSettingsBuilder>)
Declaration
public PdfViewerBuilder PerimeterSettings(Action<PdfViewerPerimeterSettingsBuilder> perimeterSettings)
Parameters
Returns
PolygonSettings(PdfViewerPolygonSettings)
Defines the settings of polygon annotation.
Declaration
public PdfViewerBuilder PolygonSettings(PdfViewerPolygonSettings polygonSettings)
Parameters
Returns
PolygonSettings(Action<PdfViewerPolygonSettingsBuilder>)
Declaration
public PdfViewerBuilder PolygonSettings(Action<PdfViewerPolygonSettingsBuilder> polygonSettings)
Parameters
Returns
PrintEnd(String)
Triggers when the print actions are completed.
Declaration
public PdfViewerBuilder PrintEnd(string printEnd)
Parameters
| Type |
Name |
Description |
| System.String |
printEnd |
|
Returns
PrintMode(PrintMode)
Specifies the print mode in the PDF Viewer.
Declaration
public PdfViewerBuilder PrintMode(PrintMode printMode)
Parameters
Returns
PrintStart(String)
Triggers when the print action is initiated.
Declaration
public PdfViewerBuilder PrintStart(string printStart)
Parameters
| Type |
Name |
Description |
| System.String |
printStart |
|
Returns
Get or set the radio button field settings.
Declaration
public PdfViewerBuilder RadioButtonFieldSettings(PdfViewerRadioButtonFieldSettings radioButtonFieldSettings)
Parameters
Returns
Declaration
public PdfViewerBuilder RadioButtonFieldSettings(Action<PdfViewerRadioButtonFieldSettingsBuilder> radioButtonFieldSettings)
Parameters
Returns
RadiusSettings(PdfViewerRadiusSettings)
Defines the settings of radius annotation.
Declaration
public PdfViewerBuilder RadiusSettings(PdfViewerRadiusSettings radiusSettings)
Parameters
Returns
RadiusSettings(Action<PdfViewerRadiusSettingsBuilder>)
Declaration
public PdfViewerBuilder RadiusSettings(Action<PdfViewerRadiusSettingsBuilder> radiusSettings)
Parameters
Returns
RectangleSettings(PdfViewerRectangleSettings)
Defines the settings of rectangle annotation.
Declaration
public PdfViewerBuilder RectangleSettings(PdfViewerRectangleSettings rectangleSettings)
Parameters
Returns
RectangleSettings(Action<PdfViewerRectangleSettingsBuilder>)
Declaration
public PdfViewerBuilder RectangleSettings(Action<PdfViewerRectangleSettingsBuilder> rectangleSettings)
Parameters
Returns
RemoveSignature(String)
Triggers when the signature is removed from the page of a PDF document.
Declaration
public PdfViewerBuilder RemoveSignature(string removeSignature)
Parameters
| Type |
Name |
Description |
| System.String |
removeSignature |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
| Type |
Description |
| Microsoft.AspNetCore.Html.HtmlString |
|
ResizeSignature(String)
Triggers when the signature is resized and placed on a page of a PDF document.
Declaration
public PdfViewerBuilder ResizeSignature(string resizeSignature)
Parameters
| Type |
Name |
Description |
| System.String |
resizeSignature |
|
Returns
RestrictZoomRequest(Boolean)
Declaration
public PdfViewerBuilder RestrictZoomRequest(bool restrictZoomRequest = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
restrictZoomRequest |
|
Returns
RetryCount(Double)
Specifies the retry count for the failed requests.
Declaration
public PdfViewerBuilder RetryCount(double retryCount)
Parameters
| Type |
Name |
Description |
| System.Double |
retryCount |
|
Returns
RetryStatusCodes(Double[])
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 PdfViewerBuilder RetryStatusCodes(double[] retryStatusCodes)
Parameters
| Type |
Name |
Description |
| System.Double[] |
retryStatusCodes |
|
Returns
RetryTimeout(Double)
Gets or sets the timeout for retries in seconds.
Declaration
public PdfViewerBuilder RetryTimeout(double retryTimeout)
Parameters
| Type |
Name |
Description |
| System.Double |
retryTimeout |
|
Returns
Defines the scroll settings.
Declaration
public PdfViewerBuilder ScrollSettings(PdfViewerScrollSettings scrollSettings)
Parameters
Returns
Declaration
public PdfViewerBuilder ScrollSettings(Action<PdfViewerScrollSettingsBuilder> scrollSettings)
Parameters
Returns
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
ServerActionSettings(PdfViewerServerActionSettings)
Defines the settings of the PDF Viewer service.
Declaration
public PdfViewerBuilder ServerActionSettings(PdfViewerServerActionSettings serverActionSettings)
Parameters
Returns
ServerActionSettings(Action<PdfViewerServerActionSettingsBuilder>)
Declaration
public PdfViewerBuilder ServerActionSettings(Action<PdfViewerServerActionSettingsBuilder> serverActionSettings)
Parameters
Returns
ServiceUrl(String)
Defines the service url of the PdfViewer control.
Declaration
public PdfViewerBuilder ServiceUrl(string serviceUrl)
Parameters
| Type |
Name |
Description |
| System.String |
serviceUrl |
|
Returns
ShapeLabelSettings(PdfViewerShapeLabelSettings)
Defines the settings of shape label.
Declaration
public PdfViewerBuilder ShapeLabelSettings(PdfViewerShapeLabelSettings shapeLabelSettings)
Parameters
Returns
ShapeLabelSettings(Action<PdfViewerShapeLabelSettingsBuilder>)
Declaration
public PdfViewerBuilder ShapeLabelSettings(Action<PdfViewerShapeLabelSettingsBuilder> shapeLabelSettings)
Parameters
Returns
ShowDigitalSignatureAppearance(Boolean)
Show or hide the digital signature appearance in the document.
Declaration
public PdfViewerBuilder ShowDigitalSignatureAppearance(bool showDigitalSignatureAppearance = true)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showDigitalSignatureAppearance |
|
Returns
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
SignatureDialogSettings(PdfViewerSignatureDialogSettings)
Get or set the signature dialog settings for signature field.
Declaration
public PdfViewerBuilder SignatureDialogSettings(PdfViewerSignatureDialogSettings signatureDialogSettings)
Parameters
Returns
SignatureDialogSettings(Action<PdfViewerSignatureDialogSettingsBuilder>)
Declaration
public PdfViewerBuilder SignatureDialogSettings(Action<PdfViewerSignatureDialogSettingsBuilder> signatureDialogSettings)
Parameters
Returns
SignatureFieldSettings(PdfViewerSignatureFieldSettings)
Get or set the signature field settings.
Declaration
public PdfViewerBuilder SignatureFieldSettings(PdfViewerSignatureFieldSettings signatureFieldSettings)
Parameters
Returns
SignatureFieldSettings(Action<PdfViewerSignatureFieldSettingsBuilder>)
Declaration
public PdfViewerBuilder SignatureFieldSettings(Action<PdfViewerSignatureFieldSettingsBuilder> signatureFieldSettings)
Parameters
Returns
SignatureFitMode(SignatureFitMode)
Specifies the signature mode in the PDF Viewer.
Declaration
public PdfViewerBuilder SignatureFitMode(SignatureFitMode signatureFitMode)
Parameters
Returns
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
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
StampSettings(PdfViewerStampSettings)
Defines the settings of stamp annotation.
Declaration
public PdfViewerBuilder StampSettings(PdfViewerStampSettings stampSettings)
Parameters
Returns
StampSettings(Action<PdfViewerStampSettingsBuilder>)
Declaration
public PdfViewerBuilder StampSettings(Action<PdfViewerStampSettingsBuilder> stampSettings)
Parameters
Returns
StickyNotesSettings(PdfViewerStickyNotesSettings)
Defines the settings of stickyNotes annotation.
Declaration
public PdfViewerBuilder StickyNotesSettings(PdfViewerStickyNotesSettings stickyNotesSettings)
Parameters
Returns
StickyNotesSettings(Action<PdfViewerStickyNotesSettingsBuilder>)
Declaration
public PdfViewerBuilder StickyNotesSettings(Action<PdfViewerStickyNotesSettingsBuilder> stickyNotesSettings)
Parameters
Returns
StrikethroughSettings(PdfViewerStrikethroughSettings)
Defines the settings of strikethrough annotation.
Declaration
public PdfViewerBuilder StrikethroughSettings(PdfViewerStrikethroughSettings strikethroughSettings)
Parameters
Returns
StrikethroughSettings(Action<PdfViewerStrikethroughSettingsBuilder>)
Declaration
public PdfViewerBuilder StrikethroughSettings(Action<PdfViewerStrikethroughSettingsBuilder> strikethroughSettings)
Parameters
Returns
TextFieldSettings(PdfViewerTextFieldSettings)
Get or set the text field settings.
Declaration
public PdfViewerBuilder TextFieldSettings(PdfViewerTextFieldSettings textFieldSettings)
Parameters
Returns
TextFieldSettings(Action<PdfViewerTextFieldSettingsBuilder>)
Declaration
public PdfViewerBuilder TextFieldSettings(Action<PdfViewerTextFieldSettingsBuilder> textFieldSettings)
Parameters
Returns
TextSearchColorSettings(PdfViewerTextSearchColorSettings)
Sets the settings for the color of the text search highlight.
Declaration
public PdfViewerBuilder TextSearchColorSettings(PdfViewerTextSearchColorSettings textSearchColorSettings)
Parameters
Returns
TextSearchColorSettings(Action<PdfViewerTextSearchColorSettingsBuilder>)
Declaration
public PdfViewerBuilder TextSearchColorSettings(Action<PdfViewerTextSearchColorSettingsBuilder> textSearchColorSettings)
Parameters
Returns
TextSearchComplete(String)
Triggers when the text search is completed.
Declaration
public PdfViewerBuilder TextSearchComplete(string textSearchComplete)
Parameters
| Type |
Name |
Description |
| System.String |
textSearchComplete |
|
Returns
TextSearchHighlight(String)
Triggers when the text search text is highlighted.
Declaration
public PdfViewerBuilder TextSearchHighlight(string textSearchHighlight)
Parameters
| Type |
Name |
Description |
| System.String |
textSearchHighlight |
|
Returns
TextSearchStart(String)
Triggers when the text search is initiated.
Declaration
public PdfViewerBuilder TextSearchStart(string textSearchStart)
Parameters
| Type |
Name |
Description |
| System.String |
textSearchStart |
|
Returns
TextSelectionEnd(String)
Triggers when the text selection is complete.
Declaration
public PdfViewerBuilder TextSelectionEnd(string textSelectionEnd)
Parameters
| Type |
Name |
Description |
| System.String |
textSelectionEnd |
|
Returns
TextSelectionStart(String)
Triggers when the text selection is initiated.
Declaration
public PdfViewerBuilder TextSelectionStart(string textSelectionStart)
Parameters
| Type |
Name |
Description |
| System.String |
textSelectionStart |
|
Returns
ThumbnailClick(String)
Triggers when the thumbnail in the PDF Viewer's thumbnail panel is clicked.
Declaration
public PdfViewerBuilder ThumbnailClick(string thumbnailClick)
Parameters
| Type |
Name |
Description |
| System.String |
thumbnailClick |
|
Returns
TileRenderingSettings(PdfViewerTileRenderingSettings)
Defines the tile rendering settings.
Declaration
public PdfViewerBuilder TileRenderingSettings(PdfViewerTileRenderingSettings tileRenderingSettings)
Parameters
Returns
TileRenderingSettings(Action<PdfViewerTileRenderingSettingsBuilder>)
Declaration
public PdfViewerBuilder TileRenderingSettings(Action<PdfViewerTileRenderingSettingsBuilder> tileRenderingSettings)
Parameters
Returns
Defines the settings of the PDF Viewer toolbar.
Declaration
public PdfViewerBuilder ToolbarSettings(PdfViewerToolbarSettings toolbarSettings)
Parameters
Returns
Declaration
public PdfViewerBuilder ToolbarSettings(Action<PdfViewerToolbarSettingsBuilder> toolbarSettings)
Parameters
Returns
UnderlineSettings(PdfViewerUnderlineSettings)
Defines the settings of underline annotation.
Declaration
public PdfViewerBuilder UnderlineSettings(PdfViewerUnderlineSettings underlineSettings)
Parameters
Returns
UnderlineSettings(Action<PdfViewerUnderlineSettingsBuilder>)
Declaration
public PdfViewerBuilder UnderlineSettings(Action<PdfViewerUnderlineSettingsBuilder> underlineSettings)
Parameters
Returns
Triggers when validation is failed.
Declaration
public PdfViewerBuilder ValidateFormFields(string validateFormFields)
Parameters
| Type |
Name |
Description |
| System.String |
validateFormFields |
|
Returns
VolumeSettings(PdfViewerVolumeSettings)
Defines the settings of volume annotation.
Declaration
public PdfViewerBuilder VolumeSettings(PdfViewerVolumeSettings volumeSettings)
Parameters
Returns
VolumeSettings(Action<PdfViewerVolumeSettingsBuilder>)
Declaration
public PdfViewerBuilder VolumeSettings(Action<PdfViewerVolumeSettingsBuilder> volumeSettings)
Parameters
Returns
Width(Double)
Defines the scrollable width of the PdfViewer control.
Declaration
public PdfViewerBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
Width(String)
Defines the scrollable width of the PdfViewer control.
Declaration
public PdfViewerBuilder Width(string width)
Parameters
| Type |
Name |
Description |
| System.String |
width |
|
Returns
ZoomChange(String)
Triggers When the magnification value changes.
Declaration
public PdfViewerBuilder ZoomChange(string zoomChange)
Parameters
| Type |
Name |
Description |
| System.String |
zoomChange |
|
Returns
ZoomMode(ZoomMode)
Specifies the rendering mode in the PDF Viewer.
Declaration
public PdfViewerBuilder ZoomMode(ZoomMode zoomMode)
Parameters
Returns
ZoomValue(Double)
Sets the initial loading zoom value from 10 to 400 in the PDF Viewer Control.
Declaration
public PdfViewerBuilder ZoomValue(double zoomValue)
Parameters
| Type |
Name |
Description |
| System.Double |
zoomValue |
|
Returns
