InPlaceTextEditor Class

Definition

Namespace:

Microsoft.VisualStudio.Modeling.Diagrams

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll

Package:

Microsoft.VisualStudio.Modeling.Sdk.Diagrams v17.10.40171

public ref class InPlaceTextEditor sealed : IDisposable

public sealed class InPlaceTextEditor : IDisposable

type InPlaceTextEditor = class
    interface IDisposable

Public NotInheritable Class InPlaceTextEditor
Implements IDisposable

Inheritance

Object

InPlaceTextEditor

Implements

IDisposable

Remarks

A singleton in-place editor

Properties

CommitOnEscape	Gets or sets a value indicating whether the Escape key commits the edit. If true, the Enter key will be used as a CRLF for in-place editing.
EditorControl	Gets the Windows control used to edit the text.
EditorFont	Gets the custom font for this editor. This property may return null in which case the edit control's default font will be used.
Field	Gets the field that is currently being edited or the field whose subfield is currently being edited.
HorizontalAlignment	Gets or sets a value indicating the horizontal alignment of the text in the editor.
Instance	Gets the singleton InPlaceTextEditor instance.
InUse	Gets a value indicating whether the edit control is currently active and in use.
MultipleLineEditingEnabled	Gets or sets a value indicating whether the text editor supports multiline editing.
Shape	Gets the shape whose field or subfield is currently being edited.
SubField	Gets the subfield that is currently being edited. This can be null.
WordWrap	Gets or sets a value indicating whether the editor should word wrap.

Methods

CancelPendingEdit()	Cancels a pending edit if any.
CanEditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView)	Returns a value indicating whether the value of this field can be edited.
CommitPendingEdit()	Commits a pending edit if any.
Dispose()
EditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView, PointD)	Invokes the in-place editor, setting the caret using the specified mouse position.
EditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView, String)	Invokes the in-place editor, replacing the text with the specified text.
EditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView)	Invokes the in-place editor.
SetFont(String, Single, FontStyle, GraphicsUnit, DiagramClientView)	Sets the font for this editor.

Events

BeginEdit	Event fired when in-place editing begins.
EndEdit	Event fired when in-place editing is finished.