Class PdfAnnotation

Represents the attributes of the PDF annotation.

Inheritance
System.Object
PdfAnnotationProperties
PdfAnnotation
Inherited Members
Namespace: Syncfusion.Blazor.PdfViewer
Assembly: Syncfusion.Blazor.dll
Syntax
public class PdfAnnotation : PdfAnnotationProperties

Constructors

PdfAnnotation()

Declaration
public PdfAnnotation()

Properties

AllowedInteractions

Gets or sets the allowed interactions for the locked area annotations. IsLock can be configured using area settings.

Declaration
public List<AllowedInteraction> AllowedInteractions { get; set; }
Property Value
Type
System.Collections.Generic.List<AllowedInteraction>

AnnotationMode

Gets the mode of annotation to be added in the PDF document. Three different modes are Drawn, Import and Existing.

Declaration
public AnnotationMode AnnotationMode { get; set; }
Property Value
Type
AnnotationMode

AnnotationSettings

Gets the annotation settings.

Declaration
public PdfViewerAnnotationSettings AnnotationSettings { get; set; }
Property Value
Type
PdfViewerAnnotationSettings

Bound

Gets the bound of the annotations.

Declaration
public Bound Bound { get; }
Property Value
Type
Bound
Remarks

It is not applicable for text markup annotation.

Bounds

Gets the textmark annotation bounds details.

Declaration
public List<Bound> Bounds { get; }
Property Value
Type
System.Collections.Generic.List<Bound>

Comments

Gets the comments collection of the annotation.

Declaration
public List<Comment> Comments { get; }
Property Value
Type
System.Collections.Generic.List<Comment>

DynamicText

Gets default text of freetext annotaton.

Declaration
public string DynamicText { get; set; }
Property Value
Type
System.String

EnableShapeLabel

Gets the value to check whether the label for the shape and measure annotation is enabled or not. By default it is false.

Declaration
public bool EnableShapeLabel { get; set; }
Property Value
Type
System.Boolean

Id

Gets the unique Id for the annotation.

Declaration
public string Id { get; set; }
Property Value
Type
System.String

IdCollection

Gets the Id's collection of the textmarkup annotation.

Declaration
public List<string> IdCollection { get; set; }
Property Value
Type
System.Collections.Generic.List<System.String>
Remarks

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

Indent

Gets the intent of the measure annotation.

Declaration
public string Indent { get; set; }
Property Value
Type
System.String
Remarks

It is applicable only for measure annotation.

IsMultiSelect

Gets the value to check whether the textmarkup annotation added with multiple pages. By default it is false. If we add textmarkup annotation with multiple page region it will return true.

Declaration
public bool IsMultiSelect { get; }
Property Value
Type
System.Boolean
Remarks

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

IsPrint

Gets or sets the value for the individual annotations are included or not in print actions.

Declaration
public bool IsPrint { get; set; }
Property Value
Type
System.Boolean

LabelBorderColor

Gets or sets border color for the shape and measure annotation label.

Declaration
public string LabelBorderColor { get; set; }
Property Value
Type
System.String

LabelBound

Gets bound for label text of shape and measure annotation.

Declaration
public Bound LabelBound { get; }
Property Value
Type
Bound

LabelContent

Gets or sets content of the shape label.

Declaration
public string LabelContent { get; set; }
Property Value
Type
System.String

LabelFillColor

Gets or sets fillcolor for the shape and measure annotation label.

Declaration
public string LabelFillColor { get; set; }
Property Value
Type
System.String

LeaderLength

Gets the leader length of the annotation.

Declaration
public int LeaderLength { get; set; }
Property Value
Type
System.Int32

LeaderLineExtension

Gets the leader line extension of the measure annotation.

Declaration
public int LeaderLineExtension { get; set; }
Property Value
Type
System.Int32

LeaderLineOffset

Gets the leader line offset of the measure annotation.

Declaration
public int LeaderLineOffset { get; set; }
Property Value
Type
System.Int32

Note

Gets the note of the annotation. It represents comment text added for this annotation.

Declaration
public string Note { get; set; }
Property Value
Type
System.String

PageNumber

Gets the page number of the annotation.

Declaration
public int PageNumber { get; }
Property Value
Type
System.Int32

PageNumbers

Gets the page number collection of the textmarkup annotation.

Declaration
public List<int> PageNumbers { get; set; }
Property Value
Type
System.Collections.Generic.List<System.Int32>
Remarks

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

Rect

Gets the rectangle of the textmarkup annotation.

Declaration
public Rect Rect { get; set; }
Property Value
Type
Rect

Review

Gets the review status details of the comment.

Declaration
public Review Review { get; }
Property Value
Type
Review

UniqueKey

Gets or sets uniquekey for annotation.

Declaration
public string UniqueKey { get; set; }
Property Value
Type
System.String