Product:

Get started

Samples

Basic operations

Learn More

Viewer

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

Disable annotation creation and editing

You can choose disable annotation creation and editing permissions

Disable annotation creation and editing in Xamarin.Android viewer

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

The long-press QuickMenu and AnnotationToolbar show a default set of annotation creation tools. Editing of existing annotations is enabled for all annotation types by default. Other actions that are not tied to annotation creation or editing, such as text selection, form filling, link following, and multimedia playing are enabled by default.

Disable annotation creation

To hide annotation creation tool(s) from the quick menu and annotation toolbar, you can set it in a centralized place with eitherToolManagerBuilder or ToolManager depending on the fit.

See annotation and tool mode mapping here: annotation and its creation tool.

The following example hides text highlight and arrow annotation creation tool from the quick menu and annotation toolbar:

To use in ToolManagerBuilder:

1ToolManagerBuilder.From().DisableToolMode(new ToolManager.ToolMode[] {
2    ToolManager.ToolMode.ArrowCreate,
3    ToolManager.ToolMode.TextHighlight
4});

1ToolManagerBuilder.from().disableToolMode(new ToolMode[]{
2    ToolManager.ToolMode.ARROW_CREATE,
3    ToolManager.ToolMode.TEXT_HIGHLIGHT}
4)

1ToolManagerBuilder.from().disableToolMode(arrayOf(
2    ToolManager.ToolMode.ARROW_CREATE,
3    ToolManager.ToolMode.TEXT_HIGHLIGHT
4))

To use in ToolManager:

1mToolManager.DisableToolMode(new ToolManager.ToolMode[] {
2    ToolManager.ToolMode.ArrowCreate,
3    ToolManager.ToolMode.TextHighlight
4});

1mToolManager.disableToolMode(new ToolMode[]{
2    ToolManager.ToolMode.ARROW_CREATE,
3    ToolManager.ToolMode.TEXT_HIGHLIGHT}
4);

1mToolManager.disableToolMode(arrayOf(
2    ToolManager.ToolMode.ARROW_CREATE,
3    ToolManager.ToolMode.TEXT_HIGHLIGHT
4))

Disable annotation editing

To disable annotation editing for certain annotation type(s), you can set it in a centralized place with either ToolManagerBuilder or ToolManager depending on the fit.

The following example disables editing of ellipse and rectangle annotations:

To use in ToolManagerBuilder:

1ToolManagerBuilder.From().DisableAnnotEditing(new Java.Lang.Integer[]
2{
3    new Java.Lang.Integer((int)Annot.Type.e_Circle),
4    new Java.Lang.Integer((int)Annot.Type.e_Square)
5});

1ToolManagerBuilder.from().disableAnnotEditing(new Integer[]{
2    Annot.e_Circle,
3    Annot.e_Square}
4);

1ToolManagerBuilder.from().disableAnnotEditing(arrayOf(Annot.e_Circle, Annot.e_Square))

To use in ToolManager:

1mToolManager.DisableAnnotEditing(new Java.Lang.Integer[]
2{
3    new Java.Lang.Integer((int)Annot.Type.e_Circle),
4    new Java.Lang.Integer((int)Annot.Type.e_Square)
5});

1mToolManager.disableAnnotEditing(new Integer[]{
2    Annot.e_Circle,
3    Annot.e_Square}
4);

1mToolManager.disableAnnotEditing(arrayOf(Annot.e_Circle, Annot.e_Square))

Disable functionality

Functionality that is not directly tied to annotation creation or editing such as text selection, form filling, link following etc. can also be disabled. Each functionality is in the form of a Tool. Once a Tool is disabled, ToolManager will never switch to it. Instead, it will switch to the Pan tool. Pan tool cannot be disabled.

The following example disables form filling and link following:

To use in ToolManagerBuilder:

1ToolManagerBuilder.From().DisableToolMode(new ToolManager.ToolMode[] {
2    ToolManager.ToolMode.LinkAction,
3    ToolManager.ToolMode.FormFill
4});

1ToolManagerBuilder.from().disableToolMode(new ToolMode[]{
2    ToolManager.ToolMode.LINK_ACTION,
3    ToolManager.ToolMode.FORM_FILL}
4)

1ToolManagerBuilder.from().disableToolMode(arrayOf(
2    ToolManager.ToolMode.LINK_ACTION,
3    ToolManager.ToolMode.FORM_FILL
4))

To use in ToolManager:

1mToolManager.DisableToolMode(new ToolManager.ToolMode[] {
2    ToolManager.ToolMode.LinkAction,
3    ToolManager.ToolMode.FormFill
4});

1mToolManager.disableToolMode(new ToolMode[]{
2    ToolManager.ToolMode.LINK_ACTION,
3    ToolManager.ToolMode.FORM_FILL}
4);

1mToolManager.disableToolMode(arrayOf(
2    ToolManager.ToolMode.LINK_ACTION,
3    ToolManager.ToolMode.FORM_FILL
4))

See annotation and tool mode mapping here: annotation and its creation tool.

Disable annotation creation and editing in Xamarin.iOS viewer

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

The long-press popup menu and AnnotationToolbar show a default set of annotation creation tools. Editing of existing annotations is enabled for all annotation types by default. Other actions that are not tied to annotation creation, like text selection, form filling, and link following, are enabled by default.

Disable annotation tools

Annotation creation and editing can be disabled on the PTToolManager using the PTAnnotationOptions property for a particular annotation type, such as TextAnnotationOptions

1// Disable text highlight annotation creation and editing.
2mToolManager.HighlightAnnotationPermission.CanCreate = false;
3mToolManager.HighlightAnnotationPermission.CanEdit = false;

1// Disable text highlight annotation creation and editing.
2self.toolManager.highlightAnnotationOptions.canCreate = false
3self.toolManager.highlightAnnotationOptions.canEdit = false

1// Disable text highlight annotation creation and editing.
2self.toolManager.highlightAnnotationOptions.canCreate = NO;
3self.toolManager.highlightAnnotationOptions.canEdit = NO;

It is also possible to disable annotation creation and editing based on the PTExtendedAnnotType enum by accessing the PTAnnotationOptions for that type using the AnnotationOptionsForAnnotType method.

1// Disable text highlight annotation creation and editing.
2mToolManager.AnnotationPermissionForAnnotType(pdftron.PDF.PTExtendedAnnotType.Highlight).CanCreate = false;
3mToolManager.AnnotationPermissionForAnnotType(pdftron.PDF.PTExtendedAnnotType.Highlight).CanEdit = false;

1// Disable text highlight annotation creation and editing.
2toolManager.annotationOptions(for: .highlight)?.canCreate = false
3toolManager.annotationOptions(for: .highlight)?.canEdit = false

1// Disable text highlight annotation creation and editing.
2[self.toolManager annotationOptionsForAnnotType:PTExtendedAnnotTypeHighlight].canCreate = NO;
3[self.toolManager annotationOptionsForAnnotType:PTExtendedAnnotTypeHighlight].canEdit = NO;

The PTExtendedAnnotType enum extends the basic PTAnnotType to further distinguish annotations based on their properties (line and arrow, polygon and cloudy, etc.). The extendedAnnotType property can be used to get the type of a Annot.

Disable functionality

Functionality that is not directly tied to annotations,like text selection, form filling, link following, and ink erasing, can be disabled on the PTToolManager via convenience properties, for example LinkFollowingEnabled:

1// Disable link following.
2mToolManager.LinkFollowingEnabled = false;

1// Disable link following.
2self.toolManager.isLinkFollowingEnabled = false

1// Disable link following.
2self.toolManager.linkFollowingEnabled = NO;

The code above disables link following for link annotations and text links detected by the PDFViewCtrl (the SetUrlExtraction method must be called on the PDFViewCtrl to enable text link detection).

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales