Class PdfViewerEvents
Inheritance
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.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> | An event callback function. |
AjaxRequestFailed
Triggers when the AJAX request is failed.
Declaration
public EventCallback<AjaxRequestFailureEventArgs> AjaxRequestFailed { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<AjaxRequestFailureEventArgs> | An event callback function. |
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> | An event callback function. |
AnnotationMouseover
Triggers when mouse over the annotation object.
Declaration
public EventCallback<AnnotationMouseoverEventArgs> AnnotationMouseover { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<AnnotationMouseoverEventArgs> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
Examples
<SfPdfViewer2>
<PdfViewerEvents AnnotationUnSelected="annotationUnSelected"></PdfViewerEvents>
</SfPdfViewer2>
@code {
public void annotationUnSelected(AnnotationUnSelectEventArgs args)
{
}
}
CommandExecuted
Represents the method to be called when the designated command is invoked.
Declaration
public EventCallback<CommandExecutedEventArgs> CommandExecuted { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<CommandExecutedEventArgs> | Represents an event callback function. |
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> | An event callback function. |
DocumentEdited
Trigger an event when the document getting edited
Declaration
public EventCallback<DocumentEditedEventArgs> DocumentEdited { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<DocumentEditedEventArgs> | An event callback function |
Remarks
Use this property to subscribe to the event that provide a callback function that will be executed when the document edited.
DocumentLoaded
Triggers while loading document into PdfViewer.
Declaration
public EventCallback<LoadEventArgs> DocumentLoaded { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<LoadEventArgs> | An event callback function. |
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> | An event callback function. |
DocumentUnloaded
Triggers while close the document
Declaration
public EventCallback<UnloadEventArgs> DocumentUnloaded { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<UnloadEventArgs> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
PageMouseover
Triggers when mouse over the page.
Declaration
public EventCallback<PageMouseoverEventArgs> PageMouseover { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<PageMouseoverEventArgs> | An event callback function. |
Parent
Represent Pdf Viewer component.
Declaration
protected PdfViewerBase Parent { get; set; }
Property Value
Type |
---|
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
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> | An event callback function. |
ToolbarClicked
Triggers an event when a Custom Toolbar Item is clicked in the Toolbar.
Declaration
public EventCallback<ClickEventArgs> ToolbarClicked { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<ClickEventArgs> | An event callback function. |
Remarks
Use this property to assign a function or method to handle the click event of the Custom Toolbar Item.
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> | An event callback function. |
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> | An event callback function. |
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 |
---|
System.Threading.Tasks.Task |