PdfAnnotationTool Class Members

In This Topic

The following tables list the members exposed by PdfAnnotationTool.

Public Constructors

	Name	Description
	PdfAnnotationTool	Overloaded. Initializes a new instance of the class.

Public Properties

	Name	Description
	ActionButton	Gets or sets the mouse button, which executes the action of this tool. (Inherited from UserInteractionVisualTool)
	ActionCursor	Gets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from VisualTool)
	ActionExecutor	Gets or sets the action executor that is used for executing the PDF actions.
	ActiveInteractionController	Gets an active interaction controller. (Inherited from UserInteractionVisualTool)
	AllowMultipleSelection	Gets or sets a value indicating whether the tool allows multiple selection in Edit interaction mode.
	AllowNextItemSelection	Gets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from VisualTool)
	AnnotationCollection	Gets the annotation collection.
	AnnotationViewCollection	Gets the annotation view collection.
	BringToBackAction	Gets the UI action that moves the focused annotation view to the first position in view collection.
	BringToFrontAction	Gets the UI action that moves the focused annotation view to the last position in view collection.
	CanModifyImage	Gets a value indicating whether this visual tool can modify the image. (Inherited from VisualTool)
	CanMoveAnnotationsBetweenImages	Gets or sets a value indicating whether annotations can be moved between images in multipage display mode.
	CanUseEditMode	Gets a value indicating whether the tool can use the Edit interaction mode.
	ChangeFocusedItemBeforeInteraction	Gets or sets a value indicating whether focused item can be changed before interaction. (Inherited from UserInteractionVisualTool)
	Clipboard	Gets or sets the clipboard of this tool.
	ClipboardAnnotationDataFormat	Gets the data format for annotations in clipboard.
	CopyAction	Gets the UI action that copies the selected annotations to the clipboard.
	Cursor	Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool)
	CutAction	Gets the UI action that cuts the selected annotations to the clipboard.
	DeleteAction	Gets the UI action that deletes the selected annotations.
	DeselectAllAction	Gets the UI action that deselects all annotations.
	DisableContextMenu	Gets or sets a value indicating whether image viewer must disable context menu in image viewer if the right mouse button is set as an action button of the visual tool. (Inherited from VisualTool)
	DocumentSet	Gets the document set that is loaded in image viewer.
	EditorModeHighlight	Gets or sets a value indicating whether the tool must highlight the fields in Edit interaction mode.
	EditorModeHighlightBrush	Gets or sets a brush, which must be used for filling the annotation bounding box in Edit interaction mode.
	EditorModeHighlightPen	Gets or sets a pen, which must be used for drawing the annotation bounding box in Edit interaction mode.
	EditorModeHoverCursor	Gets or sets the hover cursor in edit mode.
	Enabled	Gets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool)
	FieldHighlight	Gets or sets a value indicating whether the tool must highlight the fields.
	FieldNameBackgroundBrush	Gets or sets the brush that is used for showing field names in image viewer.
	FieldNameColor	Gets or sets the fore color that is used for showing field names in image viewer.
	FieldNameFont	Gets or sets the font that is used for showing field names in image viewer.
	FocusedAnnotationView	Gets or sets the focused annotation view.
	FocusedField	Gets or sets the focused interactive form field.
	FocusedInteractiveForm	Gets or sets the focused interactive form.
	FocusedJsDoc	Gets the focused JavaScript API PDF document ("Doc").
	FocusedPage	Gets the focused PDF page.
	HoveredAnnotation	Gets the hovered annotation.
	HoveredAnnotationView	Gets the hovered annotation view.
	ImageViewer	Gets the ImageViewer object associated with this tool. (Inherited from VisualTool)
	InteractionMode	Gets or sets the interaction mode.
	InteractiveFormEditorManager	Gets or sets the interactive form editor manager.
	IsFinishInteractionOnLostFocus	Gets or sets a value indicating whether interaction should be finished when focus is lost. (Inherited from UserInteractionVisualTool)
	IsFocusedAnnotationBuilding	Gets a value indicating whether focused annotation is building.
	IsMultipageModeSupported	Gets a value indicating whether this tool supports multipage mode.
	IsNavigationLoopedOnFocusedPage	Gets or sets a value indicating whether navigation is looped on focused page.
	IsVisibleWithoutImage	Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool)
	JsApp	Gets the JavaScript API Application object ("app").
	Name	Gets the name of visual tool.
	OptionalFieldsHighlightBrush	Gets or sets a brush, which must be used for filling the highlight for optional fields.
	OptionalFieldsHighlightPen	Gets or sets a pen, which must be used for drawing the highlight for optional fields.
	PasteAction	Gets the UI action that pastes the selected annotations from the clipboard.
	RectangularSelection	Gets or sets the rectangular selection tool.
	RequiredFieldsHighlightBrush	Gets or sets a brush, which must be used for filling the highlight for required fields.
	RequiredFieldsHighlightPen	Gets or sets a pen, which must be used for drawing the highlight for required fields.
	SelectAllAction	Gets the UI action that selects all annotations.
	SelectedAnnotationViewCollection	Gets the collection of selected annotations.
	SelectionBrush	Gets or sets a brush, which must be used for filling the fields selection.
	SelectionPen	Gets or sets a pen, which must be used for drawing the fields selection.
	SelectNextItemKeyCode	Gets or sets a key code that changes the selected item to the next item. (Inherited from VisualTool)
	SelectPrevItemKeyCode	Gets or sets a key code that changes the selected item to the previous item. (Inherited from VisualTool)
	ShowFieldNames	Gets or sets a value indicating whether the tool must show field names in image viewer.
	ShowVintasoftAnnotationAppearances	Gets or sets a value indicating whether visual tool shows and interacts with annotation appearances of VintaSoft Annotation .NET Plugin.
	SpellChecker	Gets or sets the spell check manager that is used for spell checking of text in PDF text annotations and PDF interactive form fields.

Protected Properties

	Name	Description
	CanBeginInteractionAfterSetFocusedItem	Gets or sets a value indicating whether the interaction can be started right after the interactive object is selected. (Inherited from UserInteractionVisualTool)
	CanUserSetFocusedItem	Gets or sets a value indicating whether user can set the focused interactive object. (Inherited from UserInteractionVisualTool)
	EnableViewerInvalidate	Gets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed. (Inherited from VisualTool)
	FocusedItem	Gets or sets a focused item. (Inherited from UserInteractionVisualTool)
	InvokeRequired	Gets a value indicating whether the caller must call an invoke method when making method calls to the VisualTool because the caller is on a different thread than the one the VisualTool was created on. (Inherited from VisualTool)
	Items	Gets a collection of IInteractiveObject. (Inherited from UserInteractionVisualTool)
	MouseClickCount	Gets the count of mouse clicks in series of clicks. (Inherited from VisualTool)
	MouseClicksDelta	Gets or sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from VisualTool)
	UseActionButtonToInteractionController	Gets a value indicating whether interaction controller should use ActionButton of visual tool. (Inherited from UserInteractionVisualTool)

Public Methods

	Name	Description
	AddAndBuildAnnotation	Overloaded. Adds and builds the annotation.
	AddAndBuildFormField	Overloaded. Adds and builds the form field.
	AddAnnotation	Overloaded. Adds and the annotation to focused page.
	AddFormField	Overloaded. Adds the form field.
	CancelActiveInteraction	Cancels an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
	CancelBuilding	Cancels the building process and removes the annotation view from AnnotationViewCollection collection.
	CanInteractWith	Determines that the tool can interact with the specified annotation view.
	CreateAnnotationView	Creates a PDF annotation view for the specified PDF annotation.
	Dispose	Overloaded. Releases all resources used by the object. (Inherited from VisualTool)
	FindAnnotationView	Overloaded. Finds an annotation view at specified point, in the image viewer space.
	FindVisualTool<T>	Finds the specified visual tool of specified type in visual tool. (Inherited from VisualTool)
	FinishActiveInteraction	Finishes an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
	FinishInteraction	Overloaded. Finishes an interaction with annotation.
	GetActiveInteractionController	Overloaded. Returns the active interaction controller of specified visual tool. (Inherited from UserInteractionVisualTool)
	GetAnnotationViewAssociatedWith	Returns the annotation view associated with the specified annotation.
	GetAnnotationViewsAssociatedWith	Returns an array of annotation views associated with the specified field.
	GetAnnotationVisibility	Returns the visibility of specified annotation.
	GetFieldAssociatedWith	Overloaded. Returns a field associated with the specified PDF annotation view.
	GetJsFieldAssociatedWith	Returns a JS field object associated with the specified PDF interactive form field.
	GetSelectedAnnotationViews	Returns the selected annotation views.
	GetSupportedUIActions	Returns the supported UI actions.
	InvalidateAnnotation	Invalidates the PDF annotation.
	InvalidateAnnotations	Invalidates the PDF annotations.
	InvalidateFocusedItem	Invalidates a drawing box of focused interactive object. (Inherited from UserInteractionVisualTool)
	InvalidateInteractiveFormFieldTree	Overloaded. Invalidates the PDF interactive form field tree.
	InvalidateItem	Invalidates a drawing box of specified interactive object. (Inherited from UserInteractionVisualTool)
	PerformFieldsFormatting	Performs formatting of all fields located on current page.
	PerformNextItemSelection	Selects the next available item and makes it as the active item.
	PerformSelection	Overloaded. Performs the selection of the item.
	RaiseDocumentTriggerEvent	Raises the document trigger event.
	RaiseTriggerEvent	Raises the trigger event.
	RegisterAnnotationView	Registers the annotastion view.
	ReloadAnnotations	Reloads the annotations of current page.
	ScrollToFocusedItem	Scrolls the viewer to the focused item. (Inherited from UserInteractionVisualTool)
	ToString	Returns the string representation of this object. (Inherited from VisualTool)
	TranslateAnnotations	Translates the location of the specified annotations.

Protected Methods

	Name	Description
	AnnotationViewIntersectsWithSelectionRect	Returns a value indicating whether PDF annotation intersects with the selection rectangle.
	BeginInteraction	Begins an active interaction.
	CanChangeFocusedItem	Returns a value indicating whether tool can change focused item when mouse is used.
	CanSelectNextItem	Returns a value indicating whether next item can be selected. (Inherited from UserInteractionVisualTool)
	CheckIsPointOnUnfocusedImage	Returns a value indicating whether the point is located on unfocused image. (Inherited from UserInteractionVisualTool)
	DrawAnnotationSelection	Draws a selection of annotation view on specified graphics.
	DrawEditorModeHighlight	Draws annotation highlight in editor mode.
	DrawFieldHighlight	Draws the field highlight.
	DrawFieldName	Draws the field name.
	DrawItem	Draws an interactive object on specified graphics.
	DrawItemBackground	Draws an interactive object background.
	DrawItemForeground	Draws an interactive object foreground.
	ExecuteUIAction	Executes the UI action that occurs in JsApp object.
	FindInteractionArea	Finds the interaction area at the specified location, in viewer space. (Inherited from UserInteractionVisualTool)
	FindInteractiveObject	Finds an interactive object at the specified point on image viewer.
	GetAnnotationSelectionBox	Returns the annotation selection box.
	GetAnnotationsTabOrder	Returns the tab order of annotation collection.
	GetItemDrawingBox	Returns the item drawing box.
	GetPointsTransform	Returns a point transformation of specified interactive object. (Inherited from UserInteractionVisualTool)
	InvalidateViewer	Overloaded. Invalidates the entire surface of the and causes the to be redrawn. (Inherited from VisualTool)
	Invoke	Overloaded. Executes the specified delegate, on the thread that owns the 's underlying , with the specified list of arguments. (Inherited from VisualTool)
	IsActionButtonContains	Determines whether the ActionButton contains the button. (Inherited from VisualTool)
	NeedProcessMouseEvent	Returns a value indicating whether the visual tool will process the mouse event.
	OnActivated	Raises the Activated event.
	OnActivating	Raises the Activating event. (Inherited from VisualTool)
	OnActiveInteractionControllerChanged	Raises the ActiveInteractionControllerChanged event. (Inherited from UserInteractionVisualTool)
	OnAnnotationLostInputFocus	Called when the widget annotation loses the input focus ("Blur" trigger).
	OnAnnotationMouseButtonDown	Raises the AnnotationMouseButtonDown event.
	OnAnnotationMouseButtonUp	Raises the AnnotationMouseButtonUp event.
	OnAnnotationMouseEnter	Raises the AnnotationMouseEnter event.
	OnAnnotationMouseExit	Raises the AnnotationMouseExit event.
	OnAnnotationReceiveInputFocus	Called when the widget annotation receives the input focus ("Focus" trigger).
	OnAnnotationsEditingFinished	Occurs when annotations editing is finished.
	OnAnnotationViewCollectionChanged	Raises the AnnotationViewCollectionChanged event.
	OnBuildingCanceled	Raises the BuildingCanceled event.
	OnBuildingFinished	Raises the BuildingFinished event.
	OnBuildingStarted	Raises the BuildingStarted event.
	OnDeactivated	Raises the Deactivated event.
	OnDeactivating	Raises the Deactivating event. (Inherited from VisualTool)
	OnEnabledChanged	Raises the EnabledChanged event. (Inherited from VisualTool)
	OnFocusedAnnotationViewChanged	Raises the FocusedAnnotationViewChanged event.
	OnFocusedAnnotationViewChanging	Raises the FocusedAnnotationViewChanging event.
	OnFocusedFieldChanged	Raises the FocusedFieldChanged event.
	OnFocusedItemChanged	Occurs when focused item is changed.
	OnFocusedItemChanging	Occurs when focused item is changing.
	OnHoveredAnnotationChanged	Raises the HoveredAnnotationChanged event.
	OnHoveredAnnotationChanging	Raises the HoveredAnnotationChanging event.
	OnHoveredAnnotationViewChanged	Raises the HoveredAnnotationViewChanged event.
	OnHoveredAnnotationViewChanging	Raises the HoveredAnnotationViewChanging event.
	OnImageChanged	Raises the ImageChanged event. (Inherited from VisualTool)
	OnImageChanging	Raises the ImageChanging event. (Inherited from VisualTool)
	OnImageLoadingException	Raises the ImageLoadingException event. (Inherited from VisualTool)
	OnInteraction	Raises the interaction event for specified interactive object. (Inherited from UserInteractionVisualTool)
	OnInteractionModeChanged	Raises the InteractionModeChanged event.
	OnItemCollectionChanged	Called when the item collection is changed.
	OnItemStateChanged	Occurs when state of interactive object is changed.
	OnJavaScriptApiEvent	Called when JavaScript API event occurs.
	OnKeyDown	Raises the PreviewKeyDown event.
	OnKeyUp	Raises the KeyUp event. (Inherited from UserInteractionVisualTool)
	OnLostFocus	Occurs when visual tool loses the focus. (Inherited from UserInteractionVisualTool)
	OnMouseClick	Raises the MouseClick event. (Inherited from VisualTool)
	OnMouseDoubleClick	Raises the MouseDoubleClick event. (Inherited from VisualTool)
	OnMouseDown	Raises the MouseDown event.
	OnMouseEnter	Raises the MouseEnter event. (Inherited from VisualTool)
	OnMouseLeave	Raises the MouseLeave event. (Inherited from VisualTool)
	OnMouseMove	Raises the MouseMove event.
	OnMouseUp	Raises the MouseUp event.
	OnMouseWheel	Raises the MouseWheel event. (Inherited from VisualTool)
	OnPageClose	Called when PDF page closed.
	OnPageOpen	Called when PDF page opened.
	OnPaint	Overloaded. Paints content of visual tool on specified image.
	OnPreviewKeyDown	Raises the PreviewKeyDown event. (Inherited from VisualTool)
	OnSelectedAnnotationViewCollectionChanged	Raises the SelectedAnnotationViewCollectionChanged event.
	OnTransformingFinished	Raises the TransformingFinished event.
	OnTransformingStarted	Raises the TransformingStarted event.
	OnTriggerEvent	Called when trigger event occurs.
	PointToInteractiveObject	Transforms a point from the viewer space to the interactive object space. (Inherited from UserInteractionVisualTool)
	ProcessImeMessages	Processes the IME Windows messages. (Inherited from UserInteractionVisualTool)
	Reset	Resets this tool. (Inherited from VisualTool)
	ScrollToItem	Scrolls the viewer to the specified item.
	SetHoveredAnnotationView	Sets the hovered annotation view.
	SetInteractionControllerProperties	Sets properties to the specified interaction controller.
	SetTransformer	Sets the transformer of specified annotation view.
	TryFinishInteraction	Tries to finish the current interaction. (Inherited from UserInteractionVisualTool)

Public Events

	Name	Description
	Activated	Occurs when the visual tool is activated in the image viewer. (Inherited from VisualTool)
	Activating	Occurs when the visual tool is activating in the image viewer. (Inherited from VisualTool)
	ActiveInteractionControllerChanged	Occurs when the ActiveInteractionController property is changed. (Inherited from UserInteractionVisualTool)
	AnnotationMouseButtonDown	Occurs when mouse button down on annotation view.
	AnnotationMouseButtonUp	Occurs when mouse button up on annotation view.
	AnnotationMouseEnter	Occurs when mouse enters on annotation view.
	AnnotationMouseExit	Occurs when mouse exits from annotation view.
	AnnotationViewCollectionChanged	Occurs when annotation view collection is changed.
	BuildingCanceled	Occurs when annotation building canceled.
	BuildingFinished	Occurs when annotation building finished.
	BuildingStarted	Occurs when annotation building started.
	Deactivated	Occurs when the visual tool is deactivated in the image viewer. (Inherited from VisualTool)
	Deactivating	Occurs when the visual tool is deactivating in the image viewer. (Inherited from VisualTool)
	EnabledChanged	Occurs when value of Enabled property is changed. (Inherited from VisualTool)
	FocusedAnnotationViewChanged	Occurs when the FocusedAnnotationView is changed.
	FocusedAnnotationViewChanging	Occurs when the FocusedAnnotationView is changing.
	FocusedFieldChanged	Occurs when focused field is changed.
	HoveredAnnotationChanged	Occurs when the HoveredAnnotation is changed.
	HoveredAnnotationChanging	Occurs when the HoveredAnnotation is changing.
	HoveredAnnotationViewChanged	Occurs when the HoveredAnnotationView is changed.
	HoveredAnnotationViewChanging	Occurs when the HoveredAnnotationView is changing.
	ImageChanged	Occurs when the image is changed. (Inherited from VisualTool)
	ImageChanging	Occurs when the image is changing. (Inherited from VisualTool)
	ImageLoadingException	Occurs when the image is not loaded because of error. (Inherited from VisualTool)
	InteractionModeChanged	Occurs when interaction mode is changed.
	KeyDown	Occurs when a key is pressed while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	KeyUp	Occurs when a key is released while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	MouseClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is clicked. (Inherited from VisualTool)
	MouseDoubleClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked. (Inherited from VisualTool)
	MouseDown	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed. (Inherited from VisualTool)
	MouseEnter	Occurs when the mouse enters an area of visual tool. (Inherited from VisualTool)
	MouseLeave	Occurs when the mouse leaves an area of visual tool. (Inherited from VisualTool)
	MouseMove	Occurs when the mouse pointer is moved over the image viewer and this tool is enabled. (Inherited from VisualTool)
	MouseUp	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is released. (Inherited from VisualTool)
	MouseWheel	Occurs when the mouse wheel moves while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	PreviewKeyDown	Occurs before the KeyDown event when a key is pressed while focus is on this visual tool. (Inherited from VisualTool)
	SelectedAnnotationViewCollectionChanged	Occurs when selected annotation view collection is changed.
	TransformingFinished	Occurs when the annotation transforming is finished.
	TransformingStarted	Occurs when the annotation transforming is started.

Reference

PdfAnnotationTool Class
Vintasoft.Imaging.Pdf.UI.Annotations Namespace

Send Feedback