NumberingFormat

data class NumberingFormat(val symbols: List<NumberingSymbol>)

Represents a format that defines how items (e.g. headings) are numbered in a document, depending on their relative position and level of nesting. For example, a format 1.A.a would result in the following numbering:

Parameters

symbols

ordered list of symbols that define the format

See also

Constructors

Link copied to clipboard
constructor(symbols: List<NumberingSymbol>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The accuracy of the numbering format: the number of nesting levels that the format can cover. For example:

Link copied to clipboard

Whether the format does not contain any counting symbols.

Link copied to clipboard

Functions

Link copied to clipboard
fun format(location: SectionLocation, allowMismatchingLength: Boolean = true): String

Converts the numbering format into a string. For example, the NumberingFormat 1.A.a would format the levels 1, 1, 0 as 2.B.a.