UIPrintInteractionController Class

Reference

Definition

Namespace:: UIKit

Assembly:: Xamarin.iOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Main driver for the printing process on iOS.

[Foundation.Register("UIPrintInteractionController", true)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class UIPrintInteractionController : Foundation.NSObject

type UIPrintInteractionController = class
    inherit NSObject

Inheritance: Object

NSObject
UIPrintInteractionController

Attributes: RegisterAttribute UnavailableAttribute

Remarks

The UIPrintInteractionController provides access to the printing framework on iOS. To print on iOS, you configure the SharedPrintController singleton by specifying your print task, optionally hook up to events and then you invoke the Present(Boolean, UIPrintInteractionCompletionHandler) method to allow the user to select a printer and to print.

This class offers a number of mechanisms for printing, you can print using one of these configuration, based on your needs

Ready to print PDF file. You can print it by assigning to the PrintingItem property the NSUrl pointing to the file or the NSData that contains the PDF in memory.
:
Ready to print image. You can print it by assigning to the PrintingItem property the UIImage or a photo ALAsset (the ALAsset with an AssetType of ALAssetType.Photo).
:
Ready to print collection of images and PDF files. You can print it by assigning the mix of elements to the PrintingItems property an array of objects containing NSUrl, UIImage, NSData or ALAsset values.
:
To layout information using using one of the built-in print formatters you would assign your print formatter to the PrintFormatter property. The built-in print formatters include the UISimpleTextPrintFormatter which can be used for simple rending text across multiple pages and has control for font, color, alignment and line breaking modes; For more advanced text printing you can use the UIMarkupTextPrintFormatter; For printing UIViews, you use the UIViewPrintFormatter which has a bulit-in ability to print the contents of a UIWebView, UITextView and MKMapView objects.
:
For more advanced uses, where you might want to control the actual rendering of the page, you must implement a subclass of UIPrintPageRenderer and assign the instance of your renderer to the PrintPageRenderer property.
:

//
// Print a PDF file, simple API
//
       NSUrl url = NSUrl.FromFilename ("SomeFile.pdf");           
var printInfo = UIPrintInfo.PrintInfo;

       printInfo.OutputType = UIPrintInfoOutputType.General;
       printInfo.JobName = "Test: PDF Print";

       var printer = UIPrintInteractionController.SharedPrintController;

       printer.PrintInfo = printInfo;
       printer.PrintingItem = url;
       printer.ShowsPageRange = true;

       printer.Present (true, (handler, completed, err) =&gt; {
           if (!completed &amp; err != null){
               Console.WriteLine ("error");
           }
       });

Constructors

UIPrintInteractionController(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
UIPrintInteractionController(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

ChooseCutterBehavior	Delegate invoked by the object to get a value.
ChoosePaper	Delegate invoked by the object to get a value.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
CutLengthForPaper	Delegate invoked by the object to get a value.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Delegate	An instance of the UIKit.IUIPrintInteractionControllerDelegate model class which acts as the class delegate.
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
GetViewController	Delegate invoked by the object to get a value.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
PrintableUTIs	Uniform Type Identifiers for the types of data that UIKit can print.
PrintFormatter	The UIPrintFormatter that will lay out of the content of pages based on the kind of content.
PrintInfo	Information about the print job.
PrintingAvailable	Whether printing is available.
PrintingItem	A ready-to-print object.
PrintingItems	An array of ready-to-print objects.
PrintPageRenderer	If set, use the specified instance of UIPrintPageRenderer for printing.
PrintPaper	Holds the paper size and printing area for the print job. Read-only.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
SharedPrintController	The shared print-interaction controller object.
ShowsNumberOfCopies	Whether the printing options includes the number of copies to be printed.
ShowsPageRange	Developers should not use this deprecated property. Page range is now always shown.
ShowsPaperSelectionForLoadedPapers	Boolean set for enabling the paper selection menu.
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
WeakDelegate	An object that can respond to the delegate protocol for this type
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (Inherited from NSObject)
CanPrint(NSData)	Determines if the data stored in the NSData can be printed.
CanPrint(NSUrl)	Whether printing is available.
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dismiss(Boolean)	Dismisses the printing-options sheet or popover.
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the UIPrintInteractionController object.
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
Present(Boolean, UIPrintInteractionCompletionHandler)	Presents an iPhone printing user interface.
PresentAsync(Boolean, Boolean)	Presents an iPhone printing user interface asynchronously.
PresentAsync(Boolean)	Presents an iPhone printing user interface.
PresentFromBarButtonItem(UIBarButtonItem, Boolean, UIPrintInteractionCompletionHandler)	Presents an iPad printing user interface in a popover view that can be animated from a soecified bar-button item.
PresentFromBarButtonItemAsync(UIBarButtonItem, Boolean, Boolean)	Asynchronously presents the iPad printing user interface in a popover view that can be animated from a bar-button item.
PresentFromBarButtonItemAsync(UIBarButtonItem, Boolean)	Presents an iPad printing user interface in a popover view that can be animated from a soecified bar-button item.
PresentFromRectInView(CGRect, UIView, Boolean, UIPrintInteractionCompletionHandler)	Presents an iPad printing user interface in a particular popover view that can be animated from any specified area in a view.
PresentFromRectInViewAsync(CGRect, UIView, Boolean, Boolean)	Asynchronously presents the iPad printing user interface in a popover view that can be animated from any area in a view.
PresentFromRectInViewAsync(CGRect, UIView, Boolean)	Presents an iPad printing user interface in a particular popover view that can be animated from any specified area in a view.
PrintToPrinter(UIPrinter, UIPrintInteractionCompletionHandler)	Prints directly to a specified printer.
PrintToPrinterAsync(UIPrinter, Boolean)	Asynchronously prints directly to a specified printer, returning a task that provides the result.
PrintToPrinterAsync(UIPrinter)	Prints directly to a specified printer.
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Events

DidDismissPrinterOptions	Event raised by the object.
DidFinishJob	Event raised by the object.
DidPresentPrinterOptions	Event raised by the object.
WillDismissPrinterOptions	Event raised by the object.
WillPresentPrinterOptions	Event raised by the object.
WillStartJob	Event raised by the object.

Extension Methods

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to

Share via