VintaSoft Imaging .NET SDK v8.6
Vintasoft.Imaging.Pdf.UI.Annotations Namespace / PdfAnnotationTool Class
Properties Methods Events


In This Topic
    PdfAnnotationTool Class Members
    In This Topic

    The following tables list the members exposed by PdfAnnotationTool.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets the mouse button, which executes the action of this tool. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public PropertyGets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public PropertyGets or sets the action executor that is used for executing the PDF actions.  
    Public PropertyGets an active interaction controller. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Public PropertyGets or sets a value indicating whether the tool allows multiple selection in Edit interaction mode.  
    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 Vintasoft.Imaging.UI.VisualTools.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 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 Vintasoft.Imaging.UI.VisualTools.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 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 Vintasoft.Imaging.UI.VisualTools.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 Vintasoft.Imaging.UI.VisualTools.VisualTool can respond to the user interaction. (Inherited from Vintasoft.Imaging.UI.VisualTools.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 Vintasoft.Imaging.UI.VisualTools.VisualTool.ImageViewer object associated with this tool. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public PropertyGets or sets the interaction mode.  
    Public PropertyGets or sets the interactive form editor manager.  
    Public PropertyOverridden. Gets a value indicating whether this tool supports multipage mode.  
    Public PropertyGets or sets a value which determines that 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 Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public PropertyGets the JavaScript API Application object ("app").  
    Public PropertyOverridden. Gets 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 Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public PropertyGets or sets a key code that changes the selected item to the previous item. (Inherited from Vintasoft.Imaging.UI.VisualTools.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.  
    Top
    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 Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected PropertyGets or sets a value indicating whether user can set the focused interactive object. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected PropertyGets or sets a value indicating whether viewer must be invalidated when Vintasoft.Imaging.UI.VisualTools.VisualTool.InvalidateViewer method is executed. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected PropertyGets a value indicating whether the caller must call an invoke method when making method calls to the Vintasoft.Imaging.UI.VisualTools.VisualTool because the caller is on a different thread than the one the Vintasoft.Imaging.UI.VisualTools.VisualTool was created on. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected PropertyGet a collection of Vintasoft.Imaging.UI.VisualTools.UserInteraction.IInteractiveObject. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected PropertyGets the count of mouse clicks in series of clicks. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected PropertyGets or sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Top
    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 Vintasoft.Imaging.UI.VisualTools.UserInteraction.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. Overridden. Releases all resources used by the PdfAnnotationTool object.  
    Public MethodFinds an annotation view at specified point, in the image viewer space.  
    Public MethodOverloaded. Finishes an interaction with annotation.  
    Public MethodReturns the annotation view associated with the specified annotation.  
    Public MethodReturns an array of annotation views associated with the specified field.  
    Public MethodOverloaded. Returns a field associated with the specified widget 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 Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Public MethodOverloaded. Invalidates the PDF interactive form field tree.  
    Public MethodInvalidates a drawing box of specified interactive object. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Public MethodPerforms formatting of all fields located on current page.  
    Public MethodOverridden. Selects the next available item and makes it as the active item.  
    Public MethodOverloaded. Performs the selection.  
    Public MethodReloads the annotations of current page.  
    Public MethodScrolls the viewer to the focused item. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Public MethodReturns the string representation of this object. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public MethodTranslates the location of the specified annotations.  
    Top
    Protected Methods
     NameDescription
    Protected MethodDetermines that PDF annotation intersects with the selection rectangle.  
    Protected MethodOverridden. Begins an active interaction.  
    Protected MethodOverridden. Determines whether can change focused item when uses mouse.  
    Protected MethodReturns a value indicating whether the point is located on unfocused image. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.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 MethodOverridden. Draws 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 Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected MethodOverridden. Finds an interactive object at the specified point on image viewer.  
    Protected MethodGets the annotation selection box.  
    Protected MethodReturns the tab order of annotation collection.  
    Protected MethodReturns the visibility of specified annotation.  
    Protected MethodOverridden. Returns the item drawing box.  
    Protected MethodReturns a point transformation of specified interactive object. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected MethodOverloaded. Invalidates the entire surface of the Vintasoft.Imaging.UI.VisualTools.VisualTool.ImageViewer and causes the Vintasoft.Imaging.UI.VisualTools.VisualTool.ImageViewer to be redrawn. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodOverloaded. Executes the specified delegate on the thread that owns the Vintasoft.Imaging.UI.VisualTools.VisualTool's underlying Vintasoft.Imaging.UI.VisualTools.VisualTool.ImageViewer. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodOverridden. Returns a value indicating whether the visual tool will process the mouse event.  
    Protected MethodOverridden. Raises the Activated event.  
    Protected MethodRaises the ActiveInteractionControllerChanged event. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected MethodCalled when the widget annotation loses the input focus ("Blur" trigger).  
    Protected MethodCalled when mouse button down on annotation view.  
    Protected MethodCalled when mouse button up on annotation view.  
    Protected MethodCalled when mouse enters on annotation view.  
    Protected MethodCalled when mouse exits from annotation view.  
    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 BuildingFinishaed event.  
    Protected MethodRaises the BuildingStarted event.  
    Protected MethodOverridden. Raises the Deactivated event.  
    Protected MethodRaises the FocusedAnnotationViewChanged event.  
    Protected MethodRaises the FocusedAnnotationViewChanging event.  
    Protected MethodRaises the FocusedFieldChanged event.  
    Protected MethodOverridden. Raises the FocusedItemChanged event.  
    Protected MethodOverridden. Raises the FocusedItemChanging event.  
    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 Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodRaises the ImageChanging event. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodRaises the ImageLoadingException event. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodRaises the interaction event for specified interactive object. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected MethodRaises the InteractionModeChanged event.  
    Protected MethodOverridden. Called when the item collection is changed.  
    Protected MethodOverridden. Occurs when state of interactive object is changed.  
    Protected MethodCalled when JavaScript API event occurs.  
    Protected MethodOverridden. Raises the KeyDown event.  
    Protected MethodRaises the KeyUp event. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected MethodOccurs when visual tool loses the focus. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected MethodRaises the MouseClick event. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodRaises the MouseDoubleClick event. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodOverridden. Raises the MouseDown event.  
    Protected MethodRaises the MouseEnter event. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodRaises the MouseLeave event. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodOverridden. Raises the MouseMove event.  
    Protected MethodOverridden. Raises the MouseUp event.  
    Protected MethodRaises the MouseWheel event. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodCalled when PDF page closed.  
    Protected MethodCalled when PDF page opened.  
    Protected MethodOverloaded. Overridden. Raises the Paint event.  
    Protected MethodOverridden. Raises the PreviewKeyDown event.  
    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 Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Protected MethodResets this tool. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Protected MethodOverridden. Scrolls the viewer to the specified item.  
    Protected MethodSets the hovered annotation view.  
    Protected MethodSets the transformer of specified annotation view.  
    Protected MethodTries to finish the current interaction. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    Top
    Public Events
     NameDescription
    Public EventOccurs when the visual tool is activated in the image viewer. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool.ActiveInteractionController property is changed. (Inherited from Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool)
    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 Vintasoft.Imaging.UI.VisualTools.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 Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the image is changing. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the image is not loaded because of error. (Inherited from Vintasoft.Imaging.UI.VisualTools.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 Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when a key is released while the image viewer has focus and this tool is enabled. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is clicked. (Inherited from Vintasoft.Imaging.UI.VisualTools.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 Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the mouse enters an area of visual tool. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the mouse leaves an area of visual tool. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the mouse pointer is moved over the image viewer and this tool is enabled. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is released. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs when the mouse wheel moves while the image viewer has focus and this tool is enabled. (Inherited from Vintasoft.Imaging.UI.VisualTools.VisualTool)
    Public EventOccurs before the Vintasoft.Imaging.UI.VisualTools.VisualTool.KeyDown event when a key is pressed while focus is on this visual tool. (Inherited from Vintasoft.Imaging.UI.VisualTools.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.  
    Top
    See Also