Class PdfViewerPropertiesBuilder

Class PdfViewerPropertiesBuilder.

Inheritance

System.Object

PdfViewerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class PdfViewerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

PdfViewerPropertiesBuilder()

Declaration

public PdfViewerPropertiesBuilder()

PdfViewerPropertiesBuilder(PdfViewer)

Initializes a new instance of the PdfViewerPropertiesBuilder class.

Declaration

public PdfViewerPropertiesBuilder(PdfViewer pdfViewer)

Parameters

Type	Name	Description
PdfViewer	pdfViewer

Methods

AfterPrint(String)

Triggers after printing.

Declaration

public PdfViewerPropertiesBuilder AfterPrint(string afterPrint)

Parameters

Type	Name	Description
System.String	afterPrint

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

AjaxRequestFailure(String)

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

Declaration

public PdfViewerPropertiesBuilder AjaxRequestFailure(string ajaxRequestfailure)

Parameters

Type	Name	Description
System.String	ajaxRequestfailure

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

AjaxRequestSuccess(String)

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

Declaration

public PdfViewerPropertiesBuilder AjaxRequestSuccess(string ajaxRequestSuccess)

Parameters

Type	Name	Description
System.String	ajaxRequestSuccess

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

AllowClientBuffering(Boolean)

Enables/Disables the buffering process in the client.

Declaration

public PdfViewerPropertiesBuilder AllowClientBuffering(bool allowClientBuffering)

Parameters

Type	Name	Description
System.Boolean	allowClientBuffering	The allowClientBuffering.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

AnnotationAdd(String)

Triggers when annotation is added to the PDF document.

Declaration

public PdfViewerPropertiesBuilder AnnotationAdd(string annotationAdd)

Parameters

Type	Name	Description
System.String	annotationAdd	AnnotationAdd.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

AnnotationPropertiesChange(String)

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

Declaration

public PdfViewerPropertiesBuilder AnnotationPropertiesChange(string annotationPropertiesChange)

Parameters

Type	Name	Description
System.String	annotationPropertiesChange	AnnotationPropertiesChange.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

AnnotationRemove(String)

Triggers when annotation is removed from the PDF document.

Declaration

public PdfViewerPropertiesBuilder AnnotationRemove(string annotationRemove)

Parameters

Type	Name	Description
System.String	annotationRemove	AnnotationRemove.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

AnnotationResize(String)

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

Declaration

public PdfViewerPropertiesBuilder AnnotationResize(string annotationResize)

Parameters

Type	Name	Description
System.String	annotationResize	AnnotationResize.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

BeforePrint(String)

Triggers before printing.

Declaration

public PdfViewerPropertiesBuilder BeforePrint(string beforePrint)

Parameters

Type	Name	Description
System.String	beforePrint

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

BufferEnd(String)

Triggers when the client side buffering process ends.

Declaration

public PdfViewerPropertiesBuilder BufferEnd(string bufferEnd)

Parameters

Type	Name	Description
System.String	bufferEnd	bufferEnd.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

BufferingMode(BufferingMode)

Specifies the Buffering mode.

Declaration

public PdfViewerPropertiesBuilder BufferingMode(BufferingMode bufferingMode)

Parameters

Type	Name	Description
BufferingMode	bufferingMode	The buffering mode value.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

BufferStart(String)

Triggers when the client side buffering process starts.

Declaration

public PdfViewerPropertiesBuilder BufferStart(string bufferStart)

Parameters

Type	Name	Description
System.String	bufferStart	bufferStart.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

ClientSideEvents(Action<PDFViewerClientSideEventsBuilder>)

Declaration

public PdfViewerPropertiesBuilder ClientSideEvents(Action<PDFViewerClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<PDFViewerClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
PdfViewerPropertiesBuilder

Destroy(String)

Triggers when PDF viewer control is destroyed successfully.

Declaration

public PdfViewerPropertiesBuilder Destroy(string destroy)

Parameters

Type	Name	Description
System.String	destroy	Destroy.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

DocumentLoaded(String)

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

Declaration

public PdfViewerPropertiesBuilder DocumentLoaded(string documentLoad)

Parameters

Type	Name	Description
System.String	documentLoad	Document load.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

DocumentPath(String)

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

Declaration

public PdfViewerPropertiesBuilder DocumentPath(string documentPath)

Parameters

Type	Name	Description
System.String	documentPath	The document Name

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

DocumentUnload(String)

Triggers when the PDF document gets unloaded from the PDF Viewer.

Declaration

public PdfViewerPropertiesBuilder DocumentUnload(string documentUnload)

Parameters

Type	Name	Description
System.String	documentUnload	Document load.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

DownloadEnd(String)

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

Declaration

public PdfViewerPropertiesBuilder DownloadEnd(string downloadEnd)

Parameters

Type	Name	Description
System.String	downloadEnd

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

DownloadStart(String)

Triggers when the download is started in the PDF Viewer.

Declaration

public PdfViewerPropertiesBuilder DownloadStart(string downloadStart)

Parameters

Type	Name	Description
System.String	downloadStart

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

EnableFormFieldValidation(Boolean)

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

Declaration

public PdfViewerPropertiesBuilder EnableFormFieldValidation(bool enableFormFieldValidation)

Parameters

Type	Name	Description
System.Boolean	enableFormFieldValidation

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

EnableHighlightAnnotation(Boolean)

Enables/Disables the highlight annotations in the PDF viewer.

Declaration

public PdfViewerPropertiesBuilder EnableHighlightAnnotation(bool enableHighlightAnnotation)

Parameters

Type	Name	Description
System.Boolean	enableHighlightAnnotation	The EnableHighlightAnnotation.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

EnableSignature(Boolean)

Enables/Disables the signature in the PDF viewer.

Declaration

public PdfViewerPropertiesBuilder EnableSignature(bool enableSignature)

Parameters

Type	Name	Description
System.Boolean	enableSignature

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

EnableStrikethroughAnnotation(Boolean)

Enables/Disables the strikethrough annotations in the PDF viewer.

Declaration

public PdfViewerPropertiesBuilder EnableStrikethroughAnnotation(bool enableStrikethroughAnnotation)

Parameters

Type	Name	Description
System.Boolean	enableStrikethroughAnnotation	The EnableStrikethroughAnnotation.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

EnableTextMarkupAnnotations(Boolean)

Enables/Disables the text markup annotations in the PDF viewer.

Declaration

public PdfViewerPropertiesBuilder EnableTextMarkupAnnotations(bool enableTextMarkupAnnotations)

Parameters

Type	Name	Description
System.Boolean	enableTextMarkupAnnotations	The EnableTextMarkupAnnotations.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

EnableTextSelection(Boolean)

Enables/Disables the text selection in the PDF viewer.

Declaration

public PdfViewerPropertiesBuilder EnableTextSelection(bool enableTextSelection)

Parameters

Type	Name	Description
System.Boolean	enableTextSelection

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

EnableUnderlineAnnotation(Boolean)

Enables/Disables the underline annotations in the PDF viewer.

Declaration

public PdfViewerPropertiesBuilder EnableUnderlineAnnotation(bool enableUnderlineAnnotation)

Parameters

Type	Name	Description
System.Boolean	enableUnderlineAnnotation	The EnableUnderlineAnnotation.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

FormFieldValid(String)

Triggers when the required form fields are not in the PDF Viewer.

Declaration

public PdfViewerPropertiesBuilder FormFieldValid(string formFieldValid)

Parameters

Type	Name	Description
System.String	formFieldValid

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

HighlightSettings(Action<PdfViewerHighlightSettingsBuilder>)

Specifies the highlight settings.

Declaration

public PdfViewerPropertiesBuilder HighlightSettings(Action<PdfViewerHighlightSettingsBuilder> highlightSettings)

Parameters

Type	Name	Description
System.Action<PdfViewerHighlightSettingsBuilder>	highlightSettings	The Highlight settings

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

InteractionMode(Int32)

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

Declaration

public PdfViewerPropertiesBuilder InteractionMode(int interactionMode)

Parameters

Type	Name	Description
System.Int32	interactionMode

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

Locale(String)

Specifies the locale information of the PDF viewer.

Declaration

public PdfViewerPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale	The locale information.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

PageChanged(String)

Triggers when there is change in current page number.

Declaration

public PdfViewerPropertiesBuilder PageChanged(string pageChange)

Parameters

Type	Name	Description
System.String	pageChange	Page change

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

PdfService(PdfService)

Specifies the PDF Service.

Declaration

public PdfViewerPropertiesBuilder PdfService(PdfService pdfServiceUrl)

Parameters

Type	Name	Description
PdfService	pdfServiceUrl	The service value.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

Render()

Renders the PdfViewer instance.

Declaration

public void Render()

ServerActionSettings(Action<PdfViewerServerActionSettingsBuilder>)

Specifies the name of the methods available in the service.

Declaration

public PdfViewerPropertiesBuilder ServerActionSettings(Action<PdfViewerServerActionSettingsBuilder> serverActionSettings)

Parameters

Type	Name	Description
System.Action<PdfViewerServerActionSettingsBuilder>	serverActionSettings	The server Action Settings

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

ServiceUrl(String)

Specifies the service url.

Declaration

public PdfViewerPropertiesBuilder ServiceUrl(string pdfServiceUrl)

Parameters

Type	Name	Description
System.String	pdfServiceUrl	The service URL.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

SignatureAdd(String)

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

Declaration

public PdfViewerPropertiesBuilder SignatureAdd(string signatureAdd)

Parameters

Type	Name	Description
System.String	signatureAdd

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

SignatureDelete(String)

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

Declaration

public PdfViewerPropertiesBuilder SignatureDelete(string signatureDelete)

Parameters

Type	Name	Description
System.String	signatureDelete

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

SignatureMove(String)

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

Declaration

public PdfViewerPropertiesBuilder SignatureMove(string signatureMove)

Parameters

Type	Name	Description
System.String	signatureMove

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

SignaturePropertiesChange(String)

Triggers when a handwritten signature properties is changed in the PDF document.

Declaration

public PdfViewerPropertiesBuilder SignaturePropertiesChange(string signaturePropertiesChange)

Parameters

Type	Name	Description
System.String	signaturePropertiesChange	signaturePropertiesChange.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

SignatureResize(String)

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

Declaration

public PdfViewerPropertiesBuilder SignatureResize(string signatureResize)

Parameters

Type	Name	Description
System.String	signatureResize

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

SignatureSettings(Action<PdfViewerSignatureSettingsBuilder>)

Specifies the signature settings.

Declaration

public PdfViewerPropertiesBuilder SignatureSettings(Action<PdfViewerSignatureSettingsBuilder> signatureSettings)

Parameters

Type	Name	Description
System.Action<PdfViewerSignatureSettingsBuilder>	signatureSettings	The Signature settings

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

StrikethroughSettings(Action<PdfViewerStrikethroughSettingsBuilder>)

Specifies the strikethrough settings.

Declaration

public PdfViewerPropertiesBuilder StrikethroughSettings(Action<PdfViewerStrikethroughSettingsBuilder> strikethroughSettings)

Parameters

Type	Name	Description
System.Action<PdfViewerStrikethroughSettingsBuilder>	strikethroughSettings	The Strikethrough settings

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String	An HTML-encoded string.

ToolbarSettings(Action<PdfViewerToolbarSettingsBuilder>)

Specifies the toolbar settings.

Declaration

public PdfViewerPropertiesBuilder ToolbarSettings(Action<PdfViewerToolbarSettingsBuilder> toolbarSettings)

Parameters

Type	Name	Description
System.Action<PdfViewerToolbarSettingsBuilder>	toolbarSettings	The Toolbar settings.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

UnderlineSettings(Action<PdfViewerUnderlineSettingsBuilder>)

Specifies the underline settings.

Declaration

public PdfViewerPropertiesBuilder UnderlineSettings(Action<PdfViewerUnderlineSettingsBuilder> underlineSettings)

Parameters

Type	Name	Description
System.Action<PdfViewerUnderlineSettingsBuilder>	underlineSettings	The Underline settings

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

ZoomChanged(String)

Triggers when there is change in the magnification value.

Declaration

public PdfViewerPropertiesBuilder ZoomChanged(string zoomChange)

Parameters

Type	Name	Description
System.String	zoomChange	Zoom change.

Returns

Type	Description
PdfViewerPropertiesBuilder	PdfViewerPropertiesBuilder.

Implements

IPropertiesBuilder

System.Web.IHtmlString