Blazor

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfAnnotationProperties

    Show / Hide Table of Contents

    Class PdfAnnotationProperties

    Represents the attributes of the PDF annotation.

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

    Constructors

    PdfAnnotationProperties()

    Declaration
    public PdfAnnotationProperties()

    Properties

    Author

    Gets the author value of the annotation.

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

    BorderColor

    Gets the border color of the free text annotation.

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

    BorderColor is applicable for the freetext annotation.

    BorderDashArray

    Gets the border dash array of the annotation.

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

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

    BorderWidth

    Gets the border width of the free text annotation.

    Declaration
    public int BorderWidth { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    BorderWidth is applicable for the freetext annotation.

    Color

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

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

    Data

    Gets the path data for ink and signature annotation.

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

    DefaultText

    Gets the text of freetext annotaton.

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

    FillColor

    Gets the fill color of the annotation.

    Declaration
    public string FillColor { get; set; }
    Property Value
    Type Description
    System.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
    public string FontColor { get; set; }
    Property Value
    Type Description
    System.String

    FontFamily

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

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

    FontSize

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

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

    FontStyle

    Gets font style of the freetext annotation.

    Declaration
    public FontStyle FontStyle { get; set; }
    Property Value
    Type Description
    FontStyle

    Height

    Gets height of the annotation.

    Declaration
    public double Height { get; set; }
    Property Value
    Type Description
    System.Double
    Remarks

    It is applicable for freetext, ink annotation.

    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
    public bool IsLock { get; set; }
    Property Value
    Type Description
    System.Boolean

    LabelSettings

    Gets the label settings for the measure and shape annotation.

    Declaration
    public PdfViewerShapeLabelSettings LabelSettings { get; set; }
    Property Value
    Type Description
    PdfViewerShapeLabelSettings

    LineHeadEnd

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

    Declaration
    public LineHeadStyle LineHeadEnd { get; set; }
    Property Value
    Type Description
    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
    public LineHeadStyle LineHeadStart { get; set; }
    Property Value
    Type Description
    LineHeadStyle
    Remarks

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

    MaxHeight

    Gets the maxHeight value for the annotations.

    Declaration
    public int MaxHeight { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This is not applicable for text markup annotation.

    MaxWidth

    Gets the maxWidth value for the annotations.

    Declaration
    public int MaxWidth { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This is not applicable for text markup annotation.

    MinHeight

    Gets the minHeight value for the annotations.

    Declaration
    public int MinHeight { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This is not applicable for text markup annotation.

    MinWidth

    Gets the minwidth value for the annotations.

    Declaration
    public int MinWidth { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    This is not applicable for text markup annotation.

    ModifiedDate

    Gets the modified date of the annotation.

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

    Opacity

    Gets the opacity value of the annotation.

    Declaration
    public double Opacity { get; set; }
    Property Value
    Type Description
    System.Double

    StrokeColor

    Gets the stroke color of the annotation.

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

    StrokeColor not applicable for the textmarkup annotation.

    Subject

    Gets the subject value of the annotation.

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

    TextAlignment

    Gets text alignment of freetext annotaton.

    Declaration
    public TextAlignment TextAlignment { get; set; }
    Property Value
    Type Description
    TextAlignment

    TextMarkupContent

    Gets the text content of the textmarkup annotation.

    Declaration
    public string TextMarkupContent { get; }
    Property Value
    Type Description
    System.String

    TextMarkupEndIndex

    Gets the text content end index of the textmarkup annotation.

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

    TextMarkupStartIndex

    Gets the text content start index of the textmarkup annotation.

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

    Thickness

    Gets the thickness value of the annotation.

    Declaration
    public int Thickness { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

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

    Type

    Gets the annotation type.

    Declaration
    public AnnotationType Type { get; }
    Property Value
    Type Description
    AnnotationType

    Width

    Gets width of the annotation.

    Declaration
    public double Width { get; set; }
    Property Value
    Type Description
    System.Double
    Remarks

    It is applicable for freetext, ink annotation.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved