Class Ink

Class representing ink annotations. Ink annotations are used for free hand drawings on a page.

Inheritance
object
AnnotationBase
Ink
Implements
Inherited Members
Namespace: PSPDFKit.Sdk.Models.Annotation
Assembly: Sdk.dll
Syntax
public sealed class Ink : AnnotationBase, IAnnotation

Properties

| Edit this page View Source

BackgroundColor

Optional background color that will fill the complete bounding box.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(ColorJsonConverter))]
public Color? BackgroundColor { get; set; }
Property Value
Type Description
Color?
| Edit this page View Source

IsDrawnNaturally

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool IsDrawnNaturally { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsSignature

Indicates whether the ink annotation is a signature.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool IsSignature { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

LineWidth

The width of the lines in page size pixels. By default, we use values between 1 and 40 in the UI. The line width will scale when you zoom in.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public int LineWidth { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Lines

A list of line segments. Every segment consists again of a pair of points. Within one segment, points will be connected using lines or curves. If no lines are present, the annotation will not be visible.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(LinesJsonConverter))]
public IEnumerable<IEnumerable<DrawingPoint>> Lines { get; set; }
Property Value
Type Description
IEnumerable<IEnumerable<DrawingPoint>>
| Edit this page View Source

StrokeColor

Color for visible line.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
[JsonConverter(typeof(ColorJsonConverter))]
public Color StrokeColor { get; set; }
Property Value
Type Description
Color

Implements

IAnnotation