Class PdfViewerEvents

Inheritance

System.Object

SfBaseComponent

PdfViewerEvents

Inherited Members

SfBaseComponent.OnAfterRenderAsync(Boolean)

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.PdfViewer

Assembly: Syncfusion.Blazor.dll

Syntax

public class PdfViewerEvents : SfBaseComponent

Constructors

PdfViewerEvents()

Declaration

public PdfViewerEvents()

Properties

AddSignature

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

Declaration

public EventCallback<AddSignatureEventArgs> AddSignature { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AddSignatureEventArgs>

AjaxRequestFailed

Triggers when the AJAX request is failed.

Declaration

public EventCallback<AjaxRequestFailureEventArgs> AjaxRequestFailed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AjaxRequestFailureEventArgs>

AnnotationAdded

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

Declaration

public EventCallback<AnnotationAddEventArgs> AnnotationAdded { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationAddEventArgs>

AnnotationMouseover

Triggers when mouse over the annotation object.

Declaration

public EventCallback<AnnotationMouseoverEventArgs> AnnotationMouseover { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationMouseoverEventArgs>

AnnotationMoved

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

Declaration

public EventCallback<AnnotationMoveEventArgs> AnnotationMoved { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationMoveEventArgs>

Remarks

AnnotationMove event is not applicable for text markup annotations.

AnnotationPropertiesChanged

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

Declaration

public EventCallback<AnnotationPropertiesChangeEventArgs> AnnotationPropertiesChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationPropertiesChangeEventArgs>

AnnotationRemoved

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

Declaration

public EventCallback<AnnotationRemoveEventArgs> AnnotationRemoved { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationRemoveEventArgs>

AnnotationResized

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

Declaration

public EventCallback<AnnotationResizeEventArgs> AnnotationResized { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationResizeEventArgs>

Remarks

This event does not applicable for Sticky note annotation.

AnnotationSelected

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

Declaration

public EventCallback<AnnotationSelectEventArgs> AnnotationSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationSelectEventArgs>

AnnotationUnselected

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

Declaration

public EventCallback<AnnotationUnselectEventArgs> AnnotationUnselected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationUnselectEventArgs>

Examples

   <SfPdfViewerServer>
        <PdfViewerEvents AnnotationUnSelected="AnnotationUnSelected"></PdfViewerEvents>
   </SfPdfViewerServer>
 @code {
   public void AnnotationUnSelected(AnnotationUnSelectEventArgs args)
   {
   }
 }

Created

Triggers when the PdfViewer component is created.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DocumentLoaded

Triggers while loading document into PdfViewer.

Declaration

public EventCallback<LoadEventArgs> DocumentLoaded { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LoadEventArgs>

DocumentLoadFailed

Triggers while loading document got failed in PdfViewer.

Declaration

public EventCallback<LoadFailedEventArgs> DocumentLoadFailed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LoadFailedEventArgs>

DocumentUnloaded

Triggers while close the document

Declaration

public EventCallback<UnloadEventArgs> DocumentUnloaded { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<UnloadEventArgs>

DownloadEnd

Triggers an event when the download actions is finished.

Declaration

public EventCallback<DownloadEndEventArgs> DownloadEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DownloadEndEventArgs>

DownloadStart

Triggers an event when the download action is started.

Declaration

public EventCallback<DownloadStartEventArgs> DownloadStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DownloadStartEventArgs>

ExportFailed

Triggers when an export annotations failed in the PDF Viewer.

Declaration

public EventCallback<ExportFailureEventArgs> ExportFailed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ExportFailureEventArgs>

ExportStarted

Triggers when an exported annotations started in the PDF Viewer.

Declaration

public EventCallback<ExportStartEventArgs> ExportStarted { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ExportStartEventArgs>

ExportSucceed

Triggers when an export annotations succeed in the PDF Viewer.

Declaration

public EventCallback<ExportSuccessEventArgs> ExportSucceed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ExportSuccessEventArgs>

ExtractTextCompleted

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

Declaration

public EventCallback<ExtractTextCompletedEventArgs> ExtractTextCompleted { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ExtractTextCompletedEventArgs>

FormFieldClick

Triggers an event when the form field is clicked.

Declaration

public EventCallback<FormFieldClickArgs> FormFieldClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FormFieldClickArgs>

ImportFailed

Triggers when an imports annotations failed in the PDF document.

Declaration

public EventCallback<ImportFailureEventArgs> ImportFailed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImportFailureEventArgs>

ImportStarted

Triggers when an imported annotations started in the PDF document.

Declaration

public EventCallback<ImportStartEventArgs> ImportStarted { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImportStartEventArgs>

ImportSucceed

Triggers when an imports annotations succeed in the PDF document.

Declaration

public EventCallback<ImportSuccessEventArgs> ImportSucceed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ImportSuccessEventArgs>

MoveSignature

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

Declaration

public EventCallback<MoveSignatureEventArgs> MoveSignature { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<MoveSignatureEventArgs>

OnAnnotationDoubleClick

Triggers an event when the annotation is double click.

Declaration

public EventCallback<AnnotationDoubleClickEventArgs> OnAnnotationDoubleClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AnnotationDoubleClickEventArgs>

OnHyperlinkClick

Triggers when hyperlink in the PDF Document is clicked

Declaration

public EventCallback<HyperlinkClickEventArgs> OnHyperlinkClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<HyperlinkClickEventArgs>

OnHyperlinkMouseOver

Triggers when hyperlink in the PDF Document is hovered

Declaration

public EventCallback<HyperlinkMouseOverArgs> OnHyperlinkMouseOver { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<HyperlinkMouseOverArgs>

OnPageClick

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

Declaration

public EventCallback<PageClickEventArgs> OnPageClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageClickEventArgs>

OnTextSearchComplete

Triggers an event when the text search is completed.

Declaration

public EventCallback<TextSearchCompleteEventArgs> OnTextSearchComplete { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TextSearchCompleteEventArgs>

OnTextSearchHighlight

Triggers an event when the text search text is highlighted.

Declaration

public EventCallback<TextSearchHighlightEventArgs> OnTextSearchHighlight { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TextSearchHighlightEventArgs>

OnTextSearchStart

Triggers an event when the text search is started.

Declaration

public EventCallback<TextSearchStartEventArgs> OnTextSearchStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TextSearchStartEventArgs>

OnTextSelectionEnd

Triggers an event when the text selection is finished.

Declaration

public EventCallback<TextSelectionEndEventArgs> OnTextSelectionEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TextSelectionEndEventArgs>

OnTextSelectionStart

Triggers an event when the text selection is started.

Declaration

public EventCallback<TextSelectionStartEventArgs> OnTextSelectionStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TextSelectionStartEventArgs>

OnThumbnailClick

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

Declaration

public EventCallback<ThumbnailClickEventArgs> OnThumbnailClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ThumbnailClickEventArgs>

PageChanged

Triggers when there is change in current page number.

Declaration

public EventCallback<PageChangeEventArgs> PageChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageChangeEventArgs>

PageMouseover

Triggers when mouse over the page.

Declaration

public EventCallback<PageMouseoverEventArgs> PageMouseover { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageMouseoverEventArgs>

Parent

Represent Pdf Viewer component.

Declaration

protected PdfViewerBase Parent { get; set; }

Property Value

Type	Description
PdfViewerBase

PrintEnd

Triggers an event when the print actions is finished.

Declaration

public EventCallback<PrintEndEventArgs> PrintEnd { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PrintEndEventArgs>

PrintStart

Triggers an event when the print action is started.

Declaration

public EventCallback<PrintStartEventArgs> PrintStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PrintStartEventArgs>

RemoveSignature

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

Declaration

public EventCallback<RemoveSignatureEventArgs> RemoveSignature { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RemoveSignatureEventArgs>

ResizeSignature

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

Declaration

public EventCallback<ResizeSignatureEventArgs> ResizeSignature { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ResizeSignatureEventArgs>

SignaturePropertiesChange

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

Declaration

public EventCallback<SignaturePropertiesChangeEventArgs> SignaturePropertiesChange { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SignaturePropertiesChangeEventArgs>

SignatureSelect

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

Declaration

public EventCallback<SignatureSelectEventArgs> SignatureSelect { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SignatureSelectEventArgs>

SignatureSelected

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

Declaration

public EventCallback<SignatureSelectEventArgs> SignatureSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SignatureSelectEventArgs>

SignatureUnselected

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

Declaration

public EventCallback<SignatureSelectEventArgs> SignatureUnselected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SignatureSelectEventArgs>

ValidateFormFields

Triggers when validation is failed. This event will be triggered if set enableFormValidations as true.

Declaration

public EventCallback<ValidateFormFieldsArgs> ValidateFormFields { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ValidateFormFieldsArgs>

ZoomChanged

Triggers when there is change in the magnification value.

Declaration

public EventCallback<ZoomChangeEventArgs> ZoomChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ZoomChangeEventArgs>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnInitializedAsync()