PageFormatInfo

data class PageFormatInfo(val selector: PageFormatSelector? = null, val pageWidth: Size? = null, val pageHeight: Size? = null, val margin: Sizes? = null, val contentBorderWidth: Sizes? = null, val contentBorderColor: Color? = null, val columnCount: Int? = null, val alignment: Container.TextAlignment? = null)

Immutable information about the format of all pages of a document. When any of the fields is null, the default value supplied by the underlying renderer is used.

A document may have multiple PageFormatInfo instances with different selector values, allowing distinct formatting for specific page sides or page ranges (e.g. mirrored margins in book-style layouts, or different margins for the first few pages).

Parameters

selector

the scope this format applies to (side, range, or both), or null for global (all pages)

pageWidth

width of each page

pageHeight

height of each page

margin

blank space around the content of each page

contentBorderWidth

width of the border around the content area of each page

contentBorderColor

color of the border around the content area of each page

columnCount

number of columns on each page. If set, the layout becomes multi-column

alignment

text alignment of the content of each page

Constructors

Link copied to clipboard
constructor(selector: PageFormatSelector? = null, pageWidth: Size? = null, pageHeight: Size? = null, margin: Sizes? = null, contentBorderWidth: Sizes? = null, contentBorderColor: Color? = null, columnCount: Int? = null, alignment: Container.TextAlignment? = null)

Properties

Link copied to clipboard
Link copied to clipboard
val columnCount: Int? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val margin: Sizes? = null
Link copied to clipboard
val pageHeight: Size? = null
Link copied to clipboard
val pageWidth: Size? = null
Link copied to clipboard

Functions

Link copied to clipboard