Class InkAnnotationSettings
Represents the customization of ink annotation.
Inheritance
Namespace: Syncfusion.SfPdfViewer.XForms
Assembly: Syncfusion.SfPdfViewer.XForms.dll
Syntax
public class InkAnnotationSettings : BindableObjectFields
ColorProperty
Gets the Color property of InkAnnotationSettings. This is a bindable property.
Declaration
public static readonly BindableProperty ColorPropertyField Value
| Type | Description |
|---|---|
| Xamarin.Forms.BindableProperty | A bindable property that gets and sets the stroke color of the ink annotation. |
MinimumSizeProperty
Gets the MinimumSize property of InkAnnotationSettings. This is a bindable property.
Declaration
public static readonly BindableProperty MinimumSizePropertyField Value
| Type | Description |
|---|---|
| Xamarin.Forms.BindableProperty | A bindable property that gets and sets the minimum size for the ink annotation. |
OpacityProperty
Gets the Opacity property of InkAnnotationSettings. This is a bindable property.
Declaration
public static readonly BindableProperty OpacityPropertyField Value
| Type | Description |
|---|---|
| Xamarin.Forms.BindableProperty | A bindable property that gets and sets the opacity of the ink annotation. |
ThicknessProperty
Gets the Thickness property of InkAnnotationSettings. This is a bindable property.
Declaration
public static readonly BindableProperty ThicknessPropertyField Value
| Type | Description |
|---|---|
| Xamarin.Forms.BindableProperty | A bindable property that gets and sets the thickness of the ink annotation. |
Properties
Color
Gets or sets and sets default color of ink annotation.
Declaration
public Color Color { get; set; }Property Value
| Type | Description |
|---|---|
| Xamarin.Forms.Color | Default ink color is red. |
Constraints
Declaration
public AnnotationConstraints Constraints { get; set; }Property Value
| Type |
|---|
| AnnotationConstraints |
EnableSeparateAttributesForEachStroke
Gets or sets a value that indicates whether each ink stroke's properties or attributes can be changed separately.
Declaration
public bool EnableSeparateAttributesForEachStroke { get; set; }Property Value
| Type |
|---|
| System.Boolean |
Remarks
When the property is set to "true", each ink stroke will be selected and modified separately. When it is set to "false", all the strokes drawn in a single ink session will be selected and modified as a whole.
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 |
MinimumSize
Gets or sets the minimum size to which the annotation can be resized.
Declaration
public Size MinimumSize { get; set; }Property Value
| Type |
|---|
| Xamarin.Forms.Size |
Opacity
Gets or sets default opacity of ink annotation.
Declaration
public float Opacity { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single | Default ink opacity is 1. |
Thickness
Gets or sets default thickness of ink annotation.
Declaration
public float Thickness { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single | Default ink thickness is 5. |
TouchMode
Gets or sets a value that indicates the input mode in which the ink strokes should be allowed to be drawn.
Declaration
public TouchMode TouchMode { get; set; }Property Value
| Type | Description |
|---|---|
| TouchMode | Default touch mode is Direct. |
Remarks
When the value is set to Stylus, the ink annotations can be drawn using pencil and the PDF can be scrolled using fingers at the same time.