Class AnnotationSelectEventArgs

This event arguments provides the necessary information about annotation select event.

Inheritance

object

BaseEventArgs<AnnotationSelectEventArgs>

AnnotationSelectEventArgs

Inherited Members

BaseEventArgs<AnnotationSelectEventArgs>.Name

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.SfPdfViewer

Assembly: Syncfusion.Blazor.SfPdfViewer.dll

Syntax

public class AnnotationSelectEventArgs : BaseEventArgs<AnnotationSelectEventArgs>

Constructors

AnnotationSelectEventArgs()

Declaration

public AnnotationSelectEventArgs()

Properties

AnnotationCollection

Defines the overlapped annotations of the selected annotation.

Declaration

[JsonPropertyName("annotationCollection")]
[JsonInclude]
public List<PdfAnnotation> AnnotationCollection { get; }

Property Value

Type	Description
List<PdfAnnotation>	A list of PdfAnnotation objects that overlap with the currently selected annotation.

AnnotationId

Defines the id of the annotation selected in the page of the PDF document.

Declaration

[JsonPropertyName("annotationId")]
[JsonInclude]
public string AnnotationId { get; }

Property Value

Type	Description
string	Accepts the string value.

AnnotationProperties

Defines the annotation selected in the PDF document.

Declaration

[JsonPropertyName("annotation")]
[JsonInclude]
public PdfAnnotationProperties AnnotationProperties { get; }

Property Value

Type	Description
PdfAnnotationProperties	A PdfAnnotationProperties object representing the properties of the selected PDF annotation.

IsProgrammaticSelection

Defines the annotation selection by mouse.

Declaration

[JsonPropertyName("isProgrammaticSelection")]
[JsonInclude]
public bool IsProgrammaticSelection { get; }

Property Value

Type	Description
bool	`true`, if the current annotation selection was made programmatically. Otherwise, `false`.

MultiplePageCollection

Gets the multi page annotation collections.

Declaration

[JsonPropertyName("multiplePageCollection")]
[JsonInclude]
public List<PdfAnnotation> MultiplePageCollection { get; }

Property Value

Type	Description
List<PdfAnnotation>	A list of PdfAnnotation objects that span multiple pages of the PDF document.

Remarks

It is applicable only set EnableMultiPageAnnotation as true. This support has been provided only for Textmarkup annotation.

PageNumber

Gets the page number in which the annotation is selected.

Declaration

[JsonPropertyName("pageIndex")]
[JsonInclude]
public int PageNumber { get; }

Property Value

Type	Description
int	Accepts an integer value.