Class PdfAnnotationProperties

Represents the attributes of the PDF annotation.

Inheritance
object
PdfAnnotationProperties
PdfAnnotation
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class PdfAnnotationProperties

Constructors

PdfAnnotationProperties()

Declaration
public PdfAnnotationProperties()

Properties

Author

Gets the author value of the annotation.

Declaration
[JsonPropertyName("author")]
public string Author { get; set; }
Property Value
Type
string

BorderColor

Gets the border color of the free text annotation.

Declaration
[JsonPropertyName("borderColor")]
public string BorderColor { get; set; }
Property Value
Type
string
Remarks

BorderColor is applicable for the freetext annotation.

BorderDashArray

Gets the border dash array of the annotation.

Declaration
[JsonPropertyName("borderDashArray")]
public string BorderDashArray { get; set; }
Property Value
Type
string
Remarks

BorderDashArray not applicable for the textmarkup,stamp, and freetext.

BorderWidth

Gets the border width of the free text annotation.

Declaration
[JsonPropertyName("borderWidth")]
public int BorderWidth { get; set; }
Property Value
Type
int
Remarks

BorderWidth is applicable for the freetext annotation.

Color

Gets the color of the textmarkup annotations - highlight, underline and strikethrough and squiggly.

Declaration
[JsonPropertyName("color")]
public string Color { get; set; }
Property Value
Type
string

Data

Gets the path data for ink and signature annotation.

Declaration
[JsonPropertyName("data")]
public string Data { get; set; }
Property Value
Type
string

DefaultText

Gets the text of freetext annotaton.

Declaration
[JsonPropertyName("defaultText")]
public string DefaultText { get; set; }
Property Value
Type
string

FillColor

Gets the fill color of the annotation.

Declaration
[JsonPropertyName("fillColor")]
public string FillColor { get; set; }
Property Value
Type
string
Remarks

FillColor not applicable for the textmarkup, line, arrow, distance, perimeter, stamp, and ink.

FontColor

Gets font color for label text of shape and measure annotation.

Declaration
[JsonPropertyName("fontColor")]
public string FontColor { get; set; }
Property Value
Type
string

FontFamily

Gets font family for label text of shape and measure annotation.

Declaration
[JsonPropertyName("fontFamily")]
public string FontFamily { get; set; }
Property Value
Type
string

FontSize

Gets font size for label text of shape and measure annotation.

Declaration
[JsonPropertyName("fontSize")]
public int FontSize { get; set; }
Property Value
Type
int

FontStyle

Gets or sets font style of the freetext annotation.

Declaration
[JsonConverter(typeof(JsonStringEnumConverter))]
public FontStyle FontStyle { get; set; }
Property Value
Type
FontStyle
Remarks

This property represents the FontStyle associated with the freetext annotation in the SfPdfViewer.

IsLock

Gets the value to check whether annotation is editable or not. By default it false. If set as true, can't interact with the annotation.

Declaration
[JsonPropertyName("isLock")]
public bool IsLock { get; set; }
Property Value
Type
bool

LabelSettings

Gets the label settings for the measure and shape annotation.

Declaration
[JsonPropertyName("labelSettings")]
public PdfViewerShapeLabelSettings LabelSettings { get; set; }
Property Value
Type
PdfViewerShapeLabelSettings

LineHeadEnd

Gets the head end style of the line, arrow, distance, perimeter annotations.

Declaration
[JsonPropertyName("lineHeadEndStyle")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public LineHeadStyle LineHeadEnd { get; set; }
Property Value
Type
LineHeadStyle
Remarks

This is applicable only for line, arrow and perimeter annotation.

LineHeadStart

Gets the head start style of the line, arrow, distance, perimeter annotations.

Declaration
[JsonPropertyName("lineHeadStartStyle")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public LineHeadStyle LineHeadStart { get; set; }
Property Value
Type
LineHeadStyle
Remarks

This is applicable only for line, arrow and perimeter annotation.

MaxHeight

Gets the maxHeight value for the annotations.

Declaration
[JsonPropertyName("maxHeight")]
public int MaxHeight { get; set; }
Property Value
Type
int
Remarks

This is not applicable for text markup annotation.

MaxWidth

Gets the maxWidth value for the annotations.

Declaration
[JsonPropertyName("maxWidth")]
public int MaxWidth { get; set; }
Property Value
Type
int
Remarks

This is not applicable for text markup annotation.

MinHeight

Gets the minHeight value for the annotations.

Declaration
[JsonPropertyName("minHeight")]
public int MinHeight { get; set; }
Property Value
Type
int
Remarks

This is not applicable for text markup annotation.

MinWidth

Gets the minwidth value for the annotations.

Declaration
[JsonPropertyName("minWidth")]
public int MinWidth { get; set; }
Property Value
Type
int
Remarks

This is not applicable for text markup annotation.

ModifiedDate

Gets the modified date of the annotation.

Declaration
[JsonPropertyName("modifiedDate")]
public string ModifiedDate { get; set; }
Property Value
Type
string

Opacity

Gets the opacity value of the annotation.

Declaration
[JsonPropertyName("opacity")]
public double Opacity { get; set; }
Property Value
Type
double

StrokeColor

Gets the stroke color of the annotation.

Declaration
[JsonPropertyName("strokeColor")]
public string StrokeColor { get; set; }
Property Value
Type
string
Remarks

StrokeColor not applicable for the textmarkup annotation.

Subject

Gets the subject value of the annotation.

Declaration
[JsonPropertyName("subject")]
public string Subject { get; set; }
Property Value
Type
string

TextAlignment

Gets text alignment of freetext annotaton.

Declaration
[JsonPropertyName("textAlign")]
public TextAlignment TextAlignment { get; set; }
Property Value
Type
TextAlignment

TextMarkupContent

Gets or sets the text content of the textmarkup annotation.

Declaration
[JsonPropertyName("textMarkupContent")]
[JsonInclude]
public string TextMarkupContent { get; set; }
Property Value
Type
string
Remarks

This property represents the text content associated with the text markup annotation in the SfPdfViewer.

TextMarkupEndIndex

Gets the text content end index of the textmarkup annotation.

Declaration
[JsonPropertyName("textMarkupEndIndex")]
[JsonInclude]
public int TextMarkupEndIndex { get; }
Property Value
Type
int

TextMarkupStartIndex

Gets the text content start index of the textmarkup annotation.

Declaration
[JsonPropertyName("textMarkupStartIndex")]
[JsonInclude]
public int TextMarkupStartIndex { get; }
Property Value
Type
int

Thickness

Gets the thickness value of the annotation.

Declaration
[JsonPropertyName("thickness")]
public int Thickness { get; set; }
Property Value
Type
int
Remarks

Thickness not applicable for the textmarkup,stamp, and freetext annotations.

Type

Gets or sets the type of the PDF annotation.

Declaration
[JsonInclude]
public AnnotationType Type { get; set; }
Property Value
Type
AnnotationType
Remarks

This property represents the type of the PDF annotation in the SfPdfViewer.