OfficeDocumentVisualEditorTextTool Class Members

In This Topic

The following tables list the members exposed by OfficeDocumentVisualEditorTextTool.

Public Constructors

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

Public Properties

	Name	Description
	ActionButton	Gets or sets the mouse button, which executes the action of this tool. (Inherited from VisualTool)
	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 changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from VisualTool)
	CanModifyImage	Gets a value indicating whether this visual tool can modify the image. (Inherited from VisualTool)
	Clipboard	Gets or sets the clipboard of this tool. (Inherited from TextSelectionTool)
	CopyAction	Gets the UI action that copies the selected text to the clipboard. (Inherited from TextSelectionTool)
	Cursor	Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool)
	DeselectAllAction	Gets the UI action that deselects all text. (Inherited from TextSelectionTool)
	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)
	Enabled	Gets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool)
	FocusedImageHasTextRegion	Gets a value indicating whether focused image has text region. (Inherited from TextSelectionTool)
	FocusedTextRegion	Gets the text region of focused image. (Inherited from TextSelectionTool)
	FocusedTextSymbol	Gets or sets the focused text region symbol. (Inherited from TextSelectionTool)
	HasSelectedText	Gets a value indicating whether text is selected on one or several pages in image viewer. (Inherited from TextSelectionTool)
	ImageViewer	Gets the ImageViewer object associated with this tool. (Inherited from VisualTool)
	IsInteractionBoundedUsingTextRectangle	Gets or sets a value indicating whether the visual tool bounds the interaction using text rectangle. (Inherited from TextSelectionTool)
	IsKeyboardSelectionEnabled	Gets or sets a value indicating whether the text selection using keyboard is enabled. (Inherited from TextSelectionTool)
	IsMouseSelectionEnabled	Gets or sets a value indicating whether the text selection using mouse is enabled. (Inherited from TextSelectionTool)
	IsMultipageModeSupported	Gets a value indicating whether this tool supports multipage mode. (Inherited from TextSelectionTool)
	IsSelectionEnabled	Gets a value indicating whether the text selection is enabled (using keyboard or mouse). (Inherited from TextSelectionTool)
	IsTextCaretBeforeSymbol	Gets or sets a value indicating whether text caret is located before symbol. (Inherited from TextSelectionTool)
	IsVisibleWithoutImage	Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool)
	Name	Gets the name of the visual tool.
	NavigationMode	Gets or sets the text navigation mode. (Inherited from TextSelectionTool)
	SelectAllAction	Gets the UI action that selects all text. (Inherited from TextSelectionTool)
	SelectedRegion	Gets or sets the selected text region on focused image. (Inherited from TextSelectionTool)
	SelectedText	Gets a text, which is selected on one or several pages in image viewer. (Inherited from TextSelectionTool)
	SelectionBrush	Gets or sets the System.Drawing.Brush for text selection. (Inherited from TextSelectionTool)
	SelectionMode	Gets or sets the current text selection mode. (Inherited from TextSelectionTool)
	SelectionSpaceFactor	Gets or sets the space factor of text selection. (Inherited from TextSelectionTool)
	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)
	TextCaretBlendingMode	Gets or sets the color blending mode that is used for drawing of text caret. (Inherited from TextSelectionTool)
	TextCaretBlinkingInterval	Gets or sets the blinking interval, in milliseconds, for text caret. (Inherited from TextSelectionTool)
	TextCaretColor	Gets or sets the color of text caret. (Inherited from TextSelectionTool)
	TextCaretWidth	Gets or sets the width, in pixels, of text caret. (Inherited from TextSelectionTool)
	TextFormatter	Gets or sets the formatter that is used for formatting the text content of text region. (Inherited from TextSelectionTool)
	TextSelectionAutoScrollStep	Gets or sets the step value, in pixels, which should be used for auto scrolling in image viewer when text selection is performing in image viewer and mouse cursor is moving outside the image viewer. (Inherited from TextSelectionTool)

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)
	IsTextCaretBlendingWithVisualToolsContent	Gets or sets a value indicating whether the visual tool takes into account content of other visual tools when draw text caret with color blending. (Inherited from TextSelectionTool)
	IsTextRegionOverridden	Gets or sets a value indicating whether text region is overridden. (Inherited from TextSelectionTool)
	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
	ClearSelection	Clears current selection. (Inherited from TextSelectionTool)
	Dispose	Overloaded. Releases all resources used by the object. (Inherited from VisualTool)
	ExecuteTextAction	Executes the specified text action. (Inherited from TextSelectionTool)
	FindText	Overloaded. Searches the text, defined by , starting from the current page. (Inherited from TextSelectionTool)
	FindVisualTool<T>	Finds the specified visual tool of specified type in visual tool. (Inherited from VisualTool)
	GetSelectedRegion	Returns the selected region on page in image viewer. (Inherited from TextSelectionTool)
	GetSelectionImages	Returns an array of images, where text is selected. (Inherited from TextSelectionTool)
	GetSupportedUIActions	Returns the supported UI actions.
	GetTextCaretRegionInViewerSpace	Returns the text caret bounds in viewer space. (Inherited from TextSelectionTool)
	GetTextRegion	Returns the text region for specified image. (Inherited from TextSelectionTool)
	OverrideTextRegion	Overrides the text region for specified image. (Inherited from TextSelectionTool)
	PerformNextItemSelection	Selects the next available item and makes it as the active item. (Inherited from VisualTool)
	ScrollToFocusedTextSymbol	Scrolls the viewer to the focused text symbol. (Inherited from TextSelectionTool)
	ScrollToSelectedRegion	Scrolls the image viewer to selected region. (Inherited from TextSelectionTool)
	SelectAll	Overloaded. Selects all text on specified page in image viewer. (Inherited from TextSelectionTool)
	SelectInControlSpace	Selects text in specified rectangle on focused page in image viewer. (Inherited from TextSelectionTool)
	SelectInImageSpace	Selects text in specified rectangle on focused image in image viewer. Rectangle coordinates are specified in the coordinate space of page. (Inherited from TextSelectionTool)
	SelectText	Selects text between specified text symbols. (Inherited from TextSelectionTool)
	SetFocusedTextSymbol	Sets the focused text symbol. (Inherited from TextSelectionTool)
	SetSelectedRegion	Overloaded. Sets the selected region on specified page in image viewer. (Inherited from TextSelectionTool)
	SetTextCaretInImageSpace	Sets the text caret to a symbol at specified point, in image space. (Inherited from TextSelectionTool)
	SetTextCaretInTextSpace	Sets the text caret to a symbol at specified point, in text region space. (Inherited from TextSelectionTool)
	ToString	Returns the string representation of this object. (Inherited from VisualTool)

Protected Methods

	Name	Description
	DrawSelection	Draws the selection around the selected text. (Inherited from TextSelectionTool)
	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. (Inherited from VisualTool)
	OnActivated	Raises the Activated event. (Inherited from TextSelectionTool)
	OnActivating	Raises the Activating event. (Inherited from VisualTool)
	OnDeactivated	Raises the Deactivated event. (Inherited from VisualTool)
	OnDeactivating	Raises the Deactivating event. (Inherited from VisualTool)
	OnEnabledChanged	Raises the EnabledChanged event. (Inherited from VisualTool)
	OnFocusedTextSymbolChanged	Raises the FocusedTextSymbolChanged event. (Inherited from TextSelectionTool)
	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 TextSelectionTool)
	OnKeyUp	Raises the KeyUp event. (Inherited from VisualTool)
	OnLostFocus	Occurs when visual tool loses the focus. (Inherited from VisualTool)
	OnMouseClick	Raises the MouseClick event. (Inherited from VisualTool)
	OnMouseDoubleClick	Raises the MouseDoubleClick event. (Inherited from VisualTool)
	OnMouseDown	Raises the MouseDown event. (Inherited from TextSelectionTool)
	OnMouseEnter	Raises the MouseEnter event. (Inherited from VisualTool)
	OnMouseLeave	Raises the MouseLeave event. (Inherited from VisualTool)
	OnMouseMove	Raises the MouseMove event. (Inherited from TextSelectionTool)
	OnMouseUp	Raises the MouseUp event. (Inherited from TextSelectionTool)
	OnMouseWheel	Raises the MouseWheel event. (Inherited from VisualTool)
	OnPaint	Overloaded. Paints content of visual tool on specified image. (Inherited from TextSelectionTool)
	OnPreviewKeyDown	Raises the PreviewKeyDown event. (Inherited from VisualTool)
	OnSelectionChanged	Raises the SelectionChanged event. (Inherited from TextSelectionTool)
	OnSelectionModeChanged	Raises the SelectionModeChanged event. (Inherited from TextSelectionTool)
	OnTextExtractionProgress	Raises the TextExtractionProgress event. (Inherited from TextSelectionTool)
	OnTextFormatterChanged	Raises the TextFormatterChanged event. (Inherited from TextSelectionTool)
	OnTextSearchingProgress	Raises the TextSearchingProgress event. (Inherited from TextSelectionTool)
	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)
	FocusedTextSymbolChanged	Occurs when focused text symbol is changed. (Inherited from TextSelectionTool)
	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)
	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)
	SelectionChanged	Occurs when the SelectedRegion is changed. (Inherited from TextSelectionTool)
	SelectionModeChanged	Occurs when the selection mode is changed. (Inherited from TextSelectionTool)
	TextExtractionProgress	Occurs when the text extractiong progress is changed. (Inherited from TextSelectionTool)
	TextFormatterChanged	Occurs when the text formatter is changed. (Inherited from TextSelectionTool)
	TextSearched	Occurs when the text searching process is finished. (Inherited from TextSelectionTool)
	TextSearching	Occurs when the text searching process is started. (Inherited from TextSelectionTool)
	TextSearchingProgress	Occurs before the text searching process is processed a page. (Inherited from TextSelectionTool)

Reference

OfficeDocumentVisualEditorTextTool Class
Vintasoft.Imaging.Office.OpenXml.UI.VisualTools.UserInteraction Namespace

Send Feedback