Class PdfAnnotation
Represents the attributes of the PDF annotation.
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.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 or sets the bound of the PDF annotation.
Declaration
public Bound Bound { get; set; }
Property Value
Type |
---|
Bound |
Remarks
This property represents the boundary of the annotation in the SfPdfViewer. It is not applicable for text markup annotation.
Bounds
Gets or sets the bounds details of the text markup annotation.
Declaration
public List<Bound> Bounds { get; set; }
Property Value
Type |
---|
System.Collections.Generic.List<Bound> |
Remarks
This property represents the list of bounds associated with the text markup annotation in the SfPdfViewer.
Comments
Gets or sets the collection of comments details of the PDF annotation.
Declaration
public List<Comment> Comments { get; set; }
Property Value
Type |
---|
System.Collections.Generic.List<Comment> |
Remarks
This property represents a collection of comments related to the PDF annotation in the SfPdfViewer.
CustomStampSource
Gets or sets the custom stamp source for the PDF annotation.
Declaration
public string CustomStampSource { get; set; }
Property Value
Type |
---|
System.String |
Remarks
This property represents the image source of the custom stamp annotation in the SfPdfViewer. Note: It is applicable for custom stamp annotation.
Examples
PdfAnnotation annotation = new PdfAnnotation();
annotation.Type = AnnotationType.Image;
annotation.CustomStampSource = "data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAAMwAAADJCAMAAABYMS1zAAAAllBMVEX///8rNXz2kh7b3OXQ0d8jLnlMU4wfK3hYXpH5+fvz8/bv7/SRlbYAAGyLj7GMkLBGToqdoLt4fKS1t8vIydoAGHEXJXUMHnP1hAD1jAD9483+9u7707L4sXSDh6s0PoL3oE76xpr4qV/97d/5vov96NYADW/2m0b7zaX2mTv4t3v5uYT83cL4rms+R4YAAGX2kjBubpsmc7m7AAAEKUlEQVR4nO3c6VbiQBAF4Dai7AiikCbIjuyK7/9ykziTCJLuVLUcu5O5938d8x2kUr0chEAQBEEQpBgJbD/A9RLMVnPbz3C1LHw5Gdh+iCtl7Xue3AxtP8ZVMpReGOlNC/DF2Xt/I+U295rlRHoxZ5ZzzXyWWELNZGn7eX6SYHdiidrA3vYT/SBT3zuPXNt+JOOsv1tCzSKnX5y9vLB4nr/N5TQw8NIwnjzksA3MV6mWqKnlrg0EM4UlmgbyNtu8KC2fs43tx2NlobFEnDzNNmst5bMN5EYzzLKEmlVOmtpgo/8n+/fFyUVTW6ob2ZlG5qCpBbpGdhbf/QXbjmoJNTvHZ5sp3ZI521S7oxY93biqwSga3Wr+/ppjyZptaq3XMjm9Rox569Or3p/Ufz51UtZqdPs2tYf+DTl3CaZdplc11Zj5kWnxtAs2q5hANSlr4+9UTc0mRjMp6zWqfRubmK2ZJdRs0lu0RQyrKX/TTBzDEKZLVeQxfWPdGoY0XSosqpnTFka55KdgVK8aSxizpvzPolxEW8LMLvf7qPHVS2hrn4ypRreAttYADF8y2qMBe615aoTRHgxYfGkOjwYfjnbpbHOc2U/YCwD9EYfVqZm4lZHE32ktttczW05T818yNjTsYkRwcVim+R+bZG1nWMakHpcpLJvMPU3rGLGXtC+OzL6CYh8jlqT5mbKf6QDm/PRfFcq5swsYEewyLaRTZycwYVPLOGyiHc+4gYkW0bpzwMym7BZG7DUaSdwvdwYTzjaqN45PvRfoDkbMD+kan3zI5BBGBIs0jU8/N3cJk3rqLDMmZXcxlws21pm5Y5jvCzY54xz8uYYRy8PpzcbsSdlpjAhO9m2OvLN/9zDRbBNzmLcaHcQks41cMOucxIh91NTkjFvmJkYMVlJKdpWjmOi8k3+3xFWMCAxuljiLMUmxMKP3Z3JeWzFm3KRX6a6bXDfVpw4jyWNxihq6i0BX1rBiVPVrFgRBkIKkVmekZlSV9OaAEwNLtfvxSE9ye7bFKPpIXpovjBxMBs1Ws0dOPxln3p7pVV/jjGSEvCd7ivnNQZNzUA4MMMAAAwwwwAADDDDAAAMMMMAAAwwwwAADDDDAAAMMMMAAAwwwwPzvmOcCYVoFwlRLXUZKcRmnqJtcBBoysnb+lxkRBEEQSuq3jNTjKk6RYVUt/Xl1qXbuK/R04qpHRlE7mQAYRZV2SfHEmtQajN+e7T/GmArnt2fjC8TipnedX6xVYxhTc3mUYIxms/GdSRUHwxg0gQEGGGCAAQYYYIABBhhggAEGGGCAAQYYYIABBhhggAEGGGCAAaaImELdA3i9I6f3henTq5pfNzTK9CqjGxqdt3ty2g8x5qNNrxonmAq96H5sgBH1EiPJPdhbTlVyq4lTVDK41YQgCIIgCIIgSFr+AKg+KPUzaG6DAAAAAElFTkSuQmCC";
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 |
Remarks
true
if individual annotations are included in print actions; otherwise, false
.
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 or sets 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 or sets the page number of the PDF annotation.
Declaration
public int PageNumber { get; set; }
Property Value
Type |
---|
System.Int32 |
Remarks
This property represents the page number associated with the PDF annotation in the SfPdfViewer.
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 or sets the review status details of the PDF annotation Comments.
Declaration
public Review Review { get; set; }
Property Value
Type |
---|
Review |
Remarks
This property represents information about the review status associated with the PDF annotation Comments in the SfPdfViewer.
UniqueKey
Gets or sets uniquekey for annotation.
Declaration
public string UniqueKey { get; set; }
Property Value
Type |
---|
System.String |
VertexPoints
Gets or sets the list of vertex points defining the annotation shape.
Declaration
public List<VertexPoint> VertexPoints { get; set; }
Property Value
Type |
---|
System.Collections.Generic.List<VertexPoint> |
Remarks
The VertexPoints property represents a collection of vertex points that define the shape of the annotation. Each VertexPoint specifies coordinates (X, Y) in the associated SfPdfViewer coordinate space. Note: It is applicable only to specific annotations such as Line, Arrow, Polygon, Distance, Perimeter, Area, and Volume within the SfPdfViewer.
Examples
VertexPoint vertexPoint1 = new VertexPoint();
vertexPoint1.X = 10;
vertexPoint1.Y = 10;
VertexPoint vertexPoint2 = new VertexPoint();
vertexPoint2.X = 110;
vertexPoint2.Y = 10;
PdfAnnotation annotation = new PdfAnnotation();
annotation.Type = AnnotationType.Line;
List<VertexPoint> vertexPoints =new List<VertexPoint>();
vertexPoints.Add(vertexPoint1);
vertexPoints.Add(vertexPoint2);
annotation.VertexPoints = vertexPoints;