Product:

Get started

Samples

Basic operations

Learn More

Viewer

Overview

New Document Viewer

Viewer Hierarchy (Android)

Integrate

Configuration

Customize Document Viewer

Customize PDFViewCtrl

View mode

Scroll direction

Theme

Viewer Events (Android)

Stream PDF

Right-to-left (Android)

Coordinates

Localization

Migrate

Samples

APIs

UI customization

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

Customize the Document Viewer UI

Customize the Document Viewer UI in Xamarin.Android

Customize the theme

The theme of PdfViewCtrlTabHostFragment2 can be set by calling the following method when creating the fragment using ViewerBuilder2:

C#

1// Add a viewer fragment to the layout container in the specified 
2// activity, and returns the added fragment
3public PdfViewCtrlTabHostFragment2 addViewerFragment(
4        int fragmentContainer,
5        AppCompatActivity activity,
6        Android.Net.Uri fileUri,
7        String password,
8        int customTheme)
9{
10
11    // Create the viewer fragment
12    PdfViewCtrlTabHostFragment2 fragment =
13            ViewerBuilder2.WithUri(fileUri, password)
14                    // Add custom theme here
15                    .UsingTheme(customTheme)
16                    .Build(activity) as PdfViewCtrlTabHostFragment2;
17
18    // Add the fragment to the layout fragment container
19    activity.SupportFragmentManager.BeginTransaction()
20            .Replace(fragmentContainer, fragment)
21            .Commit();
22
23    return fragment;
24}

Theme supplied to ViewerBuilder2.usingTheme(int) is recommended to extend PDFTronAppThemeBase. If you cannot extend PDFTronAppThemeBase and is extending an AppCompat theme, then you will need to define custom theme attributes for the theme to work properly. Custom attributes are listed in the table below. PDFTronAppThemeBase contains a number of attributes which can be used to define the style for certain UI components. A full list of theme attributes can be found below:

Attribute	Description
`pt_toolbar_theme`	Used to style the options menu toolbar. See `ToolbarTheme`.
`pt_toolbar_popup_style`	Used to style the popup menu in the toolbar. See `ToolbarPopupTheme`.
`pt_toolbar_style`	Used to style the options menu toolbar background. See `ToolbarStyle`.
`quick_menu_item`	Used to style the quick menu. See `QuickMenuItem`.
`custom_bookmarks_tab_layout`	Used to style the outline/user bookmark/annotation list dialog. See `BookmarksTabLayoutStyle`.
`pt_stamp_tab_layout_style`	Used to style the stamp dialog tab layout. See `StampTabLayoutStyle`.
`pt_bottom_bar_style`	Used to style the bottom navigation bar. See `PTBottomBarTheme`.
`pt_preset_bar_style`	Used to style the annotation preset bar. See `PTPresetBarTheme`.
`pt_annotation_toolbar_style`	Used to style the annotation toolbar. See `PTAnnotationToolbarTheme`.
`pt_toolbar_switcher_dialog_style`	Used to style the toolbar switcher popup dialog. See `PTToolbarSwitcherDialogTheme`.
`pt_toolbar_switcher_button_style`	Used to style the toolbar switcher menu button. See `PTToolbarSwitcherButtonTheme` .
`pt_toolbar_tab_action_button_style`	Used to style the tab action button. See `TabActionButtonTheme` .
`pt_document_slider_style`	Used to style the page slider. See `DocumentSliderStyle`.
`pt_pdf_tab_layout_style`	Used to style the document tabs. See `PdfTabLayoutStyle`.
`pt_floating_nav_style`	Used to style the floating action buttons. See `DefaultFloatingButtonNavStyle`.
`pt_sound_dialog_style`	Used to style the sound annotation dialog. See `SoundDialogStyle`.
`pt_page_indicator_style`	Used to style the page indicator. See `PageIndicatorTheme`.
`pt_sticky_note_dialog`	Used to style the sticky note dialog. See `DialogStickyNote`.
`pt_create_signature_dialog_style`	Used to style the signature creation dialog. See `CreateSignatureDialogTheme`.
`pt_menu_editor_dialog_style`	Used to style the toolbar editor dialog. See `MenuEditorDialogTheme`.
`pt_annot_style_dialog_style`	Used to style the annotation style dialog. See `AnnotStyleDialogTheme`.
`pt_annotation_filter_dialog_style`	Used to style the annotation filter dialog. See `AnnotationFilterDialogTheme`.
`pt_create_stamp_dialog_style`	Used to style the stamp creation dialog. See `CreateStampDialogTheme`.
`pt_add_page_dialog_style`	Used to style the add page dialog. See `AddPageDialogTheme`.
`pt_tab_switcher_dialog_style`	Used to style the tab switcher dialog. See `TabSwitcherDialogTheme`.
`pt_outline_dialog_style`	Used to style the outline dialog. See `OutlineDialogTheme`

A full list of attributes can be found in the styles.xml file in the Apryse Android SDK Tools package.

Customizing the default annotation toolbars

The built-in default toolbars can be customized using the ViewerConfig and ToolManagerBuilder classes. To hide a specific toolbar, call ViewerConfig.Builder.hideToolbars(String[]) with the toolbar's tag. For example to hide the annotate toolbar:

C#

1ViewerConfig.Builder builder = new ViewerConfig.Builder()
2        .HideToolbars(
3                new String[]{
4                        DefaultToolbars.TagAnnotateToolbar
5                }
6        );

To hide certain tool buttons, you can disable tool modes using ToolManagerBuilder as described in this guide.

The options toolbar can be customized using a similar method as described in this guide, however the ViewerBuilder2 class will be used instead of ViewerBuilder.

Customize the Document Viewer UI in Xamarin.iOS

The following snippets assume you are using a PTDocumentController called documentController:

C#

1PTDocumentController documentController = new PTDocumentController();

C#

1documentController.ToolGroupIndicatorView.Hidden = true;

The toolbar can be programmatically hidden by setting the mode to view group, which is a special group and the only group where the toolbar is hidden:

C#

1documentController.ToolGroupManager.SelectedGroup = documentController.ToolGroupManager.ViewItemGroup;

The toolbar can be shown again by changing the group to any group other than view:

C#

1documentController.ToolGroupManager.SelectedGroup = documentController.ToolGroupManager.DrawItemGroup;

Remove toolbars from the switcher

Toolbars can be removed by removing them from the toolGroupManager's groups array. The following code removes the "Draw" and "Pens" toolbars:

C#

1NSMutableArray<PTToolGroup> mutableGroups = new NSMutableArray<PTToolGroup>(documentController.ToolGroupManager.Groups);
2
3mutableGroups.RemoveObject((nint)mutableGroups.IndexOf(documentController.ToolGroupManager.DrawItemGroup));
4mutableGroups.RemoveObject((nint)mutableGroups.IndexOf(documentController.ToolGroupManager.PensItemGroup));
5
6documentController.ToolGroupManager.Groups = NSArray.FromArray<PTToolGroup>(mutableGroups);

The example below shows how to remove the text highlight and text underline button from a toolbar.

Disabling a tool type entirely

If you want to disable a tool entirely, from all toolbars and the long press menu, please use the annotations permissions system.

C#

1PTToolGroup annotateGroup = documentController.ToolGroupManager.AnnotateItemGroup;
2
3// tool buttons that exist currently
4UIBarButtonItem[] defaultAnnotateGroupTools = annotateGroup.BarButtonItems;
5
6// new set of tools to replace current ones
7NSMutableArray<UIBarButtonItem> newAnnotateGroupTools = new NSMutableArray<UIBarButtonItem>();
8
9// add all currently existing tools except for the ones we don't want
10foreach (UIBarButtonItem defaultToolItem in defaultAnnotateGroupTools) {
11    if (defaultToolItem.IsKindOfClass(new ObjCRuntime.Class(typeof(PTToolBarButtonItem))))
12    {
13        PTToolBarButtonItem toolBarButton = (PTToolBarButtonItem)defaultToolItem;
14
15        if (toolBarButton.ToolClass.Equals(new ObjCRuntime.Class(typeof(PTTextHighlightCreate))) ||
16                toolBarButton.ToolClass.Equals(new ObjCRuntime.Class(typeof(PTTextUnderlineCreate)))) {
17            continue;
18        }
19        else {
20            newAnnotateGroupTools.Add(defaultToolItem);
21        }
22    }
23    else {
24        newAnnotateGroupTools.Add(defaultToolItem);
25    }
26}
27
28// assign tools to new array
29documentController.ToolGroupManager.AnnotateItemGroup.BarButtonItems = NSArray.FromArray<UIBarButtonItem>(newAnnotateGroupTools);

C#

1// create a mutable array of the current items in the annotation toolbar group
2NSMutableArray<UIBarButtonItem> availableTools = new NSMutableArray<UIBarButtonItem>(documentController.ToolGroupManager.AnnotateItemGroup.BarButtonItems);
3
4// create a new toolbar item for freehand annotations
5UIBarButtonItem[] freeHandItem = { documentController.ToolGroupManager.CreateItemForToolClass(new ObjCRuntime.Class(typeof(PTFreeHandCreate))) };
6
7
8// add the freehand annotation item to the front of the list
9availableTools.InsertObjects(freeHandItem, new NSIndexSet(0));
10
11// assign the array back to the annotation toolbar group.
12documentController.ToolGroupManager.AnnotateItemGroup.BarButtonItems = NSArray.FromArray<UIBarButtonItem>(availableTools);

The code below creates a new toolbar that contains a free hand, cloudy and image stamp tool.

C#

1UIImage image = new UIImage("square.and.pencil");
2
3// the tools it will contain
4UIBarButtonItem freeHandItem = documentController.ToolGroupManager.CreateItemForToolClass(new ObjCRuntime.Class(typeof(PTFreeHandCreate)));
5UIBarButtonItem cloudyItem = documentController.ToolGroupManager.CreateItemForToolClass(new ObjCRuntime.Class(typeof(PTCloudCreate)));
6UIBarButtonItem stampItem = documentController.ToolGroupManager.CreateItemForToolClass(new ObjCRuntime.Class(typeof(PTImageStampCreate)));
7
8UIBarButtonItem[] tools = { freeHandItem, cloudyItem, stampItem };
9
10// the name of the custom group, its image, and its tool items
11PTToolGroup customGroup = PTToolGroup.GroupWithTitle("MyApps Group", image, tools);
12            
13NSMutableArray<PTToolGroup> groups = new NSMutableArray<PTToolGroup>(documentController.ToolGroupManager.Groups);
14groupss.Add(customGroup);
15
16// add the tool group
17documentController.ToolGroupManager.Groups = NSArray.FromArray<PTToolGroup>(groups);

Add a button with fully custom behavior

Your app may need a button that does not invoke one of the built in annotation tools. The following code will add a button that calls a selector.

C#

1PTSelectableBarButtonItem selectableItem = new PTSelectableBarButtonItem();
2selectableItem.Title = "Custom Tool";
3selectableItem.Image = UIImage("square.and.pencil");
4selectableItem.Style = UIBarButtonItemStyle.Plain;
5
6NSMutableArray<UIBarButtonItem> availableTools = new NSMutableArray<UIBarButtonItem>(documentController.ToolGroupManager.AnnotateItemGroup.BarButtonItems);
7
8availableTools.Add(items);
9
10documentController.ToolGroupManager.AnnotateItemGroup.BarButtonItems = NSArray.FromArray<UIBarButtonItem>(availableTools);

If you want to toggle the items selection, flip its selected property:

C#

1selectableItem.Clicked += (button, e) => { 
2    button.isSelected = !button.isSelected
3}

Modify `UINavigationBar` Items

You can modify the navigation bar items. Here is an example of adding a new button (for the current size class):

C#

1UIBarButtonItem myItem = new UIBarButtonItem(UIImage("square.and.pencil"), UIBarButtonItemStyle.Plain, null);
2
3NSMutableArray<UIBarButtonItem> navigationItems = new NSMutableArray<UIBarButtonItem>(documentController.NavigationItem.RightBarButtonItems);
4navigationItems.Add(myItem);
5             
6documentController.NavigationItem.RightBarButtonItems = NSArray.FromArray<UIBarButtonItem>(navigationItems);

Tools can also be added:

C#

1UIBarButtonItem freeHand = documentController.ToolGroupManager.CreateItemForToolClass(new ObjCRuntime.Class(typeof(PTFreeHandCreate)));
2NSMutableArray<UIBarButtonItem> navigationItems = new NSMutableArray<UIBarButtonItem>(documentController.NavigationItem.RightBarButtonItems);
3navigationItems.Add(freeHand);
4
5documentController.NavigationItem.RightBarButtonItems = NSArray.FromArray<UIBarButtonItem>(navigationItems);

Note that in the example above, de-selecting the tool button item needs to be implemented by the app, by listening to the Tool Did Change notification.

These are the buttons that appear at the bottom of the screen.

C#

1// new button
2UIBarButtonItem myItem = new UIBarButtonItem(UIImage("square.and.pencil"), UIBarButtonItemStyle.Plain, null, null);
3
4// spacer to keep evenly spaced buttons
5UIBarButtonItem spacer = new UIBarButtonItem(UIBarButtonSystemItem.FlexibleSpace, null, null);
6
7// new array
8NSMutableArray<UIBarButtonItem> toolbarItems = new NSMutableArray<UIBarButtonItem>(documentController.ToolbarItems);
9toolbarItems.Add(spacer);
10toolbarItems.Add(myItem);
11
12// set the toolbarItems to the new items
13documentController.ToolbarItems = NSArray.FromArray<UIBarButtonItem>(toolbarItems);

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:

Customize the Document Viewer UI

Customize the Document Viewer UI in Xamarin.Android

Customize the theme

C#

Customizing the default annotation toolbars

C#

Hide annotation toolbar buttons

Customize the options toolbar

Customize the Document Viewer UI in Xamarin.iOS

C#

Hide the Toolbar Switcher

C#

Hide (and show) the annotation toolbar

C#

C#

Remove toolbars from the switcher

C#

Remove buttons from a toolbar

Disabling a tool type entirely

C#

Add a tool button to a toolbar

C#

Create a new toolbar

C#

Add a button with fully custom behavior

C#

C#

Modify UINavigationBar Items

C#

C#

Add and Remove Toolbar Items (iPhone UI)

C#

Modify `UINavigationBar` Items