Class Line

Line annotations are used to draw straight lines on a page.

Inheritance
System.Object
Line
Implements
Namespace: PSPDFKit.Pdf.Annotation
Assembly: PSPDFKit.dll
Syntax
public sealed class Line : IShape, IAnnotation

Properties

AnnotationType

The type of the annotation.

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

BoundingBox

The bounding box of the annotation within the page.

Declaration
public Rect BoundingBox { get; set; }
Property Value
Type Description
Windows.Foundation.Rect

CreatedAt

The date of the annotation creation.

Declaration
public DateTimeOffset CreatedAt { get; set; }
Property Value
Type Description
System.DateTimeOffset

CreatorName

The name of the creator of the annotation. This is a general purpose string which can easily be spoofed and might not reflect the actual creator of the annotation.

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

CustomData

Annotations can store additional user-specified data. PSPDFKit does not use or evaluate CustomData in the UI directly. You have full control over this property. For a new annotation, this defaults to a null object.

Declaration
public JsonObject CustomData { get; set; }
Property Value
Type Description
Windows.Data.Json.JsonObject

EndPoint

The Windows.Foundation.Point coordinates of the line ending point.

Declaration
public Point EndPoint { get; set; }
Property Value
Type Description
Windows.Foundation.Point

FillColor

An optional Windows.UI.Color to fill start and or end line caps, if either are present.

Declaration
public Color? FillColor { get; set; }
Property Value
Type Description
System.Nullable<Windows.UI.Color>

Id

A unique identifier to describe the annotation.

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

LineCaps

Start and End line caps for the line. Each line cap can have one of these values: LineCap If the fillColor field is provided, its value is used as fill color for the line cap interior.

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

Name

An optional field that may be used to identify the annotation. By default it is set that to the same value as the automatically generated Id.

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

NoPrint

If the annotation should be printed or not.

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

NoView

The property that determines if the annotation is prevented from being rendered in the UI. The annotation may still be rendered in a printed page, depending of the value of NoPrint.

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

Opacity

The opacity of the annotation, 0.0 - 1.0.

Declaration
public float Opacity { get; set; }
Property Value
Type Description
System.Single

PageIndex

The page index of the annotation in the document.

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

PdfObjectId

The Pdf object ID, if the annotation is included in a Pdf file.

Declaration
public int? PdfObjectId { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

StartPoint

The Windows.Foundation.Point coordinates of the line starting point.

Declaration
public Point StartPoint { get; set; }
Property Value
Type Description
Windows.Foundation.Point

StrokeColor

A Windows.UI.Color for the shape lines

Declaration
public Color? StrokeColor { get; set; }
Property Value
Type Description
System.Nullable<Windows.UI.Color>

StrokeDashArray

Optional dash pattern used to draw the shape lines for dashed line style.

Declaration
public IList<int> StrokeDashArray { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.Int32>

StrokeWidth

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

Declaration
public float StrokeWidth { get; set; }
Property Value
Type Description
System.Single

UpdatedAt

The date of last annotation update.

Declaration
public DateTimeOffset UpdatedAt { get; set; }
Property Value
Type Description
System.DateTimeOffset

Version

The Instant JSON spec version this annotation is compliant to.

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

Methods

FromJson(JsonObject)

Constructs the IAnnotation from the Instant JSON representing it. See https://pspdfkit.com/guides/server/current/document/json-format/ If any mandatory properties are missing then an exception will be thrown.

Declaration
public static IAnnotation FromJson(JsonObject json)
Parameters
Type Name Description
Windows.Data.Json.JsonObject json

The Instant JSON representing the IAnnotation.

Returns
Type Description
IAnnotation

The IAnnotation represented by the Instant JSON.

FromPartialJson(JsonObject)

Constructs the IAnnotation from the Instant JSON representing it. See https://pspdfkit.com/guides/server/current/document/json-format/ This method does not require mandatory properties to be present in the JSON. Instead appropriate default values will be used.

Declaration
public static IAnnotation FromPartialJson(JsonObject json)
Parameters
Type Name Description
Windows.Data.Json.JsonObject json

The Instant JSON or partial Instant JSON representing the IAnnotation

Returns
Type Description
IAnnotation

The IAnnotation represented by the Instant JSON.

ToJson()

Converts the annotation to the Instant JSON annotation format. See https://pspdfkit.com/guides/server/current/document/json-format/

Declaration
public JsonObject ToJson()
Returns
Type Description
Windows.Data.Json.JsonObject

The annotation object.

Implements

IShape
IAnnotation

See Also