WPF › Ribbon › BinaryRibbonSmartTextBox

BinaryRibbonSmartTextBox

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WPF.Controls.Office

A ribbon text box that adds a watermark shown while it is empty, a button that clears the text, and an image used to flag input the application considers wrong. It also takes part in the ribbon's key tip navigation.

public class BinaryRibbonSmartTextBox : TextBox, IBinaryRibbonKeyTipControl

Inherits from / implements: TextBox, IBinaryRibbonKeyTipControl

Members at a glance

`BinaryRibbonSmartTextBox`	Initializes a new instance of the `BinaryRibbonSmartTextBox` class.
`AlertClueImageSource`	Gets or sets the alert clue image.
`AlertClueImageSourceOnError`	Gets or sets the image that will be rendered when the control is in error mode (i.e. you could use this when the user has not set a mandatory data in the control, etc.)
`AlertFlagTooltipContent`	Gets or sets the custom tooltip content for the alert flag visual.
`ClearTextVisualContent`	Gets or sets the cntent for the clear data button located at the rigt hand side corner of the control.
`ClearTextVisualForegroundBrush`	Gets or sets the forground brush for the clear text command visual that is rendered at the right hand side corner of the control.
`ClearTextVisualOnHoverForegroundBrush`	Gets or sets the forground brush for the clear text command visual that is rendered at the right hand side corner of the control, when mouse hovers on it.
`ControlBorderBrush`	Gets or sets the control border brush.
`DataEntryMode`	What this box accepts: anything, letters and digits, or digits only.
`DisallowedInputRegularExpression`	Gets or sets the custom regular expression string to be used, when deciding what text input is not allwoed.
`IsAlertClueImageRenderingEnabled`	Gets or sets whether to render the alert clue image.
`IsClearTextVisualAlwaysVisible`	Gets or sets whether the clear text visual is always shown in the control, irrespective of whether the user has any text typed into the control or not.
`IsClearTextVisualRenderingFeatureEnabled`	Whether the button that clears the text is shown while the box has content.
`WatermarkContent`	Gets or sets the watermark instance for the textbox.
`WatermarkContentTemplate`	Gets or sets the watermark template to use, for rendering the watermark instance.
`OnApplyTemplate`	Called once the control template has been applied, which is where the named parts of the template first become reachable.
`AlertClueImageSourceOnErrorProperty`	Identifies the `AlertClueImageSourceOnError` dependency property.
`AlertClueImageSourceProperty`	Identifies the `AlertClueImageSource` dependency property.
`AlertFlagTooltipContentProperty`	Identifies the `AlertFlagTooltipContent` dependency property.
`ClearTextVisualContentProperty`	Identifies the `ClearTextVisualContent` dependency property.
`ClearTextVisualForegroundBrushProperty`	Identifies the `ClearTextVisualForegroundBrush` dependency property.
`ClearTextVisualOnHoverForegroundBrushProperty`	Identifies the `ClearTextVisualOnHoverForegroundBrush` dependency property.
`ControlBorderBrushProperty`	Identifies the `ControlBorderBrush` dependency property.
`DataEntryModeProperty`	Identifies the `DataEntryMode` dependency property.
`DisallowedInputRegularExpressionProperty`	Identifies the `DisallowedInputRegularExpression` dependency property.
`IsAlertClueImageRenderingEnabledProperty`	Identifies the `IsAlertClueImageRenderingEnabled` dependency property.
`IsClearTextVisualAlwaysVisibleProperty`	Identifies the `IsClearTextVisualAlwaysVisible` dependency property.
`IsClearTextVisualRenderingFeatureEnabledProperty`	Identifies the `IsClearTextVisualRenderingFeatureEnabled` dependency property.
`WatermarkContentProperty`	Identifies the `WatermarkContent` dependency property.
`WatermarkContentTemplateProperty`	Identifies the `WatermarkContentTemplate` dependency property.

Constructors

BinaryRibbonSmartTextBox

public BinaryRibbonSmartTextBox()

Initializes a new instance of the BinaryRibbonSmartTextBox class.

Properties

AlertClueImageSource

public BitmapSource AlertClueImageSource

Gets or sets the alert clue image.

AlertClueImageSourceOnError

public BitmapSource AlertClueImageSourceOnError

Gets or sets the image that will be rendered when the control is in error mode (i.e. you could use this when the user has not set a mandatory data in the control, etc.)

AlertFlagTooltipContent

public object AlertFlagTooltipContent

Gets or sets the custom tooltip content for the alert flag visual.

ClearTextVisualContent

public object ClearTextVisualContent

Gets or sets the cntent for the clear data button located at the rigt hand side corner of the control.

ClearTextVisualForegroundBrush

public Brush ClearTextVisualForegroundBrush

Gets or sets the forground brush for the clear text command visual that is rendered at the right hand side corner of the control.

ClearTextVisualOnHoverForegroundBrush

public Brush ClearTextVisualOnHoverForegroundBrush

Gets or sets the forground brush for the clear text command visual that is rendered at the right hand side corner of the control, when mouse hovers on it.

ControlBorderBrush

public Brush ControlBorderBrush

Gets or sets the control border brush.

DataEntryMode

public DataEntryMode DataEntryMode

What this box accepts: anything, letters and digits, or digits only.

DisallowedInputRegularExpression

public string DisallowedInputRegularExpression

Gets or sets the custom regular expression string to be used, when deciding what text input is not allwoed.

IsAlertClueImageRenderingEnabled

public bool IsAlertClueImageRenderingEnabled

Gets or sets whether to render the alert clue image.

IsClearTextVisualAlwaysVisible

public bool IsClearTextVisualAlwaysVisible

Gets or sets whether the clear text visual is always shown in the control, irrespective of whether the user has any text typed into the control or not.

IsClearTextVisualRenderingFeatureEnabled

public bool IsClearTextVisualRenderingFeatureEnabled

Whether the button that clears the text is shown while the box has content.

WatermarkContent

public object WatermarkContent

Gets or sets the watermark instance for the textbox.

WatermarkContentTemplate

public DataTemplate WatermarkContentTemplate

Gets or sets the watermark template to use, for rendering the watermark instance.

Methods

OnApplyTemplate

public override void OnApplyTemplate()

Called once the control template has been applied, which is where the named parts of the template first become reachable.

Fields

AlertClueImageSourceOnErrorProperty

public static readonly DependencyProperty AlertClueImageSourceOnErrorProperty

Identifies the AlertClueImageSourceOnError dependency property.

AlertClueImageSourceProperty

public static readonly DependencyProperty AlertClueImageSourceProperty

Identifies the AlertClueImageSource dependency property.

AlertFlagTooltipContentProperty

public static readonly DependencyProperty AlertFlagTooltipContentProperty

Identifies the AlertFlagTooltipContent dependency property.

ClearTextVisualContentProperty

public static readonly DependencyProperty ClearTextVisualContentProperty

Identifies the ClearTextVisualContent dependency property.

ClearTextVisualForegroundBrushProperty

public static readonly DependencyProperty ClearTextVisualForegroundBrushProperty

Identifies the ClearTextVisualForegroundBrush dependency property.

ClearTextVisualOnHoverForegroundBrushProperty

public static readonly DependencyProperty ClearTextVisualOnHoverForegroundBrushProperty

Identifies the ClearTextVisualOnHoverForegroundBrush dependency property.

ControlBorderBrushProperty

public static readonly DependencyProperty ControlBorderBrushProperty

Identifies the ControlBorderBrush dependency property.

DataEntryModeProperty

public static readonly DependencyProperty DataEntryModeProperty

Identifies the DataEntryMode dependency property.

DisallowedInputRegularExpressionProperty

public static readonly DependencyProperty DisallowedInputRegularExpressionProperty

Identifies the DisallowedInputRegularExpression dependency property.

IsAlertClueImageRenderingEnabledProperty

public static readonly DependencyProperty IsAlertClueImageRenderingEnabledProperty

Identifies the IsAlertClueImageRenderingEnabled dependency property.

IsClearTextVisualAlwaysVisibleProperty

public static readonly DependencyProperty IsClearTextVisualAlwaysVisibleProperty

Identifies the IsClearTextVisualAlwaysVisible dependency property.

IsClearTextVisualRenderingFeatureEnabledProperty

public static readonly DependencyProperty IsClearTextVisualRenderingFeatureEnabledProperty

Identifies the IsClearTextVisualRenderingFeatureEnabled dependency property.

WatermarkContentProperty

public static readonly DependencyProperty WatermarkContentProperty

Identifies the WatermarkContent dependency property.

WatermarkContentTemplateProperty

public static readonly DependencyProperty WatermarkContentTemplateProperty

Identifies the WatermarkContentTemplate dependency property.