quarkdown-stdlib/com.quarkdown.stdlib.module.Document/pageformat

pageformat

.pageformat size:{PageSizeFormat? = null}
     orientation:{PageOrientation = context.documentInfo.type.preferredOrientation}
           width:{Size? = null}
          height:{Size? = null}
          margin:{Sizes? = null}
       bordertop:{Size? = null}
     borderright:{Size? = null}
    borderbottom:{Size? = null}
      borderleft:{Size? = null}
     bordercolor:{Color? = null}
         columns:{Int? = null}
       alignment:{Container.TextAlignment? = null}
-> Void
Content copied to clipboard

Sets the page layout format of the document. If a value is unset, the default value supplied by the underlying renderer is used.

  • In case of paged documents, this function defines the properties of each page.

  • In case of slides documents, this function defines the properties of each slide.

  • In case of plain documents, this function defines some properties of the whole document, seeing it as just one page. Not all effects of this function are supported in plain documents.

If both size and width or height are set, the latter overrides the former. If both size and width or height are unset, the default value is used.

If any of bordertop, borderright, borderbottom, borderleft or bordercolor is set, the border will be applied around the content area of each page. If only bordercolor is set, the border will be applied with a default width to each side. Border is not supported in plain documents.

Parameters

size

standard size format of each page (overridden by width and height)

Values

orientation

orientation of each page. If not specified, the preferred orientation of the document type is used. Does not take effect if size is not specified.

Values

width

width of each page

height

height of each page

margin

blank space around the content of each page. Not supported in slides documents

bordertop

border width of the top content area of each page

borderright

border width of the right content area of each page

borderbottom

border width of the bottom content area of each page

borderleft

border width of the left content area of each page

bordercolor

color of the border around the content area of each page

columns

positive number of columns on each page. If set and greater than 1, the layout becomes multi-column. If < 1, the value is discarded

alignment

text alignment of the content on each page

Values

Wiki page

Page format