Some test text!

Xamarin

FAQ

API

Samples

Changelog

Guides

Xamarin / Guides / Customize quick menu (Android)

Customize Quick Menu

You can use a customize the uick menu with a custom list of tools.

Android

Customize quick menu in Xamarin

This tutorial only applies to Xamarin.Android.

It is possible to customize the quick menu by overriding the default menu resource XML files, or by creating your own.

Add/remove item to the quick menu

It is possible to programatically modify the quick menu by calling methods to add and remove items.

The following example will customize the quick menu for the Square tool by using the ShowQuickMenu event and adding a link button. Menu entries can be moved around and removed as well.

Add a menu entry to the ids.xml in Resources/values to identify it:

<resources>
    ...

    <item name="qm_custom_link" type="id" />
    
    ...
</resources>

Create event handler for the ShowQuickMenu event, and add the code below to create a new QuickMenuItem and specify the order you would like for it to show:

```java //@data {"m":true}// if (annot.getType() == Annot.e_Square) { QuickMenuItem item = new QuickMenuItem(MainActivity.this, R.id.qm_custom_link, QuickMenuItem.FIRST_ROW_MENU); item.setTitle(R.string.qm_custom_link); item.setIcon(R.drawable.ic_link_black_24dp); item.setOrder(3); ArrayList items = new ArrayList<>(1); items.add(item); quickMenu.addMenuEntries(items); } ```

The quick menu for the square tool will now have a link item at the 3rd (0 index) position like this: quick menu image

Quickmenu items can be removed by calling the removeMenuEntries method in the QuickMenu class:

mPdfViewCtrlTabHostFragment.CurrentPdfViewCtrlFragment.ShowQuickMenu += (sender, e) =>
{
    if (e.Annot != null && e.Annot.Type == (int) Annot.Type.e_Square)
    {
        QuickMenuItem item = new QuickMenuItem(this, Resource.Id.qm_custom_link,
            QuickMenuItem.FirstRowMenu);
        List<QuickMenuItem> items = new List<QuickMenuItem>(1);
        items.Add(item);
        e.Quickmenu.RemoveMenuEntries(items);
    }
    e.Handled = false;
};

Override menu resources

In this tutorial you will customize the quick menu for the Pan tool by overriding the default menu resource XML file in the Apryse SDK.

Create a menu resource XML file called pan.xml in your project's Resources/menu folder. This pan.xml file will automatically be used instead of the default one in the tools package. To override other quick menus, refer to the table below to determine the name of the menu resource file.
Add two items to you menu in pan.xml with the id attributes @+id/qm_free_text and @+id/qm_floating_sig:
```
<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:id="@+id/qm_free_text"
        android:title="@string/tools_qm_free_text"
        android:icon="@drawable/ic_annotation_freetext_black_24dp" />
    <item android:id="@+id/qm_floating_sig"
        android:title="@string/tools_qm_signature" 
        android:icon="@drawable/ic_annotation_signature_black_24dp" />
</menu>
```
Here we use the ids @+id/qm_free_text and @+id/qm_floating_sig to override the Free Text and Signature menu items.
You can also create your own menu items by providing a unique id, or by overriding our other menu items using the menu ids defined in the tools package. You can learn more about handling custom menu item click events here.
Now, when you long-press on a blank space, you will see:

Quick menu resources

Menu resource	Tool	Triggered event
`pan`	Pan	Long press on blank space
`text_select`	TextSelect	Long press on text
`annot_simple_shape`	AnnotEdit	Single tap on Square, Circle, Line, Polygon, Polyline, Text
`annot_free_text`	AnnotEdit	Single tap on FreeText
`annot_link`	AnnotEdit	Single tap on Link
`annot_signature`	AnnotEdit	Single tap on signature (type: Annot.e_Stamp and custom field: Signature.SIGNATURE_ANNOTATION_ID)
`annot_stamper`	AnnotEdit	Single tap on Stamp
`annot_file_attachment`	AnnotEdit	Single tap on FileAttachment
`annot_free_hand`	AnnotEdit	Single tap on Ink
`annot_general`	AnnotEdit	Single tap on all other annotation types
`annot_edit_text_markup`	AnnotEditTextMarkup	Single tap on TextMarkup annotations
`type`	AnnotEditTextMarkup	Click quick menu item with id `Resource.Id.type`
`sig_field_image`	DigitalSignature	Single tap on digital image signature
`annot_edit_thickness`	DigitalSignature	Click quick menu item with id `Resource.Id.thickness`
`sig_field_paths`	DigitalSignature	Single tap on digital signature, or click on items in quick menu `Resource.Menu.annot_edit_thickness`

Create your own quick menu

You can use quick menus in a ToolManager as well as in your application logic directly. By the end of this tutorial, you will be able to create your own quick menu.

First, add a menu resource XML file in your project's Resources/menu folder. For example, let's create a file called custom.xml.

By default, all menu items are placed in the first row of the quick menu. If you want to specify the location of a menu item, enclose the item inside a group with a group id from this list:

Group id	Location in quick menu
`@id/qm_first_row_group`	First row group id: all menu items inside this group will be displayed in the first row of the quick menu.
`@id/qm_second_row_group`	Second row group id: all menu items inside this group will be displayed in the second row of the quick menu.
`@id/qm_overflow_row_group`	Overflow list group id: all menu items inside this group will be displayed in the overflow menu list of the quick menu.

Add the following to custom.xml:

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android">
    <group android:id="@id/qm_first_row_group">
        <item android:id="@+id/rectangle"
            android:title="@string/tools_qm_rectangle"
            android:icon="@drawable/ic_annotation_square_black_24dp" />
    </group>
    <group android:id="@id/qm_second_row_group">
        <item android:id="@+id/line"
            android:title="@string/annot_line"
            android:icon="@drawable/ic_annotation_line_black_24dp"/>
        <item android:id="@+id/free_text"
            android:title="@string/tools_qm_free_text"
            android:icon="@drawable/ic_annotation_freetext_black_24dp"/>
    </group>
    <group android:id="@id/qm_overflow_row_group">
        <item android:id="@+id/floating_sig"
            android:title="@string/tools_qm_signature"/>
        <item android:id="@+id/link"
            android:title="@string/annot_link"/>
    </group>
</menu>

You can also add a sub menu by specifiying it in the menu resource XML. For example, we can add an Oval menu item as a submenu under the Rectangle menu item by changing custom.xml to:

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android">
    <group android:id="@id/qm_first_row_group">
        <item android:id="@+id/rectangle"
            android:title="@string/tools_qm_rectangle"
            android:icon="@drawable/ic_annotation_square_black_24dp" >
            <!-- Sub menu added to Rectangle menu item -->
            <menu>
                <group android:id="@id/qm_first_row_group">
                    <item android:id="@+id/oval"
                        android:title="@string/annot_circle"/>
                </group>
            </menu>
        </item>
    </group>
    <group android:id="@id/qm_second_row_group">
        <item android:id="@+id/line"
            android:title="@string/annot_line"
            android:icon="@drawable/ic_annotation_line_black_24dp"/>
        <item android:id="@+id/free_text"
            android:title="@string/annot_free_text"
            android:icon="@drawable/ic_annotation_freetext_black_24dp"/>
    </group>
    <group android:id="@id/qm_overflow_row_group">
        <item android:id="@+id/floating_sig"
            android:title="@string/tools_qm_signature"/>
        <item android:id="@+id/link"
            android:title="@string/annot_link"/>
    </group>
</menu>

For more information on defining an XML menu resource, see Defining a Menu in XML.

After adding the menu resource XML, initialize QuickMenu as follows:

void InitQuickMenu(PDFViewCtrl pdfViewCtrl)
{
    var quickMenu = new QuickMenu(pdfViewCtrl);
    quickMenu.InitMenuEntries(Resource.menu.custom);
}

Alternatively, if you want to customize menu items manually you can call [`QuickMenu.Inflate`](/api/xamarinandroid/tools/api/pdftron.PDF.Tools.QuickMenu.html#pdftron_PDF_Tools_QuickMenu_Inflate_System_Int32_) to prevent auto-initialization. Then after customizing the items, call [`QuickMenu.initMenuEntries`](/api/xamarinandroid/tools/api/pdftron.PDF.Tools.QuickMenu.html#pdftron_PDF_Tools_QuickMenu_InitMenuEntries) to apply your changes: ```java //@data {"m":true}// private void initQuickMenu(PDFViewCtrl pdfViewCtrl) { QuickMenu quickMenu = new QuickMenu(pdfViewCtrl); quickMenu.inflate(R.menu.custom); QuickMenuItem quickMenuItem = (QuickMenuItem) quickMenu.getMenu().findItem(R.id.rectangle); // Customize my quick menu item quickMenuItem.setIcon(R.drawable.my_custom_icon); quickMenuItem.setTitle(R.string.my_custom_title); // Initialize quick menu quickMenu.initMenuEntries(); } ```

When you want to show the quick menu, set an anchor view that defines where the quick menu should appear by calling QuickMenu.SetAnchor(View), then call :

```java //@data {"m":true}// private void showQuickMenu(QuickMenu quickMenu, View view) { quickMenu.setAnchor(view); quickMenu.show(); } ```

### Click events Click events from your custom items will **not** be automatically handled by the Apryse SDK if the menu item id does not match any of the default ids defined in the tools package (located in the `PDFViewCtrlTools\res\menu\ids.xml` file). You will have to handle these events as described [in this guide](/xamarin/guides/ui-customization/quick-menu/android/) or by implementing [`DismissEvent`](/api/xamarinandroid/tools/api/pdftron.PDF.Tools.QuickMenu.html#pdftron_PDF_Tools_QuickMenu_DismissEvent): ```java //@data {"m":true}// quickMenu.setOnDismissListener(new QuickMenu.OnDismissListener() { @Override public void onDismiss() { // Get selected quick menu item QuickMenuItem selectedMenuItem = quickMenu.getSelectedMenuItem(); // Provide functionality depending on the menu item selected // ... } }); ```

quickMenu.DismissEvent += (sender, e) =>
{
    // Get selected quick menu item
    var selectedMenuItem = quickMenu.SelectedMenuItem;
    // Provide functionality depending on the menu item selected
    // ...
}

Trial setup questions? Ask experts on Discord
Need other help? Contact Support
Pricing or product questions? Contact Sales

Did you find this guide helpful?

Yes