1. Home
  2. API
  3. Broadside.Viewer
  4. TextPosition

TextPosition Struct

Definition

Assembly Broadside.Viewer.dll
View source
Show inherited members (6)

A caret position in a document's selectable text: between two glyphs of one page, counted in the page's reading order.

public readonly record struct TextPosition(int PageIndex, int Offset) : IComparable<TextPosition>, IEquatable<TextPosition>

Remarks

ISO 32000-2 §14.8.2.5 (reading order). Spec #33 viewer capability 4.

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (1)

TextPosition(Int32, Int32)A caret position in a document's selectable text: between two glyphs of one page, counted in the page's reading order.

Properties (2)

OffsetThe number of glyphs before the caret on the page, in reading order: 0 is the page's start; an offset at or past the page's Length stands for its end.
PageIndexThe zero-based page.

Methods (1)

CompareTo(TextPosition)Compares two positions in document order: by page, then by offset.

Operators (4)

GreaterThan(TextPosition, TextPosition)Whether left comes after right.
GreaterThanOrEqual(TextPosition, TextPosition)Whether left comes after or equals right.
LessThan(TextPosition, TextPosition)Whether left comes before right.
LessThanOrEqual(TextPosition, TextPosition)Whether left comes before or equals right.