Product:

Get started

Overview

Xamarin.Android

Step 1: Integrate

Step 2: View a document

Step 3: Customize

Xamarin.iOS

Step 1: Integrate

Step 2: View a document

Step 3: Customize

Xamarin.Forms

Download

Samples

Package samples

Basic operations

Overview

Open a document

Save a document

Lock a document

Samples

APIs

Learn More

Permissions (Android)

Java bindings (Android)

Obj-C bindings (iOS)

Code sharing

Type conversion

UI icons

Update to latest version

File format support

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

Overview

UI components

Quick menu (Android)

Customize quick menu (Android)

Thumbnail slider

List container

Config tools (iOS)

Custom tool

Android

iOS

Set tool mode

Add a custom view to a page

Samples

APIs

Annotation

Collaboration

Overview

Setup (Android)

Connect to server

Custom UI (Android)

Samples

APIs

MS Office

Overview

Open MS Office file

Samples

APIs

Conversion

Overview

Web/HTML to PDF

MS Office to PDF

Convert to PDF

Convert from PDF

Samples

APIs

PDF/A

Overview

Convert PDF to PDF/A

Validate PDF/A

Samples

APIs

Forms

Overview

Form builder

WebViewer 11

WebViewer 8

WebViewer 7

Import form data into PDF

Export form data from PDF

Create form fields

Fill form fields

Form flatten

APIs

Samples

Generate

Overview

Create a blank PDF

Create a thumbnail

Template generation

Data Model

Structured Input

Advanced Features

Samples

APIs

Page manipulation

Overview

Thumbnail browser

Create a thumbnail

Create pages

Insert pages

Remove pages

Crop pages

Rotate pages

Reorder pages

Split pages

Page labels editor (Android)

Samples

APIs

Edit page content

Overview

Watermark editor (Android)

Stamp content

Remove content

Read content

Write content

Replace content

Graphics state

Undo & redo operations

Samples

APIs

Extraction

Overview

Text extraction

Image extraction

Embedded fonts

Samples

APIs

Digital signature

Overview

Sign a document

Signature tool (Android)

Digital Signature Validation (Android)

Certify a document

Samples

APIs

Overview

Text search

Search & replace

Samples

APIs

Bookmarks

Overview

Outline tree

User bookmarks

Add bookmark

Edit bookmark

Remove bookmark

Samples

APIs

Compare files

Overview

Overlay comparison

Samples

APIs

Optimization

Overview

Optimize

Flatten

Viewer optimized

Samples

APIs

Layers (OCGs)

Overview

Show/hide layers

Add layer

Extract layer

Samples

APIs

Measurement

Overview

Use measurement tools

Samples

APIs

Overview

Print a document

Samples

APIs

Redaction

Overview

Redact

Samples

APIs

Security

Overview

Encrypt

Decrypt

Apryse Custom Security Handler

Samples

APIs

Portfolios

Overview

Create a package

Samples

APIs

Low-level PDF API

Overview

Info dictionary

PDF format

SDF/COS object model

Filters and streams

Samples

APIs

View mode (Android)

There are a few view modes which can be adjusted to provide an optimal presentation such as layout, fit, or reflow. Additionally, you can present a view mode dialog allowing a user to change these settings.

Page layout/presentation mode

PDFViewCtrl supports a number of page layouts (presentation modes), as listed below:

Page presentation mode (Xamarin.Android / Xamarin.iOS)	Description
`PDFViewCtrl.PagePresentationModes.Single` / `pdftron.PDF.PagePresentationModes.e_single_page`	Displays one page at a time, swiping left and right to change pages.
`PDFViewCtrl.PagePresentationModes.SingleCont` / `pdftron.PDF.PagePresentationModes.e_single_continuous`	Displays one page at a time, scrolling up and down to change pages.
`PDFViewCtrl.PagePresentationModes.SingleVert`(Android)	Displays one page at a time, swiping up and down to change pages.
`PDFViewCtrl.PagePresentationModes.Facing` / `pdftron.PDF.PagePresentationModes.e_facing`	Displays two pages at a time, with odd-numbered pages on left, swiping left and right to change pages.
`PDFViewCtrl.PagePresentationModes.FacingCont` / `pdftron.PDF.PagePresentationModes.e_facing_continuous`	Displays pages in two columns, with odd-numbered pages on left, scrolling up and down to change pages.
`PDFViewCtrl.PagePresentationModes.FacingVert`(Android)	Displays two pages at a time, with odd-numbered pages on left, swiping up and down to change pages.
`PDFViewCtrl.PagePresentationModes.FacingCover` / `pdftron.PDF.PagePresentationModes.e_facing_cover`	Displays two pages at a time, with odd-numbered pages on right, swiping left and right to change pages.
`PDFViewCtrl.PagePresentationModes.FacingCoverCont` / `pdftron.PDF.PagePresentationModes.e_facing_continuous_cover`	Display pages in two columns, with odd-numbered pages on right, scrolling up and down to change pages.
`PDFViewCtrl.PagePresentationModes.FacingCoverVert`(Android)	Displays two pages at a time, with odd-numbered pages on right, swiping up and down to change pages.

Set the page presentation mode

You can set page presentation mode in your PDFViewCtrl by using PagePresentationMode property:

C#

1// Xamarin.Android
2mPdfViewCtrl.PagePresentationMode = pdftron.PDF.PDFViewCtrl.PagePresentationModes.Facing;
3
4// Xamarin.iOS
5mPdfViewCtrl.PagePresentationMode = pdftron.PDF.PagePresentationModes.e_facing;

Page fit & default zoom mode in Android

PDFViewCtrl's page view mode controls the default zoom level of pages and documents. New documents will automatically open at the zoom level specified by the mode.

Page view modes

PDFViewCtrl supports the following page view modes:

Page view mode (Xamarin.Android / Xamarin.iOS)	Description	Screenshot-portrait	Screenshot-landscape
`PDFViewCtrl.PageViewModes.FitPage` / `pdftron.PDF.PageViewModes.e_fit_page`	The zoom is set so that the entire page is visible without scrolling.
`PDFViewCtrl.PageViewModes.FitWidth` / `pdftron.PDF.PageViewModes.e_fit_width`	The zoom is set so that the page's width matches the viewer's width.
`PDFViewCtrl.PageViewModes.FitHeight` / `pdftron.PDF.PageViewModes.e_fit_height`	The zoom is set so that the page's height matches the viewer's height.
`PDFViewCtrl.PageViewModes.Zoom` / `pdftron.PDF.PageViewModes.e_zoom`	The viewer's zoom is not adjusted based on the page.

Set the default page fit mode

You can set a default page fit mode in your PDFViewCtrl by using PageRefViewMode property.

Set the page fit mode dynamically

If you want to dynamically change the page fit mode, use PageViewMode property. Note that when the user flips the page, the page view mode will be automatically reset to the default mode set by PageRefViewMode.

C#

1// Xamarin.Android
2mPdfViewCtrl.PageViewMode = pdftron.PDF.PDFViewCtrl.PageViewModes.FitPage;
3
4// Xamarin.iOS
5mPdfViewCtrl.PageViewMode = pdftron.PDF.PageViewModes.FitPage;

Reflow document content in Android

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

For Android, available in the full version of the library only. See Apryse full or standard?

Reflow makes the document more flexible and easier to read, especially on small devices. Apryse is able to extract the reflowable layout of each page in a PDF document to an HTML file. First, we explain how simple it is to show a widget that allows the user to swipe left or right through the pages of the document to see reflowable document pages. Then, we provide the methods necessary for converting a hard-layout PDF page to an HTML document page.

ReflowControl is a ViewPager that allows the user to flip left and right through the reflowable layout of pages in a PDF document.

Implementation

To set up your layout with ReflowControl, add a <ReflowControl> element to your XML layout. For example, if each page in the swipe view should consume the entire layout, then your layout looks like this:

XML

1<pdftron.PDF.Controls.ReflowControl android:id="@+id/reflow" android:layout_width="match_parent" android:layout_height="match_parent" />

Then, you need to attach a PDFDoc to the reflow pager:

C#

1var reflowControl = FindViewById<ReflowControl>(Resource.Id.reflow);
2reflowControl.Setup(pdfDoc);

Scrolling direction

C#

1// horizontal (default)
2reflowControl.Orientation = ReflowControl.Horizontal;
3// vertical
4reflowControl.Orientation = ReflowControl.Vertical;

That is everything you need to have a simple reflow pager.

To refresh the reflow pager to show the latest changes on your document, you should let the reflow pager know that the document has been modified:

Set the text size

It is possible to change the size of reflowable text. The default text size is 100; valid values are 5, 10, 25, 50, 75, 100, 125, 150, 200, 400, 800, and 1600. See the following code as an example:

Alternatively, you can zoom in/out to change the reflowable text size:

Assuming the current text size is 100%, by calling zoomReflow(reflowControl, true) and zoomReflow(reflowControl, false) the new text size will be 125% and 75% of the original size, respectively.

Set background color

There are three methods to change the background color:

setDayMode(): no background

setNightMode(): night background

setCustomColorMode(int): customized background

Set right-to-left direction

You can support right-to-left (RTL) languages by setting the direction of reflowable text by calling RightToLeftDirection

View mode dialog

This tutorial only applies to Xamarin.Android.

ViewModePickerDialogFragment allows users to: pick page layout mode, select page color mode, rotate pages, and crop pages.

Show view mode dialog

To show a view mode dialog in your activity, create a new instance of ViewModePickerDialogFragment by calling newInstance(PagePresentationMode, boolean, boolean, int):

C#

1public void ShowViewModeDialog()
2{
3    var viewModeDialog = pdftron.PDF.Dialog.ViewModePickerDialogFragment.NewInstance(mPdfViewCtrl.PagePresentationMode,
4      false, mReflowControl.Visibility == ViewStates.Visible, 0);
5    viewModeDialog.SetStyle((int)DialogFragmentStyle.Normal, Resource.Style.PDFTronAppTheme);
6    viewModeDialog.Show(this.SupportFragmentManager, "view_mode_picker");
7}

Set view mode dialog listener

In order to let users pick PDF page presentation mode, color mode, etc. you need to implement the corresponding events in the ViewModePickerDialogFragment instance.

C#

1viewModeDialog.CustomColorModeSelected += (sender, e) =>
2{
3    // save the selection so we can retrieve it next time
4    PdfViewCtrlSettingsManager.SetCustomColorModeBGColor(this, e.BgColor);
5    PdfViewCtrlSettingsManager.SetCustomColorModeTextColor(this, e.TxtColor);
6    PdfViewCtrlSettingsManager.SetColorMode(this, PdfViewCtrlSettingsManager.KeyPrefColorModeCustom);
7    // Do something with e.BgColor and e.TxtColor
8};
9
10viewModeDialog.ViewModeColorSelected += (sender, e) =>
11{
12    // save the selection so we can retrieve it next time
13    PdfViewCtrlSettingsManager.SetColorMode(this, e.ColorMode);
14    // Do something with e.ColorMode
15};
16
17viewModeDialog.ViewModeSelected += (sender, e) =>
18{
19    // Do something with e.ViewMode
20};

In ViewModeSelected, the selected view mode values are defined in PdfViewCtrlSettingsManager and include the following:

View Mode	Description	Value
`KEY_PREF_VIEWMODE_CONTINUOUS_VALUE`	Single page in continuous mode is selected.	"continuous"
`KEY_PREF_VIEWMODE_SINGLEPAGE_VALUE`	Single page presentation mode is selected.	"singlepage"
`KEY_PREF_VIEWMODE_FACING_VALUE`	Facing two pages presentation mode is selected.	"facing"
`KEY_PREF_VIEWMODE_FACINGCOVER_VALUE`	Facing two pages with odd page number on right side of PDF is selected.	"facingcover"
`KEY_PREF_VIEWMODE_FACING_CONT_VALUE`	In continuous mode, Facing two pages presentation mode is selected.	"facing_cont"
`KEY_PREF_VIEWMODE_FACINGCOVER_CONT_VALUE`	In continuous mode, Facing two pages with odd page number on right side of PDF is selected.	"facingcover_cont"
`KEY_PREF_VIEWMODE_ROTATION_VALUE`	Rotate pdf pages is selected.	"rotation"
`KEY_PREF_VIEWMODE_USERCROP_VALUE`	User-level crop pages is selected.	"user_crop"

To learn about setting page presentation mode, see PDFViewCtrl page presentation mode .

To learn about setting page color mode, see PDFViewCtrl color modes .

To learn about reflow, see reflow .

To learn about cropping pages, see crop page dialog .

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:

View mode (Android)

Page layout/presentation mode

Set the page presentation mode

C#

Page fit & default zoom mode in Android

Page view modes

Set the default page fit mode

Set the page fit mode dynamically

C#

Reflow document content in Android

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

Show reflow pager

Implementation

XML

C#

Scrolling direction

C#

Notify the reflow pager that the document has been modified

Set the text size

Set background color

Set right-to-left direction

View mode dialog

This tutorial only applies to Xamarin.Android.

Show view mode dialog

C#

Set view mode dialog listener

C#