Home > Articles > Mobile Application Development & Programming

This chapter is from the book

The Document Interaction Controller

The UIDocumentInteractionController class allows applications to present a menu of options to users, allowing them to use document files in a variety of ways. With this class, users can take advantage of

  • iOS application-to-application document sharing (i.e., “open this document in...some app”)
  • Document preview using iOS’s built-in QuickLook technology
  • Copying documents to the pasteboard or printing them

The controller is presented as a small menu, which allows users to specify how they want to interact with the given document. Figure 16-4 shows presentations on the iPad and iPhone.

Figure 16-4

Figure 16-4. The UIDocumentInteractionController shown in its options style for iPad (left) and iPhone (right).

The controller offers two basic menu styles. The “open” style offers only “open in” choices, using the menu space to provide as many destination choices as possible. The “options” style (refer to Figure 16-4) provides a list of all interaction options including open-in, quick-look, and any supported actions. Figure 16-5 shows the basic options available via these controllers.

Creating Document Interaction Controller Instances

Each document interaction controller is created to present options for a file, typically in the user’s Documents folder. You supply a URL pointing to the file and present the controller, typically from a bar button. The bar button presentation style works across platforms and simplifies coding, even though the iPhone implementation scrolls the controller view up from the bottom of the screen as an action sheet.

As a rule, I use a local instance variable to hold onto any current controllers and popovers, dismissing them before introducing any new choice items. Keep that in mind as you read through this section and the ones that follow it.

Figure 16-5

Figure 16-5. The document interaction controller provides access from your application to a variety of system services, as well as to other applications that support editing and viewing a document.

Thank you, Omni Group, for providing a copy of OmniGraffle to help build this diagram.

The following snippets show how to create and present both styles of controllers. In each case, any previous controller is dismissed, a new controller created, and the delegate assigned to the primary view controller. The presentation method determine whether the controller is shown as an options menu (presentOptionsMenuFromBarButtonItem:animated:) or as an open-in menu (presentOpenInMenuFromBarButtonItem:animated:).

- (void) options: (UIBarButtonItem *) bbi

{

    if (dic)

        [dic dismissMenuAnimated:NO];



    dic = [UIDocumentInteractionController

        interactionControllerWithURL:

            [NSURL fileURLWithPath:path]];

    dic.delegate = self;



    [dic presentOptionsMenuFromBarButtonItem:bbi animated:YES];

}



- (void) open: (UIBarButtonItem *) bbi

{

    if (dic)

        [dic dismissMenuAnimated:NO];



    dic = [UIDocumentInteractionController

        interactionControllerWithURL:

            [NSURL fileURLWithPath:path]];

    dic.delegate = self;



    [dic presentOpenInMenuFromBarButtonItem:bbi animated:YES];

}

I always implement dismissal callbacks in order to round out my local instance variable approach.

- (void) documentInteractionControllerDidDismissOpenInMenu:

     (UIDocumentInteractionController *) controller

    {  dic = nil; }



- (void) documentInteractionControllerDidDismissOptionsMenu:

    (UIDocumentInteractionController *) controller

    {  dic = nil; }

Document Interaction Controller Properties

Each document interaction controller offers a number of properties, which can be used in your delegate callbacks:

  • The URL property allows you to query the controller for the file it is servicing. This is the same URL you pass when creating the controller.
  • The UTI property is used to determine which apps can open the document. It uses the automatic routines discussed earlier in the chapter to find the most preferred UTI match based on the file name and metadata, although you can override this in code to set the property manually.
  • The name property provides the last path component of the URL, offering a quick way to provide a user-interpretable name without having to manually strip the URL yourself.
  • Use the icons property to retrieve an icon for the file type. Applications that declare support for certain file types provide image links in their declaration (as you’ll see shortly, in the discussion about declaring file support). These images correspond to the values stored for the kUTTypeIconFileKey key, as discussed earlier in this chapter.
  • The annotation property provides a way to pass custom data along with a file to any application that will open the file. There are no standards for using this property, although the item must be set to some top-level property list object, namely dictionaries, arrays, data, strings, numbers, and dates. Because there are no community standards yet, use of this property tends to be minimal except where developers use the information across their own suite of published apps.

Providing Document Quick Look Support

Add Quick Look support to your apps by providing a trio of delegate callbacks. In these methods, you declare which view controller will be used to present the preview, which view will host it, and the frame for the preview size. You may have occasional compelling reasons to use a child view controller with limited screen presence on the iPad (such as in a split view, with the preview in just one portion), but for the iPhone, there’s almost never any reason not to allow the preview to take over the entire screen.

#pragma mark QuickLook

- (UIViewController *)

    documentInteractionControllerViewControllerForPreview:

       (UIDocumentInteractionController *)controller

{

    return self;

}



- (UIView *)

    documentInteractionControllerViewForPreview:

    (UIDocumentInteractionController *)controller

{

    return self.view;

}



- (CGRect)

    documentInteractionControllerRectForPreview:

    (UIDocumentInteractionController *)controller

{

    return self.view.frame;

}

Providing Printer and Copy Support

The interaction controller class currently offers two possible actions: namely, printing and copying. These actions are sent as selector parameters, namely copy: and paste:, to a pair of delegate methods. The first method specifies whether each action (and any other future action that Apple might support) can be performed. If so, it can be added to the actions menu. If not, that item is skipped. This method is called by the controller as it builds the menu and before it’s presented.

In the following snippet, each action request is handled separately. In the case of copying, the file’s size is checked, limiting copies to under 5MB. This approach assumes the application will be pasting actual data, rather than a URL pointing to the document. For the later case, you might simply return YES after checking for the file’s existence rather than calculating its size.

The print action here is set to be contingent on whether printing is available. You can create a pseudo printer for your system in the Simulator by choosing File > Open Printer Simulator. I personally use Ecamm’s $20 Printopia product (www.ecamm.com/mac/printopia/) to enable AirPrinting to my normal Brother printer. It acts as an AirPrint server and then redirects any print requests to my normally non-AirPrint–enabled hardware. Printopia also allows me to “print” to DropBox, which is also handy, especially for saving paper.

- (BOOL) documentInteractionController:

    (UIDocumentInteractionController *)controller

    canPerformAction:(SEL)action

{

    if (action == @selector(copy:))

    {

        // Copy only items under 5MB

        long long fileSize =

            [[NSFileManager defaultManager]

                attributesOfItemAtPath:path error:nil].fileSize;

        return (fileSize < 5 * 1024 * 1024);

    }



    if (action == @selector(print:))

    {

        return [UIPrintInteractionController isPrintingAvailable];

    }



    return YES;

}

The actual copying and printing is performed in a second delegate callback. In this method, once again, the requested action is checked before performing any task. This application sample manages images, using the pasteboard’s image property to perform the copy action. As with the previous method, you’ll need to adapt this to whatever data you’re actually working with.

On the printing end of things, the printer is first checked to see if the item can be printed. If not, it logs an error and returns. Otherwise, it chooses the appropriate print controller presentation on a per-platform basis and presents it. All further printing control is handled through the UIPrintInteractionController class. If you want to act as the print controller’s delegate, there is a full suite of callbacks that you can implement. The callbacks let you know when the print job has started and stopped. For the most part, I just let it run in its default and let these things be as they may.

- (BOOL) documentInteractionController:

    (UIDocumentInteractionController *)controller

    performAction:(SEL)action

{

    if (action == @selector(copy:))

    {

        // Copy the image to the pasteboard

        UIImage *image = [UIImage imageWithContentsOfFile:path];

        [UIPasteboard generalPasteboard].image = image;

        return YES;

    }



    if (action == @selector(print:))

    {

        // Check if the item can be printed

        if (![UIPrintInteractionController

            canPrintURL:controller.URL])

        {

            NSLog(@"Item is not printable: %@", controller.URL);

            return NO;

        }



        [UIPrintInteractionController

            sharedPrintController].printingItem = controller.URL;

        if (IS_IPAD)

            [[UIPrintInteractionController sharedPrintController]

                presentFromBarButtonItem:

                    self.navigationItem.rightBarButtonItem

                animated:YES completionHandler:nil];

        else

            [[UIPrintInteractionController sharedPrintController]

                presentAnimated:YES completionHandler:nil];

        }

        return YES;

    }



    return YES;

}

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020