InPlaceTextEditor Class

  • Article

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.Diagrams.InPlaceTextEditor

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.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
Public property 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.
Public property EditorControl Gets the Windows control used to edit the text.
Public property 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.
Public property Field Gets the field that is currently being edited or the field whose subfield is currently being edited.
Public property HorizontalAlignment Gets or sets a value indicating the horizontal alignment of the text in the editor.
Public propertyStatic member Instance Gets the singleton InPlaceTextEditor instance.
Public property InUse Gets a value indicating whether the edit control is currently active and in use.
Public property MultipleLineEditingEnabled Gets or sets a value indicating whether the text editor supports multiline editing.
Public property Shape Gets the shape whose field or subfield is currently being edited.
Public property SubField Gets the subfield that is currently being edited. This can be null.
Public property WordWrap Gets or sets a value indicating whether the editor should word wrap.

Top

Methods

  Name Description
Public method CancelPendingEdit Cancels a pending edit if any.
Public method CanEditValue Returns a value indicating whether the value of this field can be edited.
Public method CommitPendingEdit Commits a pending edit if any.
Public method Dispose Releases all resources used by the current instance of the InPlaceTextEditor class.
Public method EditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView) Invokes the in-place editor.
Public method EditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView, PointD) Invokes the in-place editor, setting the caret using the specified mouse position.
Public method EditValue(ShapeElement, ShapeField, ShapeSubField, DiagramClientView, String) Invokes the in-place editor, replacing the text with the specified text.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetFont Sets the font for this editor.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event BeginEdit Event fired when in-place editing begins.
Public event 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.

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace