MaskedTextBox Class
Definition
Namespace: Avalonia.Controls
Assembly: Avalonia.Controls (in Avalonia.Controls.dll)
- C#
- VB
- F#
public class MaskedTextBox : TextBox
Public Class MaskedTextBox
Inherits TextBox
type MaskedTextBox =
class
inherit TextBox
end
Inheritance | Object → AvaloniaObject → Animatable → StyledElement → Visual → Layoutable → Interactive → InputElement → Control → TemplatedControl → TextBox → MaskedTextBox |
Constructors
MaskedTextBox() | Initializes a new instance of the MaskedTextBox class |
MaskedTextBox(MaskedTextProvider) | Constructs the MaskedTextBox with the specified MaskedTextProvider object. |
Properties
AcceptsReturn | Gets or sets a value that determines whether the TextBox allows and displays newline or return characters (Inherited from TextBox) |
AcceptsTab | Gets or sets a value that determins whether the TextBox allows and displays tabs (Inherited from TextBox) |
ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. (Inherited from StyledElement) |
AsciiOnly | Gets or sets a value indicating if the masked text box is restricted to accept only ASCII characters. Default value is false. |
Background | Gets or sets the brush used to draw the control's background. (Inherited from TemplatedControl) |
BackgroundSizing | Gets or sets how the control's background is drawn relative to the control's border. (Inherited from TemplatedControl) |
BorderBrush | Gets or sets the brush used to draw the control's border. (Inherited from TemplatedControl) |
BorderThickness | Gets or sets the thickness of the control's border. (Inherited from TemplatedControl) |
Bounds | Gets the bounds of the control relative to its parent. (Inherited from Visual) |
BypassFlowDirectionPolicies | Gets a value indicating whether control bypass FlowDirecton policies. (Inherited from Visual) |
CanCopy | Property for determining if the Copy command can be executed. (Inherited from TextBox) |
CanCut | Property for determining if the Cut command can be executed. (Inherited from TextBox) |
CanPaste | Property for determining if the Paste command can be executed. (Inherited from TextBox) |
CanRedo | Gets a value that indicates whether the redo stack has an action that can be redone (Inherited from TextBox) |
CanUndo | Gets a value that indicates whether the undo stack has an action that can be undone (Inherited from TextBox) |
CaretBlinkInterval | Gets or sets the caret blink rate (Inherited from TextBox) |
CaretBrush | Gets or sets a brush that is used for the text caret (Inherited from TextBox) |
CaretIndex | Gets or sets the index of the text caret (Inherited from TextBox) |
Classes | Gets or sets the styled element's classes. (Inherited from StyledElement) |
ClearSelectionOnLostFocus | Gets or sets a value that determines whether the TextBox clears its selection after it loses focus. (Inherited from TextBox) |
Clip | Gets or sets the geometry clip for this visual. (Inherited from Visual) |
ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. (Inherited from Visual) |
ContextFlyout | Gets or sets a context flyout to the control (Inherited from Control) |
ContextMenu | Gets or sets a context menu to the control. (Inherited from Control) |
CornerRadius | Gets or sets the radius of the border rounded corners. (Inherited from TemplatedControl) |
Culture | Gets or sets the culture information associated with the masked text box. |
Cursor | Gets or sets associated mouse cursor. (Inherited from InputElement) |
DataContext | Gets or sets the control's data context. (Inherited from StyledElement) |
DataTemplates | Gets or sets the data templates for the control. (Inherited from Control) |
DesiredSize | Gets the size that this element computed during the measure pass of the layout process. (Inherited from Layoutable) |
Effect | Gets or sets the effect of the control. (Inherited from Visual) |
FlowDirection | Gets or sets the text flow direction. (Inherited from Visual) |
Focusable | Gets or sets a value indicating whether the control can receive focus. (Inherited from InputElement) |
FocusAdorner | Gets or sets the control's focus adorner. (Inherited from Control) |
FontFamily | Gets or sets the font family used to draw the control's text. (Inherited from TemplatedControl) |
FontFeatures | Gets or sets the font features turned on/off. (Inherited from TemplatedControl) |
FontSize | Gets or sets the size of the control's text in points. (Inherited from TemplatedControl) |
FontStretch | Gets or sets the font stretch used to draw the control's text. (Inherited from TemplatedControl) |
FontStyle | Gets or sets the font style used to draw the control's text. (Inherited from TemplatedControl) |
FontWeight | Gets or sets the font weight used to draw the control's text. (Inherited from TemplatedControl) |
Foreground | Gets or sets the brush used to draw the control's text and other foreground elements. (Inherited from TemplatedControl) |
GestureRecognizers | (Inherited from InputElement) |
HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. (Inherited from Visual) |
Height | Gets or sets the height of the element. (Inherited from Layoutable) |
HidePromptOnLeave | Gets or sets a value indicating if the prompt character is hidden when the masked text box loses focus. |
HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. (Inherited from Layoutable) |
HorizontalContentAlignment | Gets or sets the horizontal alignment of the content within the control. (Inherited from TextBox) |
InheritanceParent | Gets or sets the parent object that inherited AvaloniaProperty values are inherited from. (Inherited from AvaloniaObject) |
InnerLeftContent | Gets or sets custom content that is positioned on the left side of the text layout box (Inherited from TextBox) |
InnerRightContent | Gets or sets custom content that is positioned on the right side of the text layout box (Inherited from TextBox) |
IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. (Inherited from Layoutable) |
IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. (Inherited from InputElement) |
IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. (Inherited from Visual) |
IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. (Inherited from InputElement) |
IsEnabledCore | Allows a derived class to override the enabled state of the control. (Inherited from InputElement) |
IsFocused | Gets a value indicating whether the control is focused. (Inherited from InputElement) |
IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. (Inherited from InputElement) |
IsInactiveSelectionHighlightEnabled | Gets or sets a value that determines whether the TextBox shows a selection highlight when it is not focused. (Inherited from TextBox) |
IsInitialized | Gets a value that indicates whether the element has finished initialization. (Inherited from StyledElement) |
IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. (Inherited from InputElement) |
IsLoaded | Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. (Inherited from Control) |
IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. (Inherited from Layoutable) |
IsPointerOver | Gets a value indicating whether the pointer is currently over the control. (Inherited from InputElement) |
IsReadOnly | Gets or sets a value whether this TextBox is read-only (Inherited from TextBox) |
IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. (Inherited from InputElement) |
IsUndoEnabled | Property for determining whether undo/redo is enabled (Inherited from TextBox) |
IsVisible | Gets or sets a value indicating whether this control is visible. (Inherited from Visual) |
Item(AvaloniaProperty) | Gets or sets the value of a AvaloniaProperty. (Inherited from AvaloniaObject) |
Item(IndexerDescriptor) | Gets or sets a binding for a AvaloniaProperty. (Inherited from AvaloniaObject) |
KeyBindings | (Inherited from InputElement) |
LetterSpacing | Gets or sets the spacing between characters (Inherited from TextBox) |
LineHeight | Gets or sets the line height. (Inherited from TextBox) |
LogicalChildren | Gets the styled element's logical children. (Inherited from StyledElement) |
Margin | Gets or sets the margin around the element. (Inherited from Layoutable) |
Mask | Gets or sets the mask to apply to the TextBox. |
MaskCompleted | Specifies whether the test string required input positions, as specified by the mask, have all been assigned. |
MaskFull | Specifies whether all inputs (required and optional) have been provided into the mask successfully. |
MaskProvider | Gets the MaskTextProvider for the specified Mask. |
MaxHeight | Gets or sets the maximum height of the element. (Inherited from Layoutable) |
MaxLength | Gets or sets the maximum number of characters that the TextBox can accept. This constraint only applies for manually entered (user-inputted) text. (Inherited from TextBox) |
MaxLines | Gets or sets the maximum number of visible lines to size to. (Inherited from TextBox) |
MaxWidth | Gets or sets the maximum width of the element. (Inherited from Layoutable) |
MinHeight | Gets or sets the minimum height of the element. (Inherited from Layoutable) |
MinLines | Gets or sets the minimum number of visible lines to size to. (Inherited from TextBox) |
MinWidth | Gets or sets the minimum width of the element. (Inherited from Layoutable) |
Name | Gets or sets the name of the styled element. (Inherited from StyledElement) |
NewLine | Gets or sets which characters are inserted when Enter is pressed. Default: NewLine (Inherited from TextBox) |
Opacity | Gets or sets the opacity of the control. (Inherited from Visual) |
OpacityMask | Gets or sets the opacity mask of the control. (Inherited from Visual) |
Padding | Gets or sets the padding placed between the border of the control and its content. (Inherited from TemplatedControl) |
Parent | Gets the styled element's logical parent. (Inherited from StyledElement) |
PasswordChar | Gets or sets the Char that should be used for password masking (Inherited from TextBox) |
PromptChar | Gets or sets the character used to represent the absence of user input in MaskedTextBox. |
PseudoClasses | Gets the Classes collection in a form that allows adding and removing pseudoclasses. (Inherited from StyledElement) |
RenderTransform | Gets or sets the render transform of the control. (Inherited from Visual) |
RenderTransformOrigin | Gets or sets the transform origin of the control. (Inherited from Visual) |
ResetOnPrompt | Gets or sets a value indicating if selected characters should be reset when the prompt character is pressed. |
ResetOnSpace | Gets or sets a value indicating if selected characters should be reset when the space character is pressed. |
Resources | Gets or sets the styled element's resource dictionary. (Inherited from StyledElement) |
RevealPassword | Gets or sets whether text masked by PasswordChar should be revealed (Inherited from TextBox) |
SelectedText | Gets or sets the text selected in the TextBox (Inherited from TextBox) |
SelectionBrush | Gets or sets a brush that is used to highlight selected text (Inherited from TextBox) |
SelectionEnd | Gets or sets the end position of the text selected in the TextBox (Inherited from TextBox) |
SelectionForegroundBrush | Gets or sets a brush that is used for the foreground of selected text (Inherited from TextBox) |
SelectionStart | Gets or sets the starting position of the text selected in the TextBox (Inherited from TextBox) |
StyleKey | Gets the type by which the element is styled. (Inherited from StyledElement) |
StyleKeyOverride | (Overrides StyledElement.StyleKeyOverride) |
Styles | Gets the styles for the styled element. (Inherited from StyledElement) |
TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. (Inherited from InputElement) |
Tag | Gets or sets a user-defined object attached to the control. (Inherited from Control) |
Template | Gets or sets the template that defines the control's appearance. (Inherited from TemplatedControl) |
TemplatedParent | Gets the styled element whose lookless template this styled element is part of. (Inherited from StyledElement) |
Text | Gets or sets the Text content of the TextBox (Inherited from TextBox) |
TextAlignment | Gets or sets the TextAlignment of the TextBox (Inherited from TextBox) |
TextWrapping | Gets or sets the TextWrapping of the TextBox (Inherited from TextBox) |
Theme | Gets or sets the theme to be applied to the element. (Inherited from StyledElement) |
Transitions | Gets or sets the property transitions for the control. (Inherited from Animatable) |
UndoLimit | Gets or sets the maximum number of items that can reside in the Undo stack (Inherited from TextBox) |
UseFloatingWatermark | Gets or sets a value indicating whether the Watermark will still be shown above the Text even after a text value is set. (Inherited from TextBox) |
UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. (Inherited from Layoutable) |
VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. (Inherited from Layoutable) |
VerticalContentAlignment | Gets or sets the vertical alignment of the content within the control. (Inherited from TextBox) |
VisualChildren | Gets the control's child visuals. (Inherited from Visual) |
VisualRoot | Gets the root of the visual tree, if the control is attached to a visual tree. (Inherited from Visual) |
Watermark | Gets or sets the placeholder or descriptive text that is displayed even if the Text property is not yet set. (Inherited from TextBox) |
Width | Gets or sets the width of the element. (Inherited from Layoutable) |
ZIndex | Gets or sets the Z index of the control. (Inherited from Visual) |
Methods
Events
ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. (Inherited from StyledElement) |
AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. (Inherited from StyledElement) |
AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. (Inherited from Visual) |
ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. (Inherited from Control) |
CopyingToClipboard | Raised when content is being copied to the clipboard (Inherited from TextBox) |
CuttingToClipboard | Raised when content is being cut to the clipboard (Inherited from TextBox) |
DataContextChanged | Occurs when the DataContext property changes. (Inherited from StyledElement) |
DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. (Inherited from StyledElement) |
DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. (Inherited from Visual) |
DoubleTapped | Occurs when a double-tap gesture occurs on the control. (Inherited from InputElement) |
EffectiveViewportChanged | Occurs when the element's effective viewport changes. (Inherited from Layoutable) |
GotFocus | Occurs when the control receives focus. (Inherited from InputElement) |
Holding | Occurs when a hold gesture occurs on the control. (Inherited from InputElement) |
Initialized | Occurs when the styled element has finished initialization. (Inherited from StyledElement) |
KeyDown | Occurs when a key is pressed while the control has focus. (Inherited from InputElement) |
KeyUp | Occurs when a key is released while the control has focus. (Inherited from InputElement) |
LayoutUpdated | Occurs when a layout pass completes for the control. (Inherited from Layoutable) |
Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. (Inherited from Control) |
LostFocus | Occurs when the control loses focus. (Inherited from InputElement) |
PastingFromClipboard | Raised when content is being pasted from the clipboard (Inherited from TextBox) |
PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control (Inherited from InputElement) |
PointerEntered | Occurs when the pointer enters the control. (Inherited from InputElement) |
PointerExited | Occurs when the pointer leaves the control. (Inherited from InputElement) |
PointerMoved | Occurs when the pointer moves over the control. (Inherited from InputElement) |
PointerPressed | Occurs when the pointer is pressed over the control. (Inherited from InputElement) |
PointerReleased | Occurs when the pointer is released over the control. (Inherited from InputElement) |
PointerWheelChanged | Occurs when the mouse is scrolled over the control. (Inherited from InputElement) |
PropertyChanged | Raised when a AvaloniaProperty value changes on this object. (Inherited from AvaloniaObject) |
ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. (Inherited from StyledElement) |
SizeChanged | Occurs when the bounds (actual size) of the control have changed. (Inherited from Control) |
Tapped | Occurs when a tap gesture occurs on the control. (Inherited from InputElement) |
TemplateApplied | Raised when the control's template is applied. (Inherited from TemplatedControl) |
TextChanged | Occurs asynchronously after text changes and the new text is rendered. (Inherited from TextBox) |
TextChanging | Occurs synchronously when text starts to change but before it is rendered. (Inherited from TextBox) |
TextInput | Occurs when a user typed some text while the control has focus. (Inherited from InputElement) |
TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client (Inherited from InputElement) |
Unloaded | Occurs when the control is removed from the visual tree. (Inherited from Control) |
Fields
AsciiOnlyProperty | |
CultureProperty | |
HidePromptOnLeaveProperty | |
MaskCompletedProperty | |
MaskFullProperty | |
MaskProperty | |
PromptCharProperty | |
ResetOnPromptProperty | |
ResetOnSpaceProperty |