Click or drag to resize

TextBoxVisibleWhiteSpaceDecorator Class

Makes white space in text boxes visible.
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            TomsToolbox.WpfTextBoxVisibleWhiteSpaceDecorator

Namespace: TomsToolbox.Wpf
Assembly: TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 2.21.0+44d18b541fc9419ec3c549350a832394661b2a4d
XMLNS for XAML: Not mapped to an xmlns.
Syntax
Copy
[ContentPropertyAttribute("Child")]
public class TextBoxVisibleWhiteSpaceDecorator : FrameworkElement

The TextBoxVisibleWhiteSpaceDecorator type exposes the following members.

Constructors
 NameDescription
Public methodTextBoxVisibleWhiteSpaceDecorator Initializes a new instance of the TextBoxVisibleWhiteSpaceDecorator class.
Top
Properties
 NameDescription
Public propertyChild Gets or sets the inner text box.
Protected propertyLogicalChildren Gets an enumerator for logical child elements of this element.
(Overrides FrameworkElementLogicalChildren)
Protected propertyVisualChildrenCountGets the number of visual child elements within this element.
(Overrides FrameworkElementVisualChildrenCount)
Public propertyWhiteSpaceColor Gets or sets the color of the white space visualization.
Public propertyWhiteSpaceOpacity Gets or sets the opacity of the white space visualization.
Public propertyWhiteSpaces Gets or sets the white spaces to show.
Top
Methods
 NameDescription
Protected methodArrangeOverrideWhen overridden in a derived class, positions child elements and determines a size for a FrameworkElement derived class.
(Overrides FrameworkElementArrangeOverride(Size))
Protected methodGetVisualChildOverrides GetVisualChild(Int32), and returns a child at the specified index from a collection of child elements.
(Overrides FrameworkElementGetVisualChild(Int32))
Protected methodMeasureOverrideWhen overridden in a derived class, measures the size in layout required for child elements and determines a size for the FrameworkElement-derived class.
(Overrides FrameworkElementMeasureOverride(Size))
Top
Fields
 NameDescription
Public fieldStatic memberWhiteSpaceColorProperty Identifies the WhiteSpaceColor dependency property
Public fieldStatic memberWhiteSpaceOpacityProperty Identifies the WhiteSpaceOpacity dependency property
Public fieldStatic memberWhiteSpacesProperty Identifies the WhiteSpaces 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
Example
Surround a TextBox with the decorator to make white space visible:

XAML
Copy
<local:TextBoxVisibleWhiteSpaceDecorator WhiteSpaces="Paragraph,Space,Tab">
  <TextBox TextWrapping="Wrap" AcceptsReturn="True" AcceptsTab="True"/>
</local:TextBoxVisibleWhiteSpaceDecorator>
See Also