UIMarkupTextPrintFormatter Class Reference
| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/UIKit.framework |
| Availability | Available in iOS 4.2 and later. |
| Companion guide | |
| Declared in | UIPrintFormatter.h |
Overview
Instances of the UIMarkupTextPrintFormatter class lay out HTML markup text for a multipage print job.
To use this print formatter for a print job, create an instance of UIMarkupTextPrintFormatter initialized with the HTML, set the inherited layout properties, and add the object 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
printFormatterproperty of theUIPrintInteractionControllershared instance. The inheritedstartPageproperty 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
UIPrintPageRendererobject:You can add print formatters to the
printFormattersproperty of theUIPrintPageRendererobject; thestartPageproperty of the print formatter specifies the starting page.You can add print formatters by calling
addPrintFormatter:startingAtPageAtIndex:for each print formatter; the second parameter of this method specifies the starting page (and overrides anystartPagevalue).
You can change the markup text at any time before the drawing of the printable content begins.
Tasks
Creating a Markup-Text Print Formatter
Getting and Setting the Markup Text
-
markupTextproperty
Properties
markupText
The HTML markup text for the print formatter.
Discussion
When drawing begins for the print job, you cannot change the value of this property. The delegate method printInteractionControllerWillStartJob: is called immediately before the formatting is set for the job.
Availability
- Available in iOS 4.2 and later.
See Also
Declared In
UIPrintFormatter.hInstance Methods
initWithMarkupText:
Returns a markup-text print formatter initialized with an HTML string.
Parameters
- markupText
A string of HTML markup text or
nilif you want to add the markup text later.
Return Value
An instance of UIMarkupTextPrintFormatter or nil if the object could not be created.
Availability
- Available in iOS 4.2 and later.
See Also
Declared In
UIPrintFormatter.h© 2010 Apple Inc. All Rights Reserved. (Last updated: 2010-10-12)