PdfTextMarkupTool Class Members

In This Topic

The following tables list the members exposed by PdfTextMarkupTool.

Public Constructors

	Name	Description
	PdfTextMarkupTool	Initializes a new instance of the PdfTextMarkupTool class.

Public Properties

	Name	Description
	ActionButton	Gets or sets the mouse button, which executes the action of this tool.
	ActionCursor	Gets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from VisualTool)
	AllowNextItemSelection	Gets or sets a value indicating whether the tool allows to change focused item using the PerformNextItemSelection(Boolean) method.
	CanModifyImage	Gets a value indicating whether this visual tool can modify the image. (Inherited from VisualTool)
	CaretColor	Gets or sets the color of the Text Caret markup annotation.
	CaretScaleX	Gets or sets the scale factor of caret annotation at X axis.
	CaretScaleY	Gets or sets the scale factor of caret annotation at Y axis.
	Cursor	Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool)
	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.
	Enabled	Gets or sets a value indicating whether [TextMarkupTool] must markup selected text after text selection.
	HighlightColor	Gets or sets the color of the Highlight text markup annotation.
	ImageViewer	Gets the ImageViewer object associated with this tool. (Inherited from VisualTool)
	IsMultipageModeSupported	Gets a value indicating whether this tool supports multipage mode. (Inherited from VisualTool)
	IsVisibleWithoutImage	Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool)
	MarkupMode	Gets or sets the text markup mode that is used to markup text.
	Name	Gets the name of visual tool.
	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)
	SquigglyUnderlineColor	Gets or sets the color of the Squiggly Underline text markup annotation.
	StrikeoutColor	Gets or sets the color of the Strikeout text markup annotation.
	TextMarkupAppearanceGenerator	Gets or sets the appearance generator of text markup annotation.
	TextSelection	Gets the text selection tool associated with this tool.
	UnderlineColor	Gets or sets the color of the Underline text markup annotation.

Protected Properties

	Name	Description
	EnableViewerInvalidate	Gets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed. (Inherited from VisualTool)
	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)
	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)

Public Methods

	Name	Description
	CreateMarkupAnnotation	Creates the text markup annotation.
	FindVisualTool<T>	Finds the specified visual tool of specified type in visual tool. (Inherited from VisualTool)
	Markup	Overloaded. Markups all selected text using markup mode specified by property.
	PerformNextItemSelection	Selects the next available item and makes it as the active item. (Inherited from VisualTool)
	ToString	Returns the string representation of this object. (Inherited from VisualTool)

Protected Methods

	Name	Description
	Dispose	Overloaded. Releases all resources used by the object. (Inherited from VisualTool)
	InvalidateViewer	Overloaded. Invalidates the specified region of the , and causes a paint message to be sent to the . (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. (Inherited from VisualTool)
	OnActivated	Raises the Activated event.
	OnActivating	Raises the Activating event. (Inherited from VisualTool)
	OnDeactivated	Raises the Deactivated event.
	OnDeactivating	Raises the Deactivating event. (Inherited from VisualTool)
	OnEnabledChanged	Raises the EnabledChanged event. (Inherited from VisualTool)
	OnImageChanged	Raises the ImageChanged event. (Inherited from VisualTool)
	OnImageChanging	Raises the ImageChanging event. (Inherited from VisualTool)
	OnImageLoadingException	Raises the ImageLoadingException event. (Inherited from VisualTool)
	OnKeyDown	Raises the KeyDown event. (Inherited from VisualTool)
	OnKeyUp	Raises the KeyUp event. (Inherited from VisualTool)
	OnLostFocus	Occurs when visual tool loses the focus. (Inherited from VisualTool)
	OnMarkupAnnotationAdded	Raises the MarkupAnnotationAdded event.
	OnMarkupAnnotationCreated	Raises the MarkupAnnotationCreated event.
	OnMouseClick	Raises the MouseClick event. (Inherited from VisualTool)
	OnMouseDoubleClick	Raises the MouseDoubleClick event. (Inherited from VisualTool)
	OnMouseDown	Raises the MouseDown event. (Inherited from VisualTool)
	OnMouseEnter	Raises the MouseEnter event. (Inherited from VisualTool)
	OnMouseLeave	Raises the MouseLeave event. (Inherited from VisualTool)
	OnMouseMove	Raises the MouseMove event. (Inherited from VisualTool)
	OnMouseUp	Raises the MouseUp event. (Inherited from VisualTool)
	OnMouseWheel	Raises the MouseWheel event. (Inherited from VisualTool)
	OnPaint	Overloaded. Paints content of visual tool. (Inherited from VisualTool)
	OnPreviewKeyDown	Raises the PreviewKeyDown event. (Inherited from VisualTool)
	ProcessImeMessages	Processes the IME Windows messages. (Inherited from VisualTool)
	Reset	Resets this tool. (Inherited from VisualTool)

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)
	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)
	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)
	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)
	MarkupAnnotationAdded	Occurs when markup annotation is added.
	MarkupAnnotationCreated	Occurs when markup annotation is created.
	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)

Reference

PdfTextMarkupTool Class
Vintasoft.Imaging.Pdf.UI Namespace

Send Feedback