Xamarin.iOS

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

    Show / Hide Table of Contents

    Class AnnotationSettings

    Represents annotation and its selector settings.

    Inheritance
    System.Object
    AnnotationSettings
    Namespace: Syncfusion.SfPdfViewer.iOS
    Assembly: Syncfusion.SfPdfViewer.iOS.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

    Gets or sets a value that indicates the constraints to the annotation interactions.

    Declaration
    public AnnotationConstraints Constraints { get; set; }
    Property Value
    Type Description
    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 FreeTextAnnotation appearance of the free text.

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

    The free text allows the user to change the free text's appearance.

    HandwrittenSignature

    Gets or sets the appearance setting for HandwrittenSignature.

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

    Ink

    Gets or sets the InkAnnotation appearance of the ink.

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

    The ink text allows the user to change the ink's appearance.

    IsLocked

    Gets or sets a value that indicates whether the annotations can be edited. if this property is true, annotation selection, resizing, moving and editing actions will be disabled for the user. Default value is false.

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

    When the property is true, only the tapped event will be raised, and the selected event will not be raised.

    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

    Gets or sets the PolygonAnnotation appearance of the Polygon shape.

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

    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 value to customize the annotation selector.

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

    Stamp

    Gets or sets the Appearance for the stamp

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

    TextMarkup

    Gets or sets the default appearance of text markup annotation.

    Declaration
    public DefaultTextMarkupAnnotationSettings TextMarkup { get; set; }
    Property Value
    Type Description
    DefaultTextMarkupAnnotationSettings
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved