Struct PageFacts

Namespace

Rustaveli.Pdf

Assembly

Rustaveli.Pdf.dll

What is known about the page being laid out, for content that shows only on some pages.

public readonly record struct PageFacts : IEquatable<PageFacts>

Implements

IEquatable<PageFacts>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PageFacts(int, int?)

What is known about the page being laid out, for content that shows only on some pages.

public PageFacts(int Folio, int? PageCount)

Parameters

Folio int

The page's number, counting from one.

PageCount int?

How many pages the document has, or null while the engine is still counting them. Content whose size depends on it can change the count it depends on, so it is best kept to content of a fixed size, such as a mark in a margin.

Properties

Folio

The page's number, counting from one.

public int Folio { get; init; }

Property Value

int

IsFirst

Whether this is the document's first page.

public bool IsFirst { get; }

Property Value

bool

IsLast

Whether this is the document's last page; false while the page count is not yet known.

public bool IsLast { get; }

Property Value

bool

IsOdd

Whether the page has an odd number, which is a right-hand page in a book opening on the right.

public bool IsOdd { get; }

Property Value

bool

PageCount

How many pages the document has, or null while the engine is still counting them. Content whose size depends on it can change the count it depends on, so it is best kept to content of a fixed size, such as a mark in a margin.

public int? PageCount { get; init; }

Property Value

int?