Class DocxPageSetup

Namespace

PDiffy

Assembly

PDiffy.dll

One section's page geometry. Lengths are in points.

public sealed record DocxPageSetup : IEquatable<DocxPageSetup>

Inheritance

object

DocxPageSetup

Implements

IEquatable<DocxPageSetup>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Break

How the section starts: "nextPage", "continuous", "evenPage", "oddPage" or "nextColumn", as in DocxSectionBreaks.

public string Break { get; init; }

Property Value

string

Columns

How many columns the text is set in.

public int Columns { get; init; }

Property Value

int

FooterDistance

The distance from the bottom edge of the page to the footer.

public double FooterDistance { get; init; }

Property Value

double

Footers

The kinds of footer the section has: "default", "first" or "even" (DocxHeaderFooterKinds).

public IReadOnlyList<string> Footers { get; init; }

Property Value

IReadOnlyList<string>

Gutter

The extra margin left for binding, 0 when there is none.

public double Gutter { get; init; }

Property Value

double

HeaderDistance

The distance from the top edge of the page to the header.

public double HeaderDistance { get; init; }

Property Value

double

Headers

The kinds of header the section has: "default", "first" or "even" (DocxHeaderFooterKinds).

public IReadOnlyList<string> Headers { get; init; }

Property Value

IReadOnlyList<string>

Height

The page height, or 0 when the section doesn't set a page size.

public double Height { get; init; }

Property Value

double

MarginBottom

The bottom margin, or 0 when the section doesn't set it.

public double MarginBottom { get; init; }

Property Value

double

MarginLeft

The left margin, or 0 when the section doesn't set it.

public double MarginLeft { get; init; }

Property Value

double

MarginRight

The right margin, or 0 when the section doesn't set it.

public double MarginRight { get; init; }

Property Value

double

MarginTop

The top margin, or 0 when the section doesn't set it.

public double MarginTop { get; init; }

Property Value

double

Other

A hash of the section's own settings PDiffy doesn't read, such as w:pgBorders or w:lnNumType, so changing it changes the snapshot; null when it has none. Only its own formatting counts, not what it inherits, and noise Word writes everywhere is left out.

public string? Other { get; init; }

Property Value

string

PageNumberFormat

The page number format, such as "decimal" or "lowerRoman".

public string? PageNumberFormat { get; init; }

Property Value

string

PageNumberStart

The number the section's first page gets, or null when numbering carries on from before.

public int? PageNumberStart { get; init; }

Property Value

int?

Revision

A tracked change to the section's settings (SectionFormat), or null.

public DocxRevision? Revision { get; init; }

Property Value

DocxRevision

TitlePage

Whether the first page has its own header and footer.

public bool TitlePage { get; init; }

Property Value

bool

Width

The page width, or 0 when the section doesn't set a page size.

public double Width { get; init; }

Property Value

double