Class PdfViewer

Class PdfViewer.

Inheritance
System.Object
CommonDataBoundControl
PdfViewer
Implements
System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService
System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler
Inherited Members
Namespace: Syncfusion.JavaScript.Web
Assembly: Syncfusion.EJ.Web.dll
Syntax
public class PdfViewer : CommonDataBoundControl, IPostBackDataHandler, IUrlResolutionService, INamingContainer, IPostBackEventHandler

Constructors

PdfViewer()

Declaration
public PdfViewer()

Fields

model

Declaration
public PdfViewerProperties model
Field Value
Type Description
PdfViewerProperties

Properties

AfterPrint

Triggers when PDF viewer control after Print.

Declaration
[JsonProperty("afterPrint")]
public string AfterPrint { get; set; }
Property Value
Type Description
System.String

AjaxRequestFailure

Triggers when the ajax request is failed in the PDF Viewer.

Declaration
[JsonProperty("ajaxRequestFailure")]
public string AjaxRequestFailure { get; set; }
Property Value
Type Description
System.String

AjaxRequestSuccess

Triggers when the ajax request is success in the PDF Viewer.

Declaration
[JsonProperty("ajaxrequestSuccess")]
public string AjaxRequestSuccess { get; set; }
Property Value
Type Description
System.String

AllowClientBuffering

Enables/Disables the buffering in the client.

Declaration
[JsonProperty("allowClientBuffering")]
[JsonConverter(typeof(DataManagerConverter))]
public bool AllowClientBuffering { get; set; }
Property Value
Type Description
System.Boolean

The allow client buffering.

AnnotationAdd

Triggers when annotation is added to the PDF document.

Declaration
[JsonProperty("annotationAdd")]
public string AnnotationAdd { get; set; }
Property Value
Type Description
System.String

AnnotationPropertiesChange

Triggers when the property of the annotation is changed in the PDF viewer control.

Declaration
[JsonProperty("annotationPropertiesChange")]
public string AnnotationPropertiesChange { get; set; }
Property Value
Type Description
System.String

AnnotationRemove

Triggers when annotation is removed from the PDF document.

Declaration
[JsonProperty("annotationRemove")]
public string AnnotationRemove { get; set; }
Property Value
Type Description
System.String

AnnotationResize

Triggers when the annotation is resized in the PDF viewer control.

Declaration
[JsonProperty("annotationResize")]
public string AnnotationResize { get; set; }
Property Value
Type Description
System.String

BeforePrint

Triggers when PDF viewer control before Print.

Declaration
[JsonProperty("beforePrint")]
public string BeforePrint { get; set; }
Property Value
Type Description
System.String

BufferEnd

Triggers when the client side buffering process ends.

Declaration
[JsonProperty("bufferEnd")]
public string BufferEnd { get; set; }
Property Value
Type Description
System.String

BufferingMode

Gets or sets the buffering mode of the PDF viewer control when allowBufferingMode is set to true.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("bufferingMode")]
public BufferingMode BufferingMode { get; set; }
Property Value
Type Description
BufferingMode

The buffering mode.

BufferStart

Triggers when the client side buffering process starts.

Declaration
[JsonProperty("bufferStart")]
public string BufferStart { get; set; }
Property Value
Type Description
System.String

Destroy

Triggers when PDF viewer control is destroyed successfully.

Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type Description
System.String

DocumentLoaded

Triggers when the PDF document gets loaded and is ready to view in the Control.

Declaration
[JsonProperty("documentLoad")]
public string DocumentLoaded { get; set; }
Property Value
Type Description
System.String

DocumentPath

Specifies the path of the PDF document to be loaded initially.

Declaration
[JsonProperty("documentPath")]
[JsonConverter(typeof(DataManagerConverter))]
public string DocumentPath { get; set; }
Property Value
Type Description
System.String

The Document path.

DocumentUnload

Triggers when the PDF document gets unloaded from the Control.

Declaration
[JsonProperty("documentUnload")]
public string DocumentUnload { get; set; }
Property Value
Type Description
System.String

DownloadEnd

Triggers when the download is completed or aborted in the PDF Viewer.

Declaration
[JsonProperty("downloadEnd")]
public string DownloadEnd { get; set; }
Property Value
Type Description
System.String

DownloadStart

Triggers when the download is started in the PDF Viewer.

Declaration
[JsonProperty("downloadStart")]
public string DownloadStart { get; set; }
Property Value
Type Description
System.String

EnableFormFieldValidation

Enables/Disables the download if required formfields is not filled in the PDF document.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("enableFormFieldValidation")]
public bool EnableFormFieldValidation { get; set; }
Property Value
Type Description
System.Boolean

The enableFormFieldValidation.

EnableHighlightAnnotation

Enables/Disables the highlight annotation.

Declaration
[JsonProperty("enableHighlightAnnotation")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnableHighlightAnnotation { get; set; }
Property Value
Type Description
System.Boolean

The enableHighlightAnnotation.

EnableSignature

Enables or disables the handwritten signature when the PDF viewer control is loaded initially.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("enableSignature")]
public bool EnableSignature { get; set; }
Property Value
Type Description
System.Boolean

The enablesignature.

EnableStrikethroughAnnotation

Enables/Disables the strikethrough annotation.

Declaration
[JsonProperty("enableStrikethroughAnnotation")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnableStrikethroughAnnotation { get; set; }
Property Value
Type Description
System.Boolean

The enableStrikethroughAnnotation.

EnableTextMarkupAnnotations

Enables/Disables the text markup annotation.

Declaration
[JsonProperty("enableTextMarkupAnnotations")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnableTextMarkupAnnotations { get; set; }
Property Value
Type Description
System.Boolean

The enableTextMarkupAnnotations.

EnableTextSelection

Enables/Disables the text selection.

Declaration
[JsonProperty("enableTextSelection")]
[JsonConverter(typeof(DataManagerConverter))]
public bool EnableTextSelection { get; set; }
Property Value
Type Description
System.Boolean

The enableTextSelection.

EnableUnderlineAnnotation

Enables/Disables the underline annotation.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("enableUnderlineAnnotation")]
public bool EnableUnderlineAnnotation { get; set; }
Property Value
Type Description
System.Boolean

The enableUnderlineAnnotation.

FormFieldValid

Triggers when required form fields are not filled.

Declaration
[JsonProperty("formFieldValid")]
public string FormFieldValid { get; set; }
Property Value
Type Description
System.String

HighlightSettings

Specifies the highlight settings.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("highlightSettings")]
public PdfViewerHighlightSettings HighlightSettings { get; set; }
Property Value
Type Description
PdfViewerHighlightSettings

The highlight Settings.

HyperlinkClicked

Triggers when PDF viewer control clicks hyperlink.

Declaration
[JsonProperty("hyperlinkClick")]
public string HyperlinkClicked { get; set; }
Property Value
Type Description
System.String

InteractionMode

To set the text selection or scrolling mode to the PDF viewer control..

Declaration
[JsonProperty("interactionMode")]
[JsonConverter(typeof(StringEnumConverter))]
public InteractionMode InteractionMode { get; set; }
Property Value
Type Description
InteractionMode

The selectionMode.

Locale

Declaration
[JsonProperty("locale")]
[JsonConverter(typeof(DataManagerConverter))]
public string Locale { get; set; }
Property Value
Type Description
System.String

Model

Gets or sets the PdfViewer model.

Declaration
[CLSCompliant(false)]
public PdfViewerProperties Model { get; set; }
Property Value
Type Description
PdfViewerProperties

The model.

PageChanged

Triggers when there is change in current page number.

Declaration
[JsonProperty("pageChange")]
public string PageChanged { get; set; }
Property Value
Type Description
System.String

PdfService

Specifies the PdfService.

Declaration
[JsonProperty("pdfService")]
[JsonConverter(typeof(StringEnumConverter))]
public PdfService PdfService { get; set; }
Property Value
Type Description
PdfService

The processing mode.

ServerActionSettings

Specifies the server action Settings.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("serverActionSettings")]
public PdfViewerServerActionSettings ServerActionSettings { get; set; }
Property Value
Type Description
PdfViewerServerActionSettings

The server action Settings.

ServiceUrl

Specifies the report Web API service url.

Declaration
[JsonProperty("serviceUrl")]
[JsonConverter(typeof(DataManagerConverter))]
public string ServiceUrl { get; set; }
Property Value
Type Description
System.String

The report service URL.

ShouldFlattenDocument

Enables or disables the option to flatten the document while saving the handwritten signature into the PDF document.

Declaration
[JsonProperty("shouldFlattenDocument")]
[JsonConverter(typeof(DataManagerConverter))]
public bool ShouldFlattenDocument { get; set; }
Property Value
Type Description
System.Boolean

The flatten signature.

SignatureAdd

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

Declaration
[JsonProperty("signatureAdd")]
public string SignatureAdd { get; set; }
Property Value
Type Description
System.String

SignatureDelete

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

Declaration
[JsonProperty("signatureDelete")]
public string SignatureDelete { get; set; }
Property Value
Type Description
System.String

SignatureMove

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

Declaration
[JsonProperty("signatureMove")]
public string SignatureMove { get; set; }
Property Value
Type Description
System.String

SignaturePropertiesChange

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

Declaration
[JsonProperty("signaturePropertiesChange")]
public string SignaturePropertiesChange { get; set; }
Property Value
Type Description
System.String

SignatureResize

Triggers when a handwritten signature is resized in the PDF document.

Declaration
[JsonProperty("signatureResize")]
public string SignatureResize { get; set; }
Property Value
Type Description
System.String

SignatureSettings

Gets or sets the settings of the handwritten signature.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("signatureSettings")]
public PdfViewerSignatureSettings SignatureSettings { get; set; }
Property Value
Type Description
PdfViewerSignatureSettings

The signature Settings.

StrikethroughSettings

Specifies the strikethrough settings.

Declaration
[JsonProperty("strikethroughSettings")]
[JsonConverter(typeof(DataManagerConverter))]
public PdfViewerStrikethroughSettings StrikethroughSettings { get; set; }
Property Value
Type Description
PdfViewerStrikethroughSettings

The strikethrough Settings.

ToolbarSettings

Specifies the toolbar settings.

Declaration
[JsonProperty("toolbarSettings")]
[JsonConverter(typeof(DataManagerConverter))]
public PdfViewerToolbarSettings ToolbarSettings { get; set; }
Property Value
Type Description
PdfViewerToolbarSettings

The toolbar settings.

UnderlineSettings

Specifies the underline settings.

Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("underlineSettings")]
public PdfViewerUnderlineSettings UnderlineSettings { get; set; }
Property Value
Type Description
PdfViewerUnderlineSettings

The Underline Settings.

ZoomChanged

Triggers when there is change in the magnification value.

Declaration
[JsonProperty("zoomChange")]
public string ZoomChanged { get; set; }
Property Value
Type Description
System.String

Methods

DependentScripts()

Declaration
public List<string> DependentScripts()
Returns
Type Description
System.Collections.Generic.List<System.String>

GetDependentFiles()

Adding dependent scripts.

Declaration
public override List<string> GetDependentFiles()
Returns
Type Description
System.Collections.Generic.List<System.String>

Script files.
Overrides

LoadViewState(Object)

Loads the state of the view state.

Declaration
protected override void LoadViewState(object state)
Parameters
Type Name Description
System.Object state

The state.
Overrides

OnInit(EventArgs)

Declaration
protected override void OnInit(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnPreRender(EventArgs)

Declaration
protected override void OnPreRender(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

RaisePostBackEvent(String)

Declaration
public void RaisePostBackEvent(string EventArgument)
Parameters
Type Name Description
System.String EventArgument

Render()

Renders the instance of PdfViewer.

Declaration
public string Render()
Returns
Type Description
System.String

System.String.

Render(HtmlTextWriter)

Renders the control to the specified HTML writer.

Declaration
protected override void Render(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer

The System.Web.UI.HtmlTextWriter object that receives the control content.
Overrides

SaveViewState()

Saves any view-state changes that have occurred since the time the page was posted back to the server.

Declaration
protected override object SaveViewState()
Returns
Type Description
System.Object

The control's current view state. If there is no view state associated with the control, this method returns null.

UpdateServerModel(Dictionary<String, Object>)

Updates the server model.

Declaration
public override void UpdateServerModel(Dictionary<string, object> ClientModel)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<System.String, System.Object> ClientModel

The client model.
Overrides

Implements

System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService
System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler