BinaryRibbonSmartTextBox

Creates an empty smart text box, with the clear button turned on and no watermark.

Gets or sets the flag picture shown once the box has text in it – the "all is well" state of a required field.

Shown only while IsAlertClueImageRenderingEnabled is true, from the first time text is typed.

Gets or sets the flag picture shown while the box is empty – the "needs attention" state of a required field.

It is shown from the moment the template is applied, whether or not IsAlertClueImageRenderingEnabled is set, and again whenever the box is emptied while that property is true.

Gets or sets the tooltip shown over the flag picture – "Customer reference is required", say.

Gets or sets what the clear button shows.

A click on the button empties the box. The button is drawn at the box's Control.FontSize.

Gets or sets the colour of the clear button's content while the button is disabled.

The built-in template uses it only while the button is disabled, drawn faint. At other times the clear button takes the box's own Control.Foreground, and ClearTextVisualOnHoverForegroundBrush under the pointer.

Gets or sets the colour of the clear button's content while the pointer is over it.

Gets or sets the colour of the box's frame.

The built-in template draws the frame with this brush, not with Control.BorderBrush, so set this one to change it – to the skin's border colour, say, with ControlBorderBrush="{DynamicResource {x:Static ribbon:BinaryRibbonThemeResources.AllPurposeBorderBrushKey}}".

Gets or sets which characters the user can type into the box.

The filter applies to characters as they are typed. Text pasted into the box, or set through TextBox.Text, is not checked.

<!-- A quantity box that takes digits only. -->
<ribbon:BinaryRibbonSmartTextBox DataEntryMode="NumericOnly" WatermarkContent="Qty" Width="60" />

Gets or sets a regular expression for the characters the user may not type, when DataEntryMode is DataEntryMode.None.

Typed text that the expression matches anywhere is refused. The expression is used only in DataEntryMode.None mode; the other modes ignore it. An invalid expression throws an ArgumentException when the user next types.

<!-- A file name box that refuses the characters Windows does not allow in file names. -->
<ribbon:BinaryRibbonSmartTextBox DataEntryMode="None"
                                 DisallowedInputRegularExpression="[\/:*?&quot;&lt;&gt;|]"
                                 WatermarkContent="Export file name" />

Gets or sets whether the flag picture changes between AlertClueImageSourceOnError and AlertClueImageSource as the box is emptied and filled.

Whatever its value, the flag shows AlertClueImageSourceOnError from the moment the template is applied, so a box with that picture set shows it even with this property off; it just never changes. Leave both pictures unset for no flag at all.

<!-- A required field: a red flag until something is typed, then a green one. -->
<ribbon:BinaryRibbonSmartTextBox WatermarkContent="Customer reference"
                                 IsAlertClueImageRenderingEnabled="True"
                                 AlertClueImageSourceOnError="Images/FlagRed12.png"
                                 AlertClueImageSource="Images/FlagGreen12.png"
                                 AlertFlagTooltipContent="A customer reference is required" />

Gets or sets whether the clear button is on show before anything has been typed.

It decides only how the button starts out. As soon as the text changes, the button is shown while there is text and hidden while there is none, whatever this property says.

Gets or sets whether the clear button comes and goes with the text: shown while there is text, hidden while there is none.

With this and IsClearTextVisualAlwaysVisible both false, the box has no clear button.

Gets or sets the prompt shown in the box while it is empty and does not have the keyboard focus – "Search orders", "Customer name".

The prompt is not part of TextBox.Text, and it ignores the pointer, so a click on it lands in the box.

The prompt is shown or hidden when the box gains or loses the keyboard focus and when the clear button is used, not on every change of text. Text set in code while the box does not have the focus leaves the prompt showing over it until the box next gains or loses the focus.

Gets or sets the template that draws WatermarkContent.

<ribbon:BinaryRibbonSmartTextBox WatermarkContent="Search orders">
    <ribbon:BinaryRibbonSmartTextBox.WatermarkContentTemplate>
        <DataTemplate>
            <TextBlock Text="{Binding}" FontStyle="Italic" Foreground="SlateGray" />
        </DataTemplate>
    </ribbon:BinaryRibbonSmartTextBox.WatermarkContentTemplate>
</ribbon:BinaryRibbonSmartTextBox>

Finds the parts of the new template – the clear button PART_ClearTextVisual, the flag PART_AlertClueImage, the text host PART_ContentHost and the watermark PART_WatermarkContent – and puts the watermark and flag in their starting state.

Identifies the AlertClueImageSourceOnError dependency property.

Identifies the AlertClueImageSource dependency property.

Identifies the AlertFlagTooltipContent dependency property.

Identifies the ClearTextVisualContent dependency property.

Identifies the ClearTextVisualForegroundBrush dependency property.

Identifies the ClearTextVisualOnHoverForegroundBrush dependency property.

Identifies the ControlBorderBrush dependency property.

Identifies the DataEntryMode dependency property.

Identifies the DisallowedInputRegularExpression dependency property.

Identifies the IsAlertClueImageRenderingEnabled dependency property.

Identifies the IsClearTextVisualAlwaysVisible dependency property.

Identifies the IsClearTextVisualRenderingFeatureEnabled dependency property.

Identifies the WatermarkContent dependency property.

Identifies the WatermarkContentTemplate dependency property.