Product:

Get started

Samples

Basic operations

Learn More

Viewer

UI customization

Overview

UI components

Quick menu (Android)

Customize quick menu (Android)

Thumbnail slider

List container

Config tools (iOS)

Custom tool

Set tool mode

Add a custom view to a page

Samples

APIs

Annotation

Collaboration

MS Office

Conversion

PDF/A

Forms

Generate

Page manipulation

Edit page content

Extraction

Digital signature

Bookmarks

Compare files

Optimization

Layers (OCGs)

Measurement

Redaction

Security

Portfolios

Low-level PDF API

Changelogs

List Container

The list container is a UI component that contains other components related to annotations and bookmarks.

This tutorial only applies to Xamarin.Android. See Xamarin.iOS equivalent here .

The list container provides a horizontal layout to display the following items in separate tabs:

Show list container

The list container is implemented by the BookmarksDialogFragment class. To show this fragment in your activity, create a new instance of BookmarksDialogFragment by calling newInstance(). Afterwards, initialize your fragment by setting the PDFViewCtrl and an ArrayList of DialogFragmentTab:

C#

1private PDFViewCtrl mPdfViewCtrl;
2// ...
3public void ShowBookmarksDialog(List<DialogFragmentTab> dialogFragmentTabs,
4                                FragmentManager fragmentManager) {
5    var fragment = BookmarksDialogFragment.NewInstance();
6    fragment.SetPdfViewCtrl(mPdfViewCtrl)
7            .SetDialogFragmentTabs(dialogFragmentTabs);
8    // Set a custom style for this fragment
9    fragment.SetStyle((int)DialogFragmentStyle.NoTitle, Resource.Style.PDFTronAppTheme);
10    // Show the dialog
11    fragment.Show(fragmentManager, "bookmarks_dialog");
12}

DialogFragmentTab specifies the information about each tab including the type of class and the tab tag. Currently the following dialogs can be displayed within the bookmarks dialog:

Dialog	Type of class	Tab tag
Annotation list	AnnotationDialogFragment.class	TAG_TAB_ANNOTATION
Document outline	OutlineDialogFragment.class	TAG_TAB_OUTLINE
User bookmark list	UserBookmarkDialogFragment.class	TAG_TAB_BOOKMARK

The following example shows how to display an annotations list, a document outline, and a user-defined bookmark list tabs in BookmarksDialogFragment:

C#

1using pdftron.PDF.Tools.Utils;
2
3var bookmarksDialog = pdftron.PDF.Dialog.BookmarksDialogFragment.NewInstance();
4bookmarksDialog.SetPdfViewCtrl(mPdfViewCtrl);
5List<DialogFragmentTab> tabs = new List<DialogFragmentTab>();
6var annotationsTab = new DialogFragmentTab(
7    Java.Lang.Class.FromType(typeof(AnnotationDialogFragment)), BookmarksTabLayout.TagTabAnnotation, null, "Annotations", "Bookmarks Dialog", null);
8var outlineDialog = new DialogFragmentTab(
9    Java.Lang.Class.FromType(typeof(OutlineDialogFragment)), BookmarksTabLayout.TagTabOutline, null, "Outline", "Bookmarks Dialog", null);
10var userBookmarksDialog = new DialogFragmentTab(
11    Java.Lang.Class.FromType(typeof(UserBookmarkDialogFragment)), BookmarksTabLayout.TagTabBookmark, null, "User Bookmarks", "Bookmarks Dialog", null);
12tabs.Add(annotationsTab);
13tabs.Add(outlineDialog);
14tabs.Add(userBookmarksDialog);
15bookmarksDialog.SetDialogFragmentTabs(tabs);
16bookmarksDialog.SetStyle((int)DialogFragmentStyle.NoTitle, Resource.Style.PDFTronAppTheme);
17bookmarksDialog.Show(this.SupportFragmentManager, "bookmarks_dialog");
18bookmarksDialog.AnnotationClicked += (sender, e) =>
19{
20    bookmarksDialog.Dismiss();
21};
22bookmarksDialog.ExportAnnotations += (sender, e) =>
23{
24    // handle export annotations here
25    bookmarksDialog.Dismiss();
26};
27bookmarksDialog.OutlineClicked += (sender, e) =>
28{
29    bookmarksDialog.Dismiss();
30};
31bookmarksDialog.UserBookmarkClick += (sender, e) =>
32{
33    mPdfViewCtrl.SetCurrentPage(e.PageNum);
34    bookmarksDialog.Dismiss();
35};

Customization

The BookmarksDialogFragment provides a flexible API for displaying only the desired child view. Any of the annotation list, document outline, or user-defined bookmark list view can be removed by omitting them from the DialogFragmentTabs.

This tutorial only applies to Xamarin.iOS. See Xamarin.Android equivalent here .

The PTNavigationListsViewController class is a container view controller that shows the annotation list, document outline, and user-defined bookmark list controls with a UITabBarController-like interface. A segmented control is used to select which child view controller to display.

The navigation lists control is part of the Tools library, so make sure you have added the Tools library to your project.

To create a new navigation lists view controller and display it from another view controller, set the child list view controllers to the PTNavigationListsViewController class's ListViewControllers property:

C#

1var navigationListsViewController = new PTNavigationListsViewController(mToolManager);
2
3var annotationViewController = new PTAnnotationViewController(mPdfViewCtrl);
4annotationViewController.AnnotationViewControllerAnnotationSelected += (object sender, AnnotationViewControllerAnnotationSelectedEventArgs e) => {
5    // perform custom action
6};
7annotationViewController.AnnotationViewControllerDidCancel += (object sender, EventArgs e) => {
8    // perform custom action
9};
10
11var outlineViewController = new PTOutlineViewController (mPdfViewCtrl);
12outlineViewController.OutlineViewControllerOutlineSelected += (sender, e) => {
13    // perform custom action
14};
15outlineViewController.OutlineViewControllerDidCancel += (object sender, EventArgs e) => {
16    // perform custom action
17};
18
19var bookmarkViewController = new PTBookmarkViewController (mPdfViewCtrl);
20bookmarkViewController.BookmarkViewControllerBookmarkSelected += (sender, e) => {
21    // perform custom action
22};
23bookmarkViewController.BookmarkViewControllerDidCancel += (object sender, EventArgs e) => {
24    // perform custom action
25};
26
27navigationListsViewController.ListViewControllers = new UIViewController[] {
28    outlineViewController, annotationViewController, bookmarkViewController
29};
30if (UserInterfaceIdiomIsPhone)
31{
32  navigationListsViewController.ModalPresentationStyle = UIModalPresentationStyle.FullScreen;
33} else{
34  navigationListsViewController.ModalPresentationStyle = UIModalPresentationStyle.Popover;
35  navigationListsViewController.PopoverPresentationController.BarButtonItem = navigationListsButton;
36}
37this.PresentViewController(navigationListsViewController, true, null);

Presenting on iPads:

The navigation list view controller is designed to be presented in a popover on iPads. To do so, you must provide the PTNavigationListsViewController's PopoverPresentationController with either:

a SourceRect AND
a SourceView

a BarButtonItem

as in the example above.

Customization

The PTNavigationListViewController provides a flexible API for displaying only the desired child view controllers. Any of the annotation list, document outline, or user-defined bookmark list view controllers can be removed by omitting them from the listViewControllers property. It is also possible to add a custom child view controller by adding it to the listViewControllers array.

To specify which of the child view controllers to display on opening the navigation list control, either the SelectedIndex , or the SelectedViewController property can be used.

C#

1// Show the navigationListsViewController's annotationViewController on opening
2navigationListsViewController.SelectedViewController = navigationListsViewController.annotationViewController;
3// OR specify an index to show from the `listViewControllers` property
4navigationListsViewController.SelectedIndex = 0;

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales

Product:

Product:

List Container

List container to customize horizontal menu layout in Xamarin.Android

This tutorial only applies to Xamarin.Android. See Xamarin.iOS equivalent here .

Show list container

C#

C#

Customization

List container to customize horizontal menu layout in Xamarin.iOS

This tutorial only applies to Xamarin.iOS. See Xamarin.Android equivalent here .

Show a navigation lists view controller

C#

Presenting on iPads:

Customization

C#