Some test text!

Default style propertieskeyboard_arrow_down

Customize default annotation tool style in Android


When creating a new annotation, the initial properties (such as line thickness, fill color, opacity, etc.) are set to the last value that the user selected for an annotation of that type. For example, if the user changes an ellipse annotation's stroke color from green to red, the next ellipse annotation that the user creates would have a stroke color of red. These default properties are saved in the app's SharedPreferences.

These default properties can be changed programmatically and will take effect the next time when the annotation is created.

For example, to change style properties of a rectangle:

RectCreate tool = (RectCreate) toolManager.createTool(ToolManager.ToolMode.RECT_CREATE, null);
    ToolStyleConfig.getInstance().getCustomOpacity(pdfViewCtrl.getContext(), Annot.e_Square, ""),
    ToolStyleConfig.getInstance().getCustomThickness(pdfViewCtrl.getContext(), Annot.e_Square, ""),

where toolManager is an instance of ToolManager.

A table for annotation type and tool mode mapping can be found here: annotation and its creation tool.

linkXML attributes

Each annotation has a default style that is defined by its creation tool. For example, when you create a Square annotation using the RectCreate tool for the first time, the default behavior to draw a rectangle with a red border and a transparent fill color. These default colors can changed through XML attributes.

However the effect will only take place when the app is first loaded.

linkSet a tool's default style

  1. Add a style to your styles.xml file. For details on supported style attributes, see Tool Style Attributes.

    <style name="ShapeProperty">
        <!-- border color -->
        <item name="annot_color">@android:color/white</item>
        <!-- fill color -->
        <item name="annot_fill_color">@android:color/white</item>
        <!-- thickness -->
        <item name="annot_thickness">1.0</item>
        <!-- opacity -->
        <item name="annot_opacity">1.0</item>
  2. Add the style resource to ToolStyleConfig by calling addDefaultStyleMap(int, int styleRes).

    The first parameter of addDefaultStyleMap is an annotation type. You can determine the annotation type from the creator tool by referring to the Table of annotations and its creation tool.
    // Add the to RectCreate tool.
    // Since the RectCreate tool creates a Square annotation, the annotation type of a Square
    // annotation is Annot.e_Square

linkOverride an existing tool's default style

You can also override existing tool's default styles:

  1. Identify the tool whose style you want to override by consulting the following table.
ToolStyle attribute resourceDefault style resource
  1. Create a custom tool style that inherits from the default tool style resource in styles.xml. For example, if you want to override the FreehandCreate tool style, your custom tool style should inherit from AnnotPresetStyle4.

    <style name="CustomizedToolStyle" parent="AnnotPresetStyle4">
        <item name="annot_color">@android:color/white</item>
    To learn about style inheritance, see: Defining styles and inheritance.
  2. In your application theme, set your custom tool style (CustomizedToolStyle) to the tool style attribute that corresponds to the tool style you wish to override. For example, if you want to the override FreehandCreate tool style, set CustomizedToolStyle to the attribute freehand_default_style.

    <style name="AppTheme" parent="Theme.AppCompat.DayNight.NoActionBar">
        <item name"freehand_default_style">@style/CustomizedToolStyle</item>
    To learn about applying custom themes to your application, see: Applying a Theme to an Activity or Application.

linkTool style attributes


Annotation color. For annotations that have an annot_fill_color, it represents stroke color.

format: color


Annotation text color. Used for FreeTextFreeText annotations.

format: color


Annotation fill color. Used for annotations that have fill colors, including Square, Circle, and FreeTextFreeText.

format: color


Annotation font size. Used for FreeTextFreeText annotations.

format: float


Represents a FreeTextFreeText annotation's maximum font size.

format: float


Represents a FreeTextFreeText annotation's minimum font size.

format: float


Annotation thickness for border style

format: float


Annotation maximum thickness

format: float


Annotation minimum thickness

format: float


Annotation font. Used for FreeTextFreeText annotations.

format: string


Annotation opacity

format: float


Annotation icon. Used for TextText annotations.

format: string

Get the answers you need: Support


Free Trial

Get unlimited trial usage of PDFTron SDK to bring accurate, reliable, and fast document processing capabilities to any application or workflow.

Select a platform to get started with your free trial.

Unlimited usage. No email address required.