VintaSoft Imaging .NET SDK 12.3: Documentation for .NET developer
Vintasoft.Imaging.Pdf.UI.Annotations Namespace / PdfAnnotationTool Class
Constructors Properties Methods Events SeeAlso
In This Topic
    PdfAnnotationTool Class Members
    In This Topic
    The following tables list the members exposed by PdfAnnotationTool.
    Public Constructors
     NameDescription
    Public ConstructorOverloaded. Initializes a new instance of the class.
    Public Properties
     NameDescription
    Public PropertyGets or sets the mouse button, which executes the action of this tool. (Inherited from VisualTool)
    Public PropertyGets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from VisualTool)
    Public PropertyGets or sets the action executor that is used for executing the PDF actions.
    Public PropertyGets an active interaction controller. (Inherited from UserInteractionVisualTool)
    Public PropertyGets or sets a value indicating whether the tool allows multiple selection in Edit interaction mode.
    Public PropertyGets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from VisualTool)
    Public PropertyGets the annotation collection.
    Public PropertyGets the annotation view collection.
    Public PropertyGets the UI action that moves the focused annotation view to the first position in view collection.
    Public PropertyGets the UI action that moves the focused annotation view to the last position in view collection.
    Public PropertyGets a value indicating whether this visual tool can modify the image. (Inherited from VisualTool)
    Public PropertyGets or sets a value indicating whether annotations can be moved between images in multipage display mode.
    Public PropertyGets a value indicating whether the tool can use the Edit interaction mode.
    Public PropertyGets or sets a value indicating whether focused item can be changed before interaction. (Inherited from UserInteractionVisualTool)
    Public PropertyGets or sets the clipboard of this tool.
    Public Propertystatic (Shared in Visual Basic)Gets the data format for annotations in clipboard.
    Public PropertyGets the UI action that copies the selected annotations to the clipboard.
    Public PropertyGets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool)
    Public PropertyGets the UI action that cuts the selected annotations to the clipboard.
    Public PropertyGets the UI action that deletes the selected annotations.
    Public PropertyGets the UI action that deselects all annotations.
    Public PropertyGets 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)
    Public PropertyGets the document set that is loaded in image viewer.
    Public PropertyGets or sets a value indicating whether the tool must highlight the fields in Edit interaction mode.
    Public PropertyGets or sets a brush, which must be used for filling the annotation bounding box in Edit interaction mode.
    Public PropertyGets or sets a pen, which must be used for drawing the annotation bounding box in Edit interaction mode.
    Public PropertyGets or sets the hover cursor in edit mode.
    Public PropertyGets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool)
    Public PropertyGets or sets a value indicating whether the tool must highlight the fields.
    Public PropertyGets or sets the brush that is used for showing field names in image viewer.
    Public PropertyGets or sets the fore color that is used for showing field names in image viewer.
    Public PropertyGets or sets the font that is used for showing field names in image viewer.
    Public PropertyGets or sets the focused annotation view.
    Public PropertyGets or sets the focused interactive form field.
    Public PropertyGets or sets the focused interactive form.
    Public PropertyGets the focused JavaScript API PDF document ("Doc").
    Public PropertyGets the focused PDF page.
    Public PropertyGets the hovered annotation.
    Public PropertyGets the hovered annotation view.
    Public PropertyGets the ImageViewer object associated with this tool. (Inherited from VisualTool)
    Public PropertyGets or sets the interaction mode.
    Public PropertyGets or sets the interactive form editor manager.
    Public PropertyGets or sets a value indicating whether interaction should be finished when focus is lost. (Inherited from UserInteractionVisualTool)
    Public PropertyGets a value indicating whether focused annotation is building.
    Public PropertyGets a value indicating whether this tool supports multipage mode.
    Public PropertyGets or sets a value indicating whether navigation is looped on focused page.
    Public PropertyGets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool)
    Public PropertyGets the JavaScript API Application object ("app").
    Public PropertyGets the name of visual tool.
    Public PropertyGets or sets a brush, which must be used for filling the highlight for optional fields.
    Public PropertyGets or sets a pen, which must be used for drawing the highlight for optional fields.
    Public PropertyGets the UI action that pastes the selected annotations from the clipboard.
    Public PropertyGets or sets the rectangular selection tool.
    Public PropertyGets or sets a brush, which must be used for filling the highlight for required fields.
    Public PropertyGets or sets a pen, which must be used for drawing the highlight for required fields.
    Public PropertyGets the UI action that selects all annotations.
    Public PropertyGets the collection of selected annotations.
    Public PropertyGets or sets a brush, which must be used for filling the fields selection.
    Public PropertyGets or sets a pen, which must be used for drawing the fields selection.
    Public PropertyGets or sets a key code that changes the selected item to the next item. (Inherited from VisualTool)
    Public PropertyGets or sets a key code that changes the selected item to the previous item. (Inherited from VisualTool)
    Public PropertyGets or sets a value indicating whether the tool must show field names in image viewer.
    Public PropertyGets or sets a value indicating whether visual tool shows and interacts with annotation appearances of VintaSoft Annotation .NET Plugin.
    Public PropertyGets 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
     NameDescription
    Protected PropertyGets or sets a value indicating whether the interaction can be started right after the interactive object is selected. (Inherited from UserInteractionVisualTool)
    Protected PropertyGets or sets a value indicating whether user can set the focused interactive object. (Inherited from UserInteractionVisualTool)
    Protected PropertyGets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed. (Inherited from VisualTool)
    Protected PropertyGets or sets a focused item. (Inherited from UserInteractionVisualTool)
    Protected PropertyGets 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)
    Protected PropertyGets a collection of IInteractiveObject. (Inherited from UserInteractionVisualTool)
    Protected PropertyGets the count of mouse clicks in series of clicks. (Inherited from VisualTool)
    Protected PropertyGets or sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from VisualTool)
    Protected PropertyGets a value indicating whether interaction controller should use ActionButton of visual tool. (Inherited from UserInteractionVisualTool)
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds and builds the annotation.
    Public MethodOverloaded. Adds and builds the form field.
    Public MethodOverloaded. Adds and the annotation to focused page.
    Public MethodOverloaded. Adds the form field.
    Public MethodCancels an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
    Public MethodCancels the building process and removes the annotation view from AnnotationViewCollection collection.
    Public MethodDetermines that the tool can interact with the specified annotation view.
    Public MethodCreates a PDF annotation view for the specified PDF annotation.
    Public MethodOverloaded. Releases all resources used by the object. (Inherited from VisualTool)
    Public MethodOverloaded. Finds an annotation view at specified point, in the image viewer space.
    Public Methodstatic (Shared in Visual Basic)Finds the specified visual tool of specified type in visual tool. (Inherited from VisualTool)
    Public MethodFinishes an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
    Public MethodOverloaded. Finishes an interaction with annotation.
    Public Methodstatic (Shared in Visual Basic)Overloaded. Returns the active interaction controller of specified visual tool. (Inherited from UserInteractionVisualTool)
    Public MethodReturns the annotation view associated with the specified annotation.
    Public MethodReturns an array of annotation views associated with the specified field.
    Public MethodReturns the visibility of specified annotation.
    Public MethodOverloaded. Returns a field associated with the specified PDF annotation view.
    Public MethodReturns a JS field object associated with the specified PDF interactive form field.
    Public MethodReturns the selected annotation views.
    Public MethodReturns the supported UI actions.
    Public MethodInvalidates the PDF annotation.
    Public MethodInvalidates the PDF annotations.
    Public MethodInvalidates a drawing box of focused interactive object. (Inherited from UserInteractionVisualTool)
    Public MethodOverloaded. Invalidates the PDF interactive form field tree.
    Public MethodInvalidates a drawing box of specified interactive object. (Inherited from UserInteractionVisualTool)
    Public MethodPerforms formatting of all fields located on current page.
    Public MethodSelects the next available item and makes it as the active item.
    Public MethodOverloaded. Performs the selection of the item.
    Public MethodRaises the document trigger event.
    Public MethodRaises the trigger event.
    Public Methodstatic (Shared in Visual Basic)Registers the annotastion view.
    Public MethodReloads the annotations of current page.
    Public MethodScrolls the viewer to the focused item. (Inherited from UserInteractionVisualTool)
    Public MethodReturns the string representation of this object. (Inherited from VisualTool)
    Public MethodTranslates the location of the specified annotations.
    Protected Methods
     NameDescription
    Protected MethodReturns a value indicating whether PDF annotation intersects with the selection rectangle.
    Protected MethodBegins an active interaction.
    Protected MethodReturns a value indicating whether tool can change focused item when mouse is used.
    Protected MethodReturns a value indicating whether next item can be selected. (Inherited from UserInteractionVisualTool)
    Protected MethodReturns a value indicating whether the point is located on unfocused image. (Inherited from UserInteractionVisualTool)
    Protected MethodDraws a selection of annotation view on specified graphics.
    Protected MethodDraws annotation highlight in editor mode.
    Protected MethodDraws the field highlight.
    Protected MethodDraws the field name.
    Protected MethodDraws an interactive object on specified graphics.
    Protected MethodDraws an interactive object background.
    Protected MethodDraws an interactive object foreground.
    Protected MethodExecutes the UI action that occurs in JsApp object.
    Protected MethodFinds the interaction area at the specified location, in viewer space. (Inherited from UserInteractionVisualTool)
    Protected MethodFinds an interactive object at the specified point on image viewer.
    Protected MethodReturns the annotation selection box.
    Protected MethodReturns the tab order of annotation collection.
    Protected MethodReturns the item drawing box.
    Protected MethodReturns a point transformation of specified interactive object. (Inherited from UserInteractionVisualTool)
    Protected MethodOverloaded. Invalidates the entire surface of the and causes the to be redrawn. (Inherited from VisualTool)
    Protected MethodOverloaded. Executes the specified delegate, on the thread that owns the 's underlying , with the specified list of arguments. (Inherited from VisualTool)
    Protected MethodDetermines whether the ActionButton contains the button. (Inherited from VisualTool)
    Protected MethodReturns a value indicating whether the visual tool will process the mouse event.
    Protected MethodRaises the Activated event.
    Protected MethodRaises the Activating event. (Inherited from VisualTool)
    Protected MethodRaises the ActiveInteractionControllerChanged event. (Inherited from UserInteractionVisualTool)
    Protected MethodCalled when the widget annotation loses the input focus ("Blur" trigger).
    Protected MethodRaises the AnnotationMouseButtonDown event.
    Protected MethodRaises the AnnotationMouseButtonUp event.
    Protected MethodRaises the AnnotationMouseEnter event.
    Protected MethodRaises the AnnotationMouseExit event.
    Protected MethodCalled when the widget annotation receives the input focus ("Focus" trigger).
    Protected MethodOccurs when annotations editing is finished.
    Protected MethodRaises the AnnotationViewCollectionChanged event.
    Protected MethodRaises the BuildingCanceled event.
    Protected MethodRaises the BuildingFinished event.
    Protected MethodRaises the BuildingStarted event.
    Protected MethodRaises the Deactivated event.
    Protected MethodRaises the Deactivating event. (Inherited from VisualTool)
    Protected MethodRaises the EnabledChanged event. (Inherited from VisualTool)
    Protected MethodRaises the FocusedAnnotationViewChanged event.
    Protected MethodRaises the FocusedAnnotationViewChanging event.
    Protected MethodRaises the FocusedFieldChanged event.
    Protected MethodOccurs when focused item is changed.
    Protected MethodOccurs when focused item is changing.
    Protected MethodRaises the HoveredAnnotationChanged event.
    Protected MethodRaises the HoveredAnnotationChanging event.
    Protected MethodRaises the HoveredAnnotationViewChanged event.
    Protected MethodRaises the HoveredAnnotationViewChanging event.
    Protected MethodRaises the ImageChanged event. (Inherited from VisualTool)
    Protected MethodRaises the ImageChanging event. (Inherited from VisualTool)
    Protected MethodRaises the ImageLoadingException event. (Inherited from VisualTool)
    Protected MethodRaises the interaction event for specified interactive object. (Inherited from UserInteractionVisualTool)
    Protected MethodRaises the InteractionModeChanged event.
    Protected MethodCalled when the item collection is changed.
    Protected MethodOccurs when state of interactive object is changed.
    Protected MethodCalled when JavaScript API event occurs.
    Protected MethodRaises the PreviewKeyDown event.
    Protected MethodRaises the KeyUp event. (Inherited from UserInteractionVisualTool)
    Protected MethodOccurs when visual tool loses the focus. (Inherited from UserInteractionVisualTool)
    Protected MethodRaises the MouseClick event. (Inherited from VisualTool)
    Protected MethodRaises the MouseDoubleClick event. (Inherited from VisualTool)
    Protected MethodRaises the MouseDown event.
    Protected MethodRaises the MouseEnter event. (Inherited from VisualTool)
    Protected MethodRaises the MouseLeave event. (Inherited from VisualTool)
    Protected MethodRaises the MouseMove event.
    Protected MethodRaises the MouseUp event.
    Protected MethodRaises the MouseWheel event. (Inherited from VisualTool)
    Protected MethodCalled when PDF page closed.
    Protected MethodCalled when PDF page opened.
    Protected MethodOverloaded. Paints content of visual tool on specified image.
    Protected MethodRaises the PreviewKeyDown event. (Inherited from VisualTool)
    Protected MethodRaises the SelectedAnnotationViewCollectionChanged event.
    Protected MethodRaises the TransformingFinished event.
    Protected MethodRaises the TransformingStarted event.
    Protected MethodCalled when trigger event occurs.
    Protected MethodTransforms a point from the viewer space to the interactive object space. (Inherited from UserInteractionVisualTool)
    Protected MethodProcesses the IME Windows messages. (Inherited from UserInteractionVisualTool)
    Protected MethodResets this tool. (Inherited from VisualTool)
    Protected MethodScrolls the viewer to the specified item.
    Protected MethodSets the hovered annotation view.
    Protected MethodSets properties to the specified interaction controller.
    Protected MethodSets the transformer of specified annotation view.
    Protected MethodTries to finish the current interaction. (Inherited from UserInteractionVisualTool)
    Public Events
     NameDescription
    Public EventOccurs when the visual tool is activated in the image viewer. (Inherited from VisualTool)
    Public EventOccurs when the visual tool is activating in the image viewer. (Inherited from VisualTool)
    Public EventOccurs when the ActiveInteractionController property is changed. (Inherited from UserInteractionVisualTool)
    Public EventOccurs when mouse button down on annotation view.
    Public EventOccurs when mouse button up on annotation view.
    Public EventOccurs when mouse enters on annotation view.
    Public EventOccurs when mouse exits from annotation view.
    Public EventOccurs when annotation view collection is changed.
    Public EventOccurs when annotation building canceled.
    Public EventOccurs when annotation building finished.
    Public EventOccurs when annotation building started.
    Public EventOccurs when the visual tool is deactivated in the image viewer. (Inherited from VisualTool)
    Public EventOccurs when the visual tool is deactivating in the image viewer. (Inherited from VisualTool)
    Public EventOccurs when value of Enabled property is changed. (Inherited from VisualTool)
    Public EventOccurs when the FocusedAnnotationView is changed.
    Public EventOccurs when the FocusedAnnotationView is changing.
    Public EventOccurs when focused field is changed.
    Public EventOccurs when the HoveredAnnotation is changed.
    Public EventOccurs when the HoveredAnnotation is changing.
    Public EventOccurs when the HoveredAnnotationView is changed.
    Public EventOccurs when the HoveredAnnotationView is changing.
    Public EventOccurs when the image is changed. (Inherited from VisualTool)
    Public EventOccurs when the image is changing. (Inherited from VisualTool)
    Public EventOccurs when the image is not loaded because of error. (Inherited from VisualTool)
    Public EventOccurs when interaction mode is changed.
    Public EventOccurs when a key is pressed while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
    Public EventOccurs when a key is released while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
    Public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is clicked. (Inherited from VisualTool)
    Public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked. (Inherited from VisualTool)
    Public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed. (Inherited from VisualTool)
    Public EventOccurs when the mouse enters an area of visual tool. (Inherited from VisualTool)
    Public EventOccurs when the mouse leaves an area of visual tool. (Inherited from VisualTool)
    Public EventOccurs when the mouse pointer is moved over the image viewer and this tool is enabled. (Inherited from VisualTool)
    Public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is released. (Inherited from VisualTool)
    Public EventOccurs when the mouse wheel moves while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
    Public EventOccurs before the KeyDown event when a key is pressed while focus is on this visual tool. (Inherited from VisualTool)
    Public EventOccurs when selected annotation view collection is changed.
    Public EventOccurs when the annotation transforming is finished.
    Public EventOccurs when the annotation transforming is started.
    See Also