OfficeDocumentVisualEditor Class Members

In This Topic

The following tables list the members exposed by OfficeDocumentVisualEditor.

Public Constructors

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

Public Properties

	Name	Description
	Actions	Gets the UI action factory of Office document visual editor.
	Clipboard	Gets the clipboard.
	ContentScale	Gets or sets the content scale of the document content.
	DisableBaseTransformerOnEdit	Gets or sets a value indicating whether editor must disable the base transfomer when ediding is enabled.
	FocusedInteractionArea	Gets a focused interaction area. (Inherited from InteractionControllerBase)
	FocusedTextRegion	Gets the focused text region.
	FocusedTextSymbol	Gets or sets the focused text symbol.
	HasAppearance	Gets a value indicating whether this interaction controller has appearance. (Inherited from InteractionControllerBase)
	HasCharts	Gets a value indicating whether this Office document has charts.
	HasDocument	Gets a value indicating whether editor has Office document.
	InteractionAreas	Gets a read-only collection of interaction areas. (Inherited from InteractionControllerBase)
	InteractiveObject	Gets an interactive object of interaction controller. (Inherited from InteractionControllerBase<T>)
	IsActivated	Gets a value indicating whether controller is activated. (Inherited from InteractionControllerBase)
	IsDocumentChanged	Gets a value indicating whether Office document is changed.
	IsEditingEnabled	Gets or sets a value indicating whether OfficeDocumentVisualEditor can edit DOCX document.
	IsEnabled	Gets or sets a value indicating whether interaction controller is enabled. (Inherited from InteractionControllerBase)
	IsInteracting	Gets a value indicating whether controller is interacting with the interactive object. (Inherited from InteractionControllerBase)
	IsVisible	Gets a value indicating whether controller is visible. (Inherited from InteractionControllerBase<T>)
	TextTool	Gets or sets the text selection tool that is used for editing content of DOCX document.

Protected Properties

	Name	Description
	InteractionAreaList	Gets a list of interaction areas. (Inherited from InteractionControllerBase)

Public Methods

	Name	Description
	CanCopyContent	Returns a value indicating whether content can be copied to the Clipboard.
	CanDeleteContent	Returns a value indicating whether content can be deleted.
	CanPasteContent	Returns a value indicating whether content can be pasted from Clipboard.
	CopyContent	Copies selected content to the Clipboard.
	CreateDocumentEditor	Creates the document editor.
	DeleteContent	Deletes selected content.
	DrawAppearance	Draws the interaction controller appearance on specifed graphics engine. (Inherited from InteractionControllerBase)
	EnableEditing	Enables the editing.
	GetFocusedTextContent	Overloaded. Returns the selected text content in specified that corresponds to the selected (or focused) text in visual editor.
	GetFontNames	Returns the font names, which are available in current document.
	GetParagraphProperties	Overloaded. Returns the paragraph properties of specified text symbol.
	GetSupportedUIActions	Returns supported UI actions.
	GetTextProperties	Overloaded. Returns the text properties of specified text symbol.
	OnActivate	Invoked when interaction controller is activated.
	OnDeactivate	Invoked when interaction controller is deactivated.
	OnDocumentChanged	Overloaded. Called when DOCX document is changed.
	OnInteraction	Invoked when user interacts with an interaction area of interactive object. (Inherited from InteractionControllerBase)
	PasteContent	Pastes the content from Clipboard.
	ReplaceSelectedText	Replaces selected text content to specified text.
	Reset	Resets the interaction controller. (Inherited from InteractionControllerBase)
	SetParagraphNumeration	Sets the numeration for focused paragraph(s).
	SetParagraphProperties	Sets the paragraph properties of selected text.
	SetTextProperties	Sets the text properties of selected text.
	UpdateDocumentSource	Updates the document source of Office document.
	UpdateInteractionAreas	Updates the interaction areas of this controller. (Inherited from InteractionControllerBase)

Protected Methods

	Name	Description
	GetCaretLeftTop	Returns the left-top position of text caret.
	GetFontFamilyName	Returns the font family name.
	GetFontSize	Returns the font size.
	OnEditingDisabled	Called when editing is disabled.
	OnEditingEnabled	Called when editing is enabled.
	OnEditingException	Raises the EditingException event. (Inherited from TextEditorControllerBase<T>)
	OnImeTextInput	Called when text is received from IME.
	OnInteractionFinished	Raises the InteractionFinished event. (Inherited from InteractionControllerBase)
	PerformInteraction	Performs an interaction between user and interaction area of interactive object.
	ProcessHotKeys	Processes the hot keys (Ctrl+C, Ctrl+V, ...).
	ProcessImeMessages	Processes the IME Windows messages. (Inherited from TextEditorControllerBase<T>)

Public Events

	Name	Description
	DocumentChanged	Occurs when document is changed.
	EditingDisabled	Occurs when editing is disabled. (Inherited from TextEditorControllerBase<T>)
	EditingEnabled	Occurs when editing is enabled. (Inherited from TextEditorControllerBase<T>)
	EditingException	Occurs when editing is not possible. (Inherited from TextEditorControllerBase<T>)
	Interaction	Occurs when user interacts with an interaction area of interactive object. (Inherited from InteractionControllerBase)
	InteractionFinished	Occurs when interaction is finished. (Inherited from InteractionControllerBase)

Reference

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

Send Feedback