Open a document (iOS)

You have a few options to open a document such as with a document view controller or tabbed document view controller.

Document view controller in Xamarin.iOS

The PTDocumentController shows a PDF viewer and annotator complete with controls such as an annotation toolbar, page layout controls, bookmarks, thumbnail viewer, etc. All of its component pieces are part of the Tools framework, and this class packages them into one easy to use view controller.

For a version of PTDocumentController that supports multiple documents, see PTTabbedDocumentViewController.

Apryse Docs Image

The document viewer includes a convenient document interaction and annotation toolbar at the top as well as convenient access to a number of powerful built-in components.

The PTDocumentController is a subclass of the PTDocumentBaseViewController from which it inherits much of its functionality.

Show a document

The document viewer is part of the Tools library, so make sure you have added the Tools library to your project.

The following shows how to create a document viewer, set the document to display, and present it on screen.

C#

1PTDocumentController documentController = new PTDocumentController();
2UINavigationController navigationController = new UINavigationController(documentController);
3NSUrl fileURL = NSBundle.MainBundle.GetUrlForResource("sample", "pdf");
4
5documentController.OpenDocumentWithURL(fileURL);
6
7documentController.NavigationItem.LeftBarButtonItem = new UIBarButtonItem(UIBarButtonSystemItem.Done, (sender, e) => {
8 documentController.DismissViewController(true, null);
9});
10this.PresentViewController(navigationController, true, null);

Respond to Opening Events

openDocumentWithURL: is an asynchronous method. To respond to errors or other events that occur during opening, assign an object that conforms to the PTDocumentControllerDelegate to the PTDocumentController's delegate property and implement the following optional methods:

  • documentControllerDidOpenDocument: to respond to successfully opening a document.
  • documentController:didFailToOpenDocumentWithError: to respond to an error during document opening.
  • documentController:destinationURLForDocumentAtURL: to control where remote or converted documents are saved.

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales