InPlaceTextEditor Class

Article
04/26/2013

Inheritance Hierarchy

Object
Microsoft.VisualStudio.Modeling.Diagrams.InPlaceTextEditor

Namespace: Microsoft.VisualStudio.Modeling.Diagrams
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll)

Syntax

'Declaration
Public NotInheritable Class InPlaceTextEditor _
    Implements IDisposable

public sealed class InPlaceTextEditor : IDisposable

public ref class InPlaceTextEditor sealed : IDisposable

[<Sealed>]
type InPlaceTextEditor =  
    class 
        interface IDisposable 
    end

public final class InPlaceTextEditor implements IDisposable

The InPlaceTextEditor type exposes the following members.

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	CancelPendingEdit	Cancels a pending edit if any.
	CanEditValue	Returns a value indicating whether the value of this field can be edited.
	CommitPendingEdit	Commits a pending edit if any.
	Dispose	Releases all resources used by the current instance of the InPlaceTextEditor class.
	EditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView)	Invokes the in-place editor.
	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.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetFont	Sets the font for this editor.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

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

Top

Remarks

A singleton in-place editor

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via