Class PdfExtractionAnnotationRecord

Immutable annotation record projected from a page annotation API object.

Inheritance

object

PdfExtractionAnnotationRecord

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Pdf.Extraction

Assembly: DRIT.Pdf.dll

Syntax

public sealed class PdfExtractionAnnotationRecord

Properties

Actions

Link actions in source order.

Declaration

public IReadOnlyList<PdfExtractionAction> Actions { get; }

Property Value

Type	Description
IReadOnlyList<PdfExtractionAction>

Border

Annotation border snapshot, if configured.

Declaration

public PdfExtractionBorder? Border { get; }

Property Value

Type	Description
PdfExtractionBorder

Bounds

Annotation active rectangle in page user-space units.

Declaration

public PdfRect Bounds { get; }

Property Value

Type	Description
PdfRect

Color

Annotation color, if available as RGB.

Declaration

public PdfExtractionColor? Color { get; }

Property Value

Type	Description
PdfExtractionColor

Contents

Common annotation contents, if present.

Declaration

public string? Contents { get; }

Property Value

Type	Description
string

CreationDate

Markup creation timestamp.

Declaration

public DateTimeOffset? CreationDate { get; }

Property Value

Type	Description
DateTimeOffset?

Flags

Annotation flags.

Declaration

public AnnotationFlags Flags { get; }

Property Value

Type	Description
AnnotationFlags

HighlightMode

Link highlight mode, when this is a link.

Declaration

public HighlightMode? HighlightMode { get; }

Property Value

Type	Description
HighlightMode?

Modified

Last-modified timestamp, if present.

Declaration

public DateTimeOffset? Modified { get; }

Property Value

Type	Description
DateTimeOffset?

Name

Annotation name, if present.

Declaration

public string? Name { get; }

Property Value

Type	Description
string

Points

Line or polygon points in page user space.

Declaration

public IReadOnlyList<PdfPoint> Points { get; }

Property Value

Type	Description
IReadOnlyList<PdfPoint>

Provenance

Stable annotation provenance label.

Declaration

public string Provenance { get; }

Property Value

Type	Description
string

Quads

Text-markup quadrilaterals.

Declaration

public IReadOnlyList<PdfExtractionQuadrilateral> Quads { get; }

Property Value

Type	Description
IReadOnlyList<PdfExtractionQuadrilateral>

RichText

Markup rich text.

Declaration

public string? RichText { get; }

Property Value

Type	Description
string

RotatedBounds

Annotation bounds after page rotation.

Declaration

public PdfRect RotatedBounds { get; }

Property Value

Type	Description
PdfRect

RotatedPoints

Line or polygon points after page rotation.

Declaration

public IReadOnlyList<PdfPoint> RotatedPoints { get; }

Property Value

Type	Description
IReadOnlyList<PdfPoint>

SourceId

Stable, projection-local source identifier.

Declaration

public string SourceId { get; }

Property Value

Type	Description
string

SourceOrder

Zero-based annotation order on the page.

Declaration

public int SourceOrder { get; }

Property Value

Type	Description
int

Subject

Markup subject.

Declaration

public string? Subject { get; }

Property Value

Type	Description
string

Subtype

PDF annotation subtype where it is available from the public type.

Declaration

public string Subtype { get; }

Property Value

Type	Description
string

TargetPageIndex

The first destination's target page index, when available.

Declaration

public int? TargetPageIndex { get; }

Property Value

Type	Description
int?

Text

Visible/free-text contents when exposed by the public annotation type.

Declaration

public string? Text { get; }

Property Value

Type	Description
string

Title

Markup author/title.

Declaration

public string? Title { get; }

Property Value

Type	Description
string

Uri

The first URI action URI, when this is a web link.

Declaration

public string? Uri { get; }

Property Value

Type	Description
string