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
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            System.Windows.ControlsControl
              TomsToolbox.Wpf.ControlsInPlaceEdit

Namespace: TomsToolbox.Wpf.Controls
Assembly: TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 2.21.0+44d18b541fc9419ec3c549350a832394661b2a4d
XMLNS for XAML: Not mapped to an xmlns.
Syntax
Copy
[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.
Public propertyTextAlignment Gets or sets the text alignment.
Public propertyTextTrimming Gets or sets the text trimming.
Top
Methods
 NameDescription
Public methodOnApplyTemplateWhen overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.
(Overrides FrameworkElementOnApplyTemplate)
Protected methodOnMouseDoubleClickRaises the MouseDoubleClick routed event.
(Overrides ControlOnMouseDoubleClick(MouseButtonEventArgs))
Protected methodOnMouseLeftButtonDownInvoked when an unhandled MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.
(Overrides UIElementOnMouseLeftButtonDown(MouseButtonEventArgs))
Top
Events
 NameDescription
Public eventValidate Occurs when the edited text needs to be validated.
Top
Fields
 NameDescription
Public fieldStatic memberHasErrorsProperty Identifies the HasErrors dependency property
Public fieldStatic memberIsEditingDisabledProperty Identifies the IsEditingDisabled dependency property.
Public fieldStatic memberIsEditingProperty Identifies the IsEditing dependency property.
Public fieldStatic memberTextAlignmentProperty Identifies the TextAlignment dependency property
Public fieldStatic memberTextProperty Identifies the Text dependency property.
Public fieldStatic memberTextTrimmingProperty Identifies the TextTrimming dependency property
Top
Extension Methods
 NameDescription
Public Extension MethodAncestors Returns an enumeration of the ancestor elements in the logical tree of this element.
(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.
(Defined by DependencyObjectExtensions)
Public Extension MethodBeginInvoke Invokes the specified method asynchronously in the dispatcher thread of the visual.
(Defined by VisualExtensions)
Public Extension MethodBeginInvoke Invokes the specified method asynchronously in the dispatcher thread of the visual.
(Defined by VisualExtensions)
Public Extension MethodGetClientRect Gets the client rectangle of the framework element.
(Defined by PresentationFrameworkExtensions)
Public Extension MethodGetClientRect 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.
(Defined by ExportProviderLocator)
Public Extension MethodGetExtent Gets the extent of the framework element.
(Defined by PresentationFrameworkExtensions)
Public Extension MethodGetExtent Gets the extent of the framework element translated to another visual.
(Defined by PresentationFrameworkExtensions)
Public Extension MethodGetMissingExportProviderMessage Gets the message to show when an export provider could not be located in the visual tree.
(Defined by ExportProviderLocator)
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.
(Defined by DependencyObjectExtensions)
Public Extension MethodGetValueT Gets the value of a dependency property using SafeCastT(Object).
(Defined by DependencyObjectExtensions)
Public Extension MethodGetWindowHandle Gets the window handle of the HwndSource hosting this item.
(Defined by DependencyObjectExtensions)
Public Extension MethodProcessMessages Waits until all pending messages up to the Background priority are processed.
(Defined by PresentationFrameworkExtensions)
Public Extension MethodProcessMessages 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.
(Defined by ObjectExtensions)
Public Extension MethodSetExportProvider Sets the export provider.
(Defined by ExportProviderLocator)
Public Extension MethodTryFindAncestorT Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions)
Public Extension MethodTryFindAncestorT Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions)
Public Extension MethodTryFindAncestorOrSelfT Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions)
Public Extension MethodTryFindAncestorOrSelfT Returns the first element in the ancestor list that implements the type of the type parameter.
(Defined by DependencyObjectExtensions)
Public Extension MethodTryGetExportProvider Gets the active export provider for the specified object, or null if no export provider is registered.
(Defined by ExportProviderLocator)
Public Extension MethodTryGetRootVisual Gets the root visual for the item.
(Defined by DependencyObjectExtensions)
Public Extension MethodVisualAncestors Returns an enumeration of the ancestor elements in the visual tree of this element.
(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.
(Defined by DependencyObjectExtensions)
Public Extension MethodVisualChildren Enumerates the immediate children of the specified item.
(Defined by DependencyObjectExtensions)
Public Extension MethodVisualChildrenAndSelf Enumerates the specified item and it's immediate children.
(Defined by DependencyObjectExtensions)
Public Extension MethodVisualDescendants Enumerates all visuals descendants of the specified item.
(Defined by DependencyObjectExtensions)
Public Extension MethodVisualDescendantsAndSelf Enumerates the specified item and all it's visual descendants.
(Defined by DependencyObjectExtensions)
Top
See Also