PDFDocument Class Reference

PUBLIC VARS

layout
Holds all layout information
Declaration
Swift

public var layout: PDFPageLayout
info
Holds all document information
Declaration
Swift

public var info: PDFInfo
pagination
Holds all pagination information
Declaration
Swift

public var pagination: PDFPagination
styles
Holds strong references to all text styles
Declaration
Swift

public var styles: [PDFTextStyle]
background
Configuration for document/paper background
Declaration
Swift

public var background: PDFDocumentBackground

PUBLIC INITIALIZERS


                    
                    
                    init(layout:)

Creates a new document with the given layout

Declaration

Swift

public init(layout: PDFPageLayout)

Parameters


                                layout

Layout information for document


                    
                    
                    init(format:)

Creates a new document with a predefined PDFPageFormat

Declaration

Swift

public init(format: PDFPageFormat)

Parameters


                                layout

Predefined page formats

Layout


                    
                    
                    add(_:space:)

Adds a empty space in the given container, between the previous and the next element

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, space: CGFloat)

Parameters

`container`	Container where the space will be set
`space`	Space distance in points

Lines


                    
                    
                    addLineSeparator(_:style:)

Adds a horizontal line spearator to the given container. The line starts at the left indentation and ends at the right indentation. Customize by adjusting parameter style.

Declaration

Swift

public func addLineSeparator(_ container: PDFContainer = PDFContainer.contentLeft, style: PDFLineStyle)

Parameters

`container`	Container where the space will be set
`style`	Style of line

Image


                    
                    
                    add(_:image:)

Adds an image to the given container.

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, image: PDFImage)

Parameters

`container`	Container where the space will be set
`image`	Image object


                    
                    
                    add(_:imagesInRow:spacing:)

Adds an image row to the given container. This image row will fill the full available width between left indentation and right indentation.

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, imagesInRow images: [PDFImage], spacing: CGFloat = 5.0)

Parameters

`container`	Container where the space will be set
`images`	Array of images, from left to right
`spacing`	Horizontal distance between images

Text


                    
                    
                    add(_:text:lineSpacing:)

Shorthand public function to add a String text to the given container

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, text: String, lineSpacing: CGFloat = 1.0)

Parameters

`container`	Container where the space will be set
`images`	Array of images, from left to right
`spacing`	Horizontal distance between images


                    
                    
                    add(_:textObject:)

Adds an text object to the given container

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, textObject: PDFSimpleText)

Parameters

`container`	Container where the space will be set
`textObject`	Simple text object


                    
                    
                    add(_:attributedText:)

Shorthand public function to add a attributed String text to the given container

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, attributedText: NSAttributedString)

Parameters

`container`	Container where the space will be set
`text`	An attributed string


                    
                    
                    add(_:attributedTextObject:)

Adds an attributed text object to the given container

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, attributedTextObject: PDFAttributedText)

Parameters

`container`	Container where the space will be set
`textObject`	Attributed text object


                    
                    
                    set(_:font:)

Set font in given container. This text color will be used when adding a PDFSimpleText

Declaration

Swift

public func set(_ container: PDFContainer = PDFContainer.contentLeft, font: Font)

Parameters

`container`	Container where the font will be set
`font`	Font of text


                    
                    
                    resetFont(_:)

Reset text color in given container to default.

Declaration

Swift

public func resetFont(_ container: PDFContainer = PDFContainer.contentLeft)

Parameters


                                container

Container whose text color will be reset


                    
                    
                    set(_:textColor:)

Set text color in given container. This text color will be used when adding a PDFSimpleText

Declaration

Swift

public func set(_ container: PDFContainer = PDFContainer.contentLeft, textColor: Color)

Parameters

`container`	Container where the text color will be set
`color`	Color of the text


                    
                    
                    resetTextColor(_:)

Reset text color in given container to default.

Declaration

Swift

public func resetTextColor(_ container: PDFContainer = PDFContainer.contentLeft)

Parameters


                                container

Container whose text color will be reset

Table


                    
                    
                    add(_:table:)

Adds a table object to the document in the defined container

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, table: PDFTable)

Parameters

`container`	Container where the table color will be added
`color`	Table to add to document

List


                    
                    
                    add(_:list:)

Adds a list object to the document in the defined container

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, list: PDFList)

Parameters

`container`	Container where the text color will be set
`color`	Color of the text

Section


                    
                    
                    add(section:)

Adds a section object to the document

Declaration

Swift

public func add(section: PDFSection)

Parameters


                                section

Section

Layout


                    
                    
                    set(_:indent:left:)

Change the indentation in a container, use the parameter left to define from which side.

Declaration

Swift

public func set(_ container: PDFContainer = PDFContainer.contentLeft, indent: CGFloat, left: Bool)

Parameters

`container`	Container whose indentation should be changed
`indent`	Points from the side
`left`	If `true` then the left side indentation is set, else the right indentation is set


                    
                    
                    set(_:absoluteOffset:)

Change the absolute top offset in a container

Declaration

Swift

public func set(_ container: PDFContainer = PDFContainer.contentLeft, absoluteOffset: CGFloat)

Parameters

`container`	Container whose current absoilute offset should be changed
`absoluteOffset`	Points from the top

createNewPage()
Creates a new page by adding a page break object
Declaration
Swift

public func createNewPage()


                    
                    
                    add(style:)

Adds a new style to the list of known styles

Declaration

Swift

public func add(style: PDFTextStyle) -> PDFTextStyle

Parameters


                                style

Definition of the text style


                    
                    
                    add(tableOfContent:)

Adds a table of content

Declaration

Swift

public func add(tableOfContent: PDFTableOfContent)

Parameters


                                tableOfContent

Options of the table of content

Column Wrapping


                    
                    
                    enable(_:columns:widths:spacings:)

Starts a column section with automatic wrapping

Declaration

Swift

public func enable(_ container: PDFContainer = PDFContainer.contentLeft, columns: Int, widths: [CGFloat], spacings: [CGFloat])


                    
                    
                    disableColumns(_:addPageBreak:)

Finishes a column section

Declaration

Swift

public func disableColumns(_ container: PDFContainer = PDFContainer.contentLeft, addPageBreak: Bool = true)


                    
                    
                    add(_:group:)

Adds a group

Declaration

Swift

public func add(_ container: PDFContainer = PDFContainer.contentLeft, group: PDFGroup)

Parameters

`container`	Container where the group will be added
`group`	Instance of `PDFGroup` to add


                    
                    
                    set(master:)

Replaces current master group with the given one.

See PDFDocument/masterGroup for details.

Declaration

Swift

public func set(master group: PDFMasterGroup)

Parameters


                                master

Instance of PDFMasterGroup,


                    
                    
                    add(externalDocument:)

Adds an external document to the document

Declaration

Swift

public func add(externalDocument doc: PDFExternalDocument)

Parameters

doc

Instance of PDFExternalDocument