PdfAnnotationInfo Class

Definition

Namespace:Avalonia.Controls.Pdf.Core

Assembly:Avalonia.Controls.PdfViewer

Package:Avalonia.Controls.PdfViewer

An immutable, read-only snapshot of a PDF annotation's properties, suitable for inspection by consumers. Geometry is reported in PDF user space (see Avalonia.Controls.Pdf.Core.PdfPoint/Avalonia.Controls.Pdf.Core.PdfRect).

public class PdfAnnotationInfo

Inheritance: object -> PdfAnnotationInfo

Properties

Name	Description
AnnotationIndex	Zero-based index of this annotation on its page.
Author	The annotation author/title, or null.
BorderWidth	Border/stroke width in points, or null if not set.
Bounds	Bounding rectangle in PDF user space.
Color	Stroke/border color, or null if not set.
Contents	The annotation's text contents (note text or popup text), or null.
HasArrowHead	Whether a line annotation has an arrowhead at its end point.
InkStrokes	Ink strokes for ink annotations (each stroke is a list of points), or null.
InteriorColor	Fill/interior color, or null if not set.
IsStar	Whether a polygon annotation represents a star shape.
LineEnd	End point for line annotations, or null.
LineStart	Start point for line annotations, or null.
PageIndex	Zero-based page index this annotation belongs to.
Sides	Number of sides (polygon) or spikes (star), or null.
Type	The annotation subtype.
Vertices	Vertices for polygon/polyline annotations, or null.

AnnotationIndex Property

Zero-based index of this annotation on its page.

public int AnnotationIndex { get; set; }

Author Property

The annotation author/title, or null.

public string Author { get; set; }

BorderWidth Property

Border/stroke width in points, or null if not set.

public Nullable<float> BorderWidth { get; set; }

Bounds Property

Bounding rectangle in PDF user space.

public Avalonia.Controls.Pdf.Core.PdfRect Bounds { get; set; }

Color Property

Stroke/border color, or null if not set.

public Nullable<Avalonia.Controls.Pdf.Core.PdfAnnotationColor> Color { get; set; }

Contents Property

The annotation's text contents (note text or popup text), or null.

public string Contents { get; set; }

HasArrowHead Property

Whether a line annotation has an arrowhead at its end point.

public bool HasArrowHead { get; set; }

InkStrokes Property

Ink strokes for ink annotations (each stroke is a list of points), or null.

public System.Collections.Generic.IReadOnlyList<System.Collections.Generic.IReadOnlyList<Avalonia.Controls.Pdf.Core.PdfPoint>> InkStrokes { get; set; }

InteriorColor Property

Fill/interior color, or null if not set.

public Nullable<Avalonia.Controls.Pdf.Core.PdfAnnotationColor> InteriorColor { get; set; }

IsStar Property

Whether a polygon annotation represents a star shape.

public bool IsStar { get; set; }

LineEnd Property

End point for line annotations, or null.

public Nullable<Avalonia.Controls.Pdf.Core.PdfPoint> LineEnd { get; set; }

LineStart Property

Start point for line annotations, or null.

public Nullable<Avalonia.Controls.Pdf.Core.PdfPoint> LineStart { get; set; }

PageIndex Property

Zero-based page index this annotation belongs to.

public int PageIndex { get; set; }

Sides Property

Number of sides (polygon) or spikes (star), or null.

public Nullable<int> Sides { get; set; }

Type Property

The annotation subtype.

public Avalonia.Controls.Pdf.Core.PdfAnnotationType Type { get; set; }

Vertices Property

Vertices for polygon/polyline annotations, or null.

public System.Collections.Generic.IReadOnlyList<Avalonia.Controls.Pdf.Core.PdfPoint> Vertices { get; set; }