Class DocxListLevel

Namespace

PDiffy

Assembly

PDiffy.dll

How one level of a list is numbered: its format (such as "decimal", "upperLetter" or "bullet"), its label pattern (such as "%1." or a bullet character), the number it starts at, its indents in points and its bullet font. Format, Text and Start are null when the list's definition has no such level.

public sealed record DocxListLevel : IEquatable<DocxListLevel>

Inheritance

object

DocxListLevel

Implements

IEquatable<DocxListLevel>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Font

The label's font, such as "Symbol" for a bullet, or null when the level doesn't set one.

public required string? Font { get; init; }

Property Value

string

Format

The number format, such as "lowerRoman"; "decimal" when the level doesn't set one.

public required string? Format { get; init; }

Property Value

string

Hanging

How far the label hangs out to the left of the text after it, in points, or null when the level doesn't set it.

public required double? Hanging { get; init; }

Property Value

double?

Indent

The left indent of the level's paragraphs in points, or null when the level sets none.

public required double? Indent { get; init; }

Property Value

double?

Level

The level from 0, the outermost, to 8.

public required int Level { get; init; }

Property Value

int

Other

A hash of what the level sets that isn't printed, such as the label's size, color or bold, its alignment, what follows it and a picture bullet's image, so changing them changes the snapshot; null when it sets none.

public string? Other { get; init; }

Property Value

string

Start

The number the level starts at: the list's own override, else the level's start, else 1.

public required int? Start { get; init; }

Property Value

int?

Text

The label pattern, in which %1 to %9 stand for the counters of levels 0 to 8, so "%1.%2." prints as "2.1." for the first item under the second; a bullet's character for a bullet, and empty when the level doesn't set one.

public required string? Text { get; init; }

Property Value

string