An instance of the UIView​Print​Formatter class lays out the drawn content of a view for printing. The view’s content can span multiple pages.


Instances of three system classes offer usable view print formatters to applications: UIWeb​View and UIText​View of the UIKit framework, and MKMap​View of the Map Kit framework. To obtain a view print formatter for a print job, call the UIView method view​Print​Formatter() and initialize the print formatter’s inherited layout properties.

Add the print formatter to the print job in one of two ways:

  • If a single print formatter is being used for the print job (with no additional drawing), assign it to the print​Formatter property of the UIPrint​Interaction​Controller shared instance. The inherited start​Page property identifies the beginning page of content with which the formatter is associated.

  • If you are using multiple formatters along with a page renderer, associate each print formatter with a starting page of the printed content. You often take this approach when you want to add content such as headers and footers to what the formatters provide. You have two ways of associating a print formatter with a UIPrint​Page​Renderer object:

    • You can add print formatters to the print​Formatters property of the UIPrint​Page​Renderer object; the start​Page property of the print formatter specifies the starting page

    • You can add print formatters by calling add​Print​Formatter(_:​starting​At​Page​At:​) for each print formatter; the second parameter of this method specifies the starting page (and overrides any start​Page value).

View print formatters typically implement the the UIView method draw(_:​for:​) to draw content in a way that is suitable for printing, If they don’t implement this method, their draw(_:​) method is called instead.

Subclassing Notes

Subclassing UIView​Print​Formatter to print the contents of a view is not recommended. To print the contents of a custom view, you should instead draw the view’s contents for printing using a custom UIPrint​Page​Renderer object.


Accessing the View

var view:​ UIView

The view from which the view print formatter was derived.


Inherits From