Enum AnnotationsWillChangeReason

Indicates the reason why OnAnnotationsWillChange was emitted.

Namespace: PSPDFKit.UI
Assembly: PSPDFKit.dll
Syntax
public enum AnnotationsWillChangeReason

Fields

Name Description
DeleteEnd

The user ends the delete process. This will be emitted when the user confirms or cancels the intention to delete an annotation. An empty annotations list indicates that the deletion was cancelled.

DeleteStart

The user initiates the delete process. This will be emitted when the deletion confirmation dialog appears.

DrawEnd

The user stops drawing an annotation.

DrawStart

The user starts drawing an annotation.

MoveEnd

The user stops moving an annotation around.

MoveStart

The user starts moving an annotation around.

PropertyChange

The value of one of the properties of the annotation is changed by the user. e.g. the color or the stroke width.

ResizeEnd

The user stops resizing an annotation.

ResizeStart

The user starts resizing an annotation.

SelectEnd

The user stops choosing an item from the picker presented. Used for image annotations, stamp annotations and ink signature annotations. An empty list indicates that the selection was cancelled. This will not be fired when cancelling the system dialog for selecting an image.

SelectStart

The user starts choosing an item from the picker presented. Used for image annotations, stamp annotations and ink signature annotations.

Note that the annotation included in this event will not have any matching field values (including ID) compared to the annotation in a SelectEnd event. This is because the actual annotation hasn't been created yet. As a result, this annotation is used only to identify the type of annotation being selected. The only exception to this is the IsSignature field in a Ink annotation, which is set to true to distinguish it from a regular ink annotation.

TextEditEnd

The user stops typing text into an annotation.

TextEditStart

The user starts typing text into an annotation.