Enum InteractionMode

Interaction modes in the viewer.

Namespace: PSPDFKit.Api.Enums
Assembly: Api.dll
Syntax
public enum InteractionMode

Fields

Name Description
ButtonWidget

When this mode is activated, the creation of button widget annotations is enabled.
Callout

When this mode is activated, the creation of new callout annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.
CheckboxWidget

When this mode is activated, the creation of checkbox widget annotations is enabled.
ComboboxWidget

When this mode is activated, the creation of combo box widget annotations is enabled.
CommentMarker

When this mode is activated, the creation of new comment marker annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.
ContentEditor

This enables content editor tools.
DateWidget

When this mode is activated, the creation of date widget annotations is enabled.
Distance

When this mode is activated, you'll be able to create distance annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.
DocumentCrop

When this mode is activated, the creation of cropping area selection is enabled.
DocumentEditor

Show document editor modal.
EllipseArea

When this mode is activated, you'll be able to create ellipse Area annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.
FormCreator

When this mode is activated, you'll be able to edit and create widget annotations.
Ink

When this mode is activated, the creation of new ink annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index change, a new annotation is created.
InkEraser

When this mode is activated, removing of current ink annotation points will be enabled. This transforms the page to a canvas where the cursor can remove ink annotation points by hand, as well as choose the cursor width.

When this mode is activated, you'll be able to create link annotations.
ListboxWidget

When this mode is activated, the creation of list box widget annotations is enabled.
MarqueeZoom

This enables the marquee zoom tool. When enabled, you can draw a rectangle on the screen, which is then zoomed into and scrolled to once the pointer is released.
Measurement

This enables measurement tools.
MeasurementSettings

This enables measurement settings.
MultiAnnotationSelection

This enables the multi-annotation selection tool.
Note

When this mode is activated, the creation of new note annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.
Pan

This enables the pan tool to allow the user to navigate on a desktop browser using mouse dragging. This will disable text selection. On a touch device, this will have no effect, since panning is already the default technique for scrolling on websites.
Perimeter

When this mode is activated, you'll be able to create perimeter annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.
PolygonArea

When this mode is activated, you'll be able to create polygon area annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.
RadioButtonWidget

When this mode is activated, the creation of radio button widget annotations is enabled.
RectangleArea

When this mode is activated, you'll be able to create rectangle area annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.
RedactShapeRectangle

The creation of new rectangle annotations will be enabled. This transforms the page to a drawable canvas, and a redaction annotation is created while drawing on it.
RedactTextHighlighter

The creation of new highlight redaction annotations will be enabled and the text will be highlighted as it's selected.

Enables the search mode and focuses the search input field.
ShapeEllipse

When this mode is activated, the creation of new ellipse annotations will be enabled. This transforms the page to a drawable canvas, and an annotation is created while drawing on it. If properties (e.g. color) or the page index change, a new annotation is created.
ShapeLine

When this mode is activated, the creation of new line annotations will be enabled. This transforms the page to a drawable canvas, and an annotation is created while drawing on it. If properties (e.g. color) or the page index change, a new annotation is created.
ShapePolygon

When this mode is activated, the creation of new polygon annotations will be enabled. This transforms the page to a drawable canvas, and an annotation is created while drawing on it. If properties (e.g. color) or the page index change, a new annotation is created.
ShapePolyline

When this mode is activated, the creation of new polyline annotations will be enabled. This transforms the page to a drawable canvas, and an annotation is created while drawing on it. If properties (e.g. color) or the page index change, a new annotation is created.
ShapeRectangle

When this mode is activated, the creation of new rectangle annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.
Signature

When this mode is activated, the creation of new ink signatures will be enabled. This shows a dialog where it's possible to select an existing ink signature or create a new one and store it.
SignatureWidget

When this mode is activated, the creation of signature widget annotations is enabled.
StampCustom

When this mode is activated, the custom stamp annotation template editor modal UI will be shown. Once the custom template is edited, the new custom stamp annotation will be created in the document.
StampPicker

When this mode is activated, the stamp annotation templates picker modal UI will be shown. Once a template is selected, the new annotation is configured and created in the document.
Text

When this mode is activated, the creation of new text annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.
TextHighlighter

When this mode is activated, the creation of new highlight annotations will be enabled and the text will be highlighted as it's selected.
TextWidget

When this mode is activated, the creation of text widget annotations is enabled.