Click or drag to resize

InPlaceEdit Class

Text control supporting in place editing.

Editing starts

  • by deferred mouse double click
  • by pressing F2
  • setting IsEditing to true

Editing terminates

  • when the focus gets lost (changes accepted)
  • when setting IsEditing to false (changes accepted)
  • when the user clicks outside the text box or moves the mouse wheel (changes accepted)
  • by pressing RETURN (changes accepted)
  • by pressing ESC (changes rejected)
Inheritance Hierarchy

Namespace:  TomsToolbox.Wpf.Controls
Assembly:  TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 1.0.69.0
Syntax
[TemplatePartAttribute(Name = "PART_TextBox", Type = typeof(TextBox))]
public class InPlaceEdit : Control

The InPlaceEdit type exposes the following members.

Constructors
  NameDescription
Public methodInPlaceEdit
Initializes a new instance of the InPlaceEdit class.
Top
Properties
  NameDescription
Public propertyHasErrors
Gets or sets a value indicating whether the edited text has errors; if there are errors the text can't be committed.
Public propertyIsEditing
Gets or sets a value indicating whether editing is active.
Public propertyIsEditingDisabled
Gets or sets a value indicating whether editing is currently disabled.
Public propertyText
Gets or sets the text to be edited.

[CanBeNull]

Public propertyTextAlignment
Gets or sets the text alignment.
Public propertyTextTrimming
Gets or sets the text trimming.
Top
Methods
Events
  NameDescription
Public eventValidate
Occurs when the edited text needs to be validated.
Top
Fields
  NameDescription
Public fieldStatic memberHasErrorsProperty
Identifies the HasErrors dependency property

[NotNull]

Public fieldStatic memberIsEditingDisabledProperty
Identifies the IsEditingDisabled dependency property.

[NotNull]

Public fieldStatic memberIsEditingProperty
Identifies the IsEditing dependency property.

[NotNull]

Public fieldStatic memberTextAlignmentProperty
Identifies the TextAlignment dependency property

[NotNull]

Public fieldStatic memberTextProperty
Identifies the Text dependency property.

[NotNull]

Public fieldStatic memberTextTrimmingProperty
Identifies the TextTrimming dependency property

[NotNull]

Top
Extension Methods
  NameDescription
Public Extension MethodAncestors
Returns an enumeration of the ancestor elements in the logical tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodAncestorsAndSelf
Returns an enumeration of elements that contain this element, and the ancestors in the logical tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodBeginInvoke(Action)Overloaded.
Invokes the specified method asynchronously in the dispatcher thread of the visual.

[NotNull]

(Defined by VisualExtensions.)
Public Extension MethodBeginInvoke(DispatcherPriority, Action)Overloaded.
Invokes the specified method asynchronously in the dispatcher thread of the visual.

[NotNull]

(Defined by VisualExtensions.)
Public Extension MethodGetClientRectOverloaded.
Gets the client rectangle of the framework element.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetClientRect(Visual)Overloaded.
Gets the client rectangle of the framework element translated to another visual.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetDesignUnitSize
Gets the physical size of one design unit in pixels.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetExportProvider
Gets the active export provider for the specified object.

[NotNull]

(Defined by ExportProviderLocator.)
Public Extension MethodGetExtentOverloaded.
Gets the extent of the framework element.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetExtent(FrameworkElement)Overloaded.
Gets the extent of the framework element translated to another visual.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetPhysicalPixelSize
Gets the physical size of one pixel in design units.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetRootVisual
Gets the root visual for the item.

[NotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodGetValueT (Defined by DependencyObjectExtensions.)
Public Extension MethodGetWindowHandle
Gets the window handle of the HwndSource hosting this item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodProcessMessagesOverloaded.
Waits until all pending messages up to the Background priority are processed.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodProcessMessages(DispatcherPriority)Overloaded.
Waits until all pending messages up to the specified priority are processed.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodSafeCastT
Performs a cast from object to T, avoiding possible null violations if T is a value type.

[CanBeNull]

(Defined by ObjectExtensions.)
Public Extension MethodSetExportProvider
Sets the export provider.
(Defined by ExportProviderLocator.)
Public Extension MethodTryFindAncestorTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryGetExportProvider
Gets the active export provider for the specified object, or null if no export provider is registered.

[CanBeNull]

(Defined by ExportProviderLocator.)
Public Extension MethodTryGetRootVisual
Gets the root visual for the item.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestors
Returns an enumeration of the ancestor elements in the visual tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestorsAndSelf
Returns an enumeration of elements that contains this element, and the ancestors in the visual tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildren
Enumerates the immediate children of the specified item.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildrenAndSelf
Enumerates the specified item and it's immediate children.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendants
Enumerates all visuals descendants of the specified item.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendantsAndSelf
Enumerates the specified item and all it's visual descendants.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Top
See Also