menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class AnnotationSettings - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class AnnotationSettings

    Represents annotation and its selector settings.

    Inheritance
    System.Object
    AnnotationSettings
    Namespace: Syncfusion.SfPdfViewer.XForms
    Assembly: Syncfusion.SfPdfViewer.XForms.dll
    Syntax
    public class AnnotationSettings : Object

    Properties

    Arrow

    Gets or sets the ArrowAnnotation appearance of the arrow shape.

    Declaration
    public ArrowAnnotation Arrow { get; set; }
    Property Value
    Type Description
    ArrowAnnotation

    The rectangle allows the user to change the arrow shape's appearance.

    Circle

    Gets or sets the CircleAnnotation appearance of the circle shape.

    Declaration
    public CircleAnnotation Circle { get; set; }
    Property Value
    Type Description
    CircleAnnotation

    The rectangle allows the user to change the circle shape's appearance.

    Constraints

    Declaration
    public AnnotationConstraints Constraints { get; set; }
    Property Value
    Type
    AnnotationConstraints

    Flatten

    Gets or sets a value indicating whether the annotations should be flattened when the PDF is loaded. If the value is true, the annotations cannot be selected or moved.

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

    Default value is false

    Remarks

    Changing the value of this API at run time will not have any effect after the PDF has completed loading.

    FreeText

    Gets or sets the default appearance of text annotation.

    Declaration
    public FreeTextAnnotationSettings FreeText { get; set; }
    Property Value
    Type Description
    FreeTextAnnotationSettings

    The default text color is Black The default text size is 12 The default text is empty.

    HandwrittenSignature

    Gets or sets the appearance properties of handwritten signatures.

    Declaration
    public HandwrittenSignatureSettings HandwrittenSignature { get; set; }
    Property Value
    Type
    HandwrittenSignatureSettings

    Ink

    Gets or sets the default appearance of ink annotation.

    Declaration
    public InkAnnotationSettings Ink { get; set; }
    Property Value
    Type Description
    InkAnnotationSettings

    The annotation settings allows the user to customize the default appearance of the ink annotation.

    InkEraser

    Gets or sets the appearance settings of the ink eraser tool.

    Declaration
    public InkEraserSettings InkEraser { get; set; }
    Property Value
    Type
    InkEraserSettings

    IsLocked

    Gets or sets a value indicating whether the annotations can be edited. If this property is true, annotations can be selected, but resizing, moving, editing and removing actions will be disabled for the user. Default value is false.

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

    Line

    Gets or sets the LineAnnotation appearance of the line shape.

    Declaration
    public LineAnnotation Line { get; set; }
    Property Value
    Type Description
    LineAnnotation

    The rectangle allows the user to change the line shape's appearance.

    Polygon

    A ShapeAnnotationSettings instance created and assigned from within PDF viewer to represent the default color, thickness and other properties.

    Declaration
    public PolygonAnnotation Polygon { get; set; }
    Property Value
    Type
    PolygonAnnotation

    Polyline

    Gets or sets the appearance settings of the polyline annotation.

    Declaration
    public PolylineAnnotation Polyline { get; set; }
    Property Value
    Type
    PolylineAnnotation

    Popup

    Gets or sets the settings for popup annotations.

    Declaration
    public PopupAnnotationSettings Popup { get; set; }
    Property Value
    Type
    PopupAnnotationSettings

    Rectangle

    Gets or sets the RectangleAnnotation appearance of the rectangle shape.

    Declaration
    public RectangleAnnotation Rectangle { get; set; }
    Property Value
    Type Description
    RectangleAnnotation

    The rectangle allows the user to change the rectangle shape's appearance.

    Selector

    Gets or sets the default appearance of textmarkup annotation selector.

    Declaration
    public SelectorSettings Selector { get; set; }
    Property Value
    Type Description
    SelectorSettings

    The selector settings allows the user to customize the default appearance of the textmarkup annotation selector.

    Stamp

    Gets or sets the Appearance for the stamp.

    Declaration
    public StampAnnotationSettings Stamp { get; set; }
    Property Value
    Type
    StampAnnotationSettings

    TextMarkup

    Gets or sets the default appearance of textmarkup annotation.

    Declaration
    public DefaultTextMarkupAnnotationSettings TextMarkup { get; set; }
    Property Value
    Type Description
    DefaultTextMarkupAnnotationSettings

    The annotation settings allows the user to customize the default appearance of the textmarkup annotation.

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