Class Underline

This class represents a Underline annotation.

Inheritance
System.Object
Underline
Implements
Namespace: PSPDFKit.Pdf.Annotation
Assembly: PSPDFKit.dll
Syntax
public sealed class Underline : object, IAnnotation, IMarkup

Properties

AnnotationType

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

BoundingBox

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

Color

Declaration
public Color Color { get; set; }
Property Value
Type Description
Windows.UI.Color

CreatedAt

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

CreatorName

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

CustomData

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

Id

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

Name

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

NoPrint

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

NoView

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

Opacity

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

PageIndex

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

PdfObjectId

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

Rects

Declaration
public IList<Rect> Rects { get; set; }
Property Value
Type Description
IList<Windows.Foundation.Rect>

UpdatedAt

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

Version

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()

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

Implements

IAnnotation
IMarkup

See Also