Skip to main content

MaskedTextBox Class

Definition

Assembly:Avalonia.Controls
Package:Avalonia
public class MaskedTextBox

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> Visual -> Layoutable -> Interactive -> InputElement -> Control -> TemplatedControl -> TextBox -> MaskedTextBox

Constructors

NameDescription
MaskedTextBox (2 overloads)No summary available.

MaskedTextBox overloads

MaskedTextBox Constructor

public MaskedTextBox()

MaskedTextBox Constructor

Constructs the MaskedTextBox with the specified MaskedTextProvider object.

public MaskedTextBox(System.ComponentModel.MaskedTextProvider maskedTextProvider)
Parameters

maskedTextProvider System.ComponentModel.MaskedTextProvider

Methods

NameDescription
AddHandler (2 overloads)Adds a handler for the specified routed event. Inherited from Interactive.
ApplyStylingApplies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
ApplyTemplateCreates the visual children of the control, if necessary Inherited from TemplatedControl.
ArrangeArranges the control and its children. Inherited from Layoutable.
BeginInitInherited from StyledElement.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccessReturns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearClears the text in the TextBox Inherited from TextBox.
ClearSelectionClears the current selection, maintaining the Avalonia.Controls.TextBox.CaretIndex Inherited from TextBox.
ClearValue (4 overloads)Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
CopyCopies the current text onto the clipboard Inherited from TextBox.
CutCuts the current text onto the clipboard Inherited from TextBox.
EndInitInherited from StyledElement.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
FocusFocuses the control. Inherited from InputElement.
GetBaseValueInherited from AvaloniaObject.
GetFlowDirectionGets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetIsHoldingEnabledInherited from InputElement.
GetIsHoldWithMouseEnabledInherited from InputElement.
GetIsTemplateFocusTargetGets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
GetLineCountGet the number of lines in the TextBox. Inherited from TextBox.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
InvalidateArrangeInvalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateMeasureInvalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateVisualInvalidates the visual and queues a repaint. Inherited from Visual.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
MeasureCarries out a measure of the control. Inherited from Layoutable.
PastePastes the current clipboard text content into the TextBox Inherited from TextBox.
RaiseEventRaises a routed event. Inherited from Interactive.
RedoReapplies the first item on the redo stack Inherited from TextBox.
RemoveHandler (2 overloads)Removes a handler for the specified routed event. Inherited from Interactive.
RenderRenders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
ScrollToLineScroll the Avalonia.Controls.TextBox to the specified line index. Inherited from TextBox.
SelectAllSelect all text in the TextBox Inherited from TextBox.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetFlowDirectionSets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
SetIsHoldingEnabledInherited from InputElement.
SetIsHoldWithMouseEnabledInherited from InputElement.
SetIsTemplateFocusTargetSets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
TryGetResourceInherited from StyledElement.
UndoUndoes the first action in the undo stack Inherited from TextBox.
UpdateLayoutExecutes a layout pass. Inherited from Layoutable.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

Properties

NameDescription
AcceptsReturnGets or sets a value that determines whether the TextBox allows and displays newline or return characters Inherited from TextBox.
AcceptsTabGets or sets a value that determines whether the TextBox allows and displays tabs Inherited from TextBox.
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
AsciiOnlyGets or sets a value indicating if the masked text box is restricted to accept only ASCII characters. Default value is false.
BackgroundGets or sets the brush used to draw the control's background. Inherited from TemplatedControl.
BackgroundSizingGets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl.
BorderBrushGets or sets the brush used to draw the control's border. Inherited from TemplatedControl.
BorderThicknessGets or sets the thickness of the control's border. Inherited from TemplatedControl.
BoundsGets the bounds of the control relative to its parent. Inherited from Visual.
CacheModeGets or sets the cache mode of the visual. Inherited from Visual.
CanCopyProperty for determining if the Copy command can be executed. Inherited from TextBox.
CanCutProperty for determining if the Cut command can be executed. Inherited from TextBox.
CanPasteProperty for determining if the Paste command can be executed. Inherited from TextBox.
CanRedoGets a value that indicates whether the redo stack has an action that can be redone Inherited from TextBox.
CanUndoGets a value that indicates whether the undo stack has an action that can be undone Inherited from TextBox.
CaretBlinkIntervalGets or sets the caret blink rate Inherited from TextBox.
CaretBrushGets or sets a brush that is used for the text caret Inherited from TextBox.
CaretIndexGets or sets the index of the text caret Inherited from TextBox.
ClassesGets or sets the styled element's classes. Inherited from StyledElement.
ClearSelectionOnLostFocusGets or sets a value that determines whether the TextBox clears its selection after it loses focus. Inherited from TextBox.
ClipGets or sets the geometry clip for this visual. Inherited from Visual.
ClipToBoundsGets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual.
ContextFlyoutGets or sets a context flyout to the control Inherited from Control.
ContextMenuGets or sets a context menu to the control. Inherited from Control.
CopyGestureGets a platform-specific Avalonia.Input.KeyGesture for the Copy action Inherited from TextBox.
CornerRadiusGets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
CultureGets or sets the culture information associated with the masked text box.
CursorGets or sets associated mouse cursor. Inherited from InputElement.
CutGestureGets a platform-specific Avalonia.Input.KeyGesture for the Cut action Inherited from TextBox.
DataContextGets or sets the control's data context. Inherited from StyledElement.
DataTemplatesGets or sets the data templates for the control. Inherited from Control.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
EffectGets or sets the effect of the control. Inherited from Visual.
FlowDirectionGets or sets the text flow direction. Inherited from Visual.
FocusableGets or sets a value indicating whether the control can receive focus. Inherited from InputElement.
FocusAdornerGets or sets the control's focus adorner. Inherited from Control.
FontFamilyGets or sets the font family used to draw the control's text. Inherited from TemplatedControl.
FontFeaturesGets or sets the font features turned on/off. Inherited from TemplatedControl.
FontSizeGets or sets the size of the control's text in points. Inherited from TemplatedControl.
FontStretchGets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl.
FontStyleGets or sets the font style used to draw the control's text. Inherited from TemplatedControl.
FontWeightGets or sets the font weight used to draw the control's text. Inherited from TemplatedControl.
ForegroundGets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl.
GestureRecognizersInherited from InputElement.
HasMirrorTransformGets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
HeightGets or sets the height of the element. Inherited from Layoutable.
HidePromptOnLeaveGets or sets a value indicating if the prompt character is hidden when the masked text box loses focus.
HorizontalAlignmentGets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable.
HorizontalContentAlignmentGets or sets the horizontal alignment of the content within the control. Inherited from TextBox.
InnerLeftContentGets or sets custom content that is positioned on the left side of the text layout box Inherited from TextBox.
InnerRightContentGets or sets custom content that is positioned on the right side of the text layout box Inherited from TextBox.
IsArrangeValidGets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable.
IsEffectivelyEnabledGets a value indicating whether this control and all its parents are enabled. Inherited from InputElement.
IsEffectivelyVisibleGets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsEnabledGets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement.
IsFocusedGets a value indicating whether the control is focused. Inherited from InputElement.
IsHitTestVisibleGets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement.
IsInactiveSelectionHighlightEnabledGets or sets a value that determines whether the TextBox shows a selection highlight when it is not focused. Inherited from TextBox.
IsInitializedGets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement.
IsLoadedGets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
IsMeasureValidGets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
IsPointerOverGets a value indicating whether the pointer is currently over the control. Inherited from InputElement.
IsReadOnlyGets or sets a value whether this TextBox is read-only Inherited from TextBox.
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement.
IsUndoEnabledProperty for determining whether undo/redo is enabled Inherited from TextBox.
IsVisibleGets or sets a value indicating whether this control is visible. Inherited from Visual.
ItemInherited from AvaloniaObject.
KeyBindingsInherited from InputElement.
LetterSpacingGets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
LineHeightGets or sets the line height. Inherited from TextBox.
MarginGets or sets the margin around the element. Inherited from Layoutable.
MaskGets or sets the mask to apply to the TextBox.
MaskCompletedSpecifies whether the test string required input positions, as specified by the mask, have all been assigned.
MaskFullSpecifies whether all inputs (required and optional) have been provided into the mask successfully.
MaskProviderGets the MaskTextProvider for the specified Mask.
MaxHeightGets or sets the maximum height of the element. Inherited from Layoutable.
MaxLengthGets or sets the maximum number of characters that the Avalonia.Controls.TextBox can accept. This constraint only applies for manually entered (user-inputted) text. Inherited from TextBox.
MaxLinesGets or sets the maximum number of visible lines to size to. Inherited from TextBox.
MaxWidthGets or sets the maximum width of the element. Inherited from Layoutable.
MinHeightGets or sets the minimum height of the element. Inherited from Layoutable.
MinLinesGets or sets the minimum number of visible lines to size to. Inherited from TextBox.
MinWidthGets or sets the minimum width of the element. Inherited from Layoutable.
NameGets or sets the name of the styled element. Inherited from StyledElement.
NewLineGets or sets which characters are inserted when Enter is pressed. Default: Environment.NewLine Inherited from TextBox.
OpacityGets or sets the opacity of the control. Inherited from Visual.
OpacityMaskGets or sets the opacity mask of the control. Inherited from Visual.
PaddingGets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
ParentGets the styled element's logical parent. Inherited from StyledElement.
PasswordCharGets or sets the char that should be used for password masking Inherited from TextBox.
PasteGestureGets a platform-specific Avalonia.Input.KeyGesture for the Paste action Inherited from TextBox.
PlaceholderForegroundGets or sets the brush used for the foreground color of the placeholder text. Inherited from TextBox.
PlaceholderTextGets or sets the placeholder or descriptive text that is displayed even if the Avalonia.Controls.TextBox.Text property is not yet set. Inherited from TextBox.
PromptCharGets or sets the character used to represent the absence of user input in MaskedTextBox.
RenderTransformGets or sets the render transform of the control. Inherited from Visual.
RenderTransformOriginGets or sets the transform origin of the control. Inherited from Visual.
ResetOnPromptGets or sets a value indicating if selected characters should be reset when the prompt character is pressed.
ResetOnSpaceGets or sets a value indicating if selected characters should be reset when the space character is pressed.
ResourcesGets or sets the styled element's resource dictionary. Inherited from StyledElement.
RevealPasswordGets or sets whether text masked by Avalonia.Controls.TextBox.PasswordChar should be revealed Inherited from TextBox.
SelectedTextGets or sets the text selected in the TextBox Inherited from TextBox.
SelectionBrushGets or sets a brush that is used to highlight selected text Inherited from TextBox.
SelectionEndGets or sets the end position of the text selected in the TextBox Inherited from TextBox.
SelectionForegroundBrushGets or sets a brush that is used for the foreground of selected text Inherited from TextBox.
SelectionStartGets or sets the starting position of the text selected in the TextBox Inherited from TextBox.
StyleKeyGets the type by which the element is styled. Inherited from StyledElement.
StylesGets the styles for the styled element. Inherited from StyledElement.
TabIndexGets 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.
TagGets or sets a user-defined object attached to the control. Inherited from Control.
TemplateGets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
TemplatedParentGets the styled element whose lookless template this styled element is part of. Inherited from StyledElement.
TextGets or sets the Text content of the TextBox Inherited from TextBox.
TextAlignmentGets or sets the Avalonia.Media.TextAlignment of the TextBox Inherited from TextBox.
TextWrappingGets or sets the Avalonia.Media.TextWrapping of the TextBox Inherited from TextBox.
ThemeGets or sets the theme to be applied to the element. Inherited from StyledElement.
TransitionsGets or sets the property transitions for the control. Inherited from Animatable.
UndoLimitGets or sets the maximum number of items that can reside in the Undo stack Inherited from TextBox.
UseFloatingPlaceholderGets or sets a value indicating whether the Avalonia.Controls.TextBox.PlaceholderText will still be shown above the Avalonia.Controls.TextBox.Text even after a text value is set. Inherited from TextBox.
UseFloatingWatermarkGets or sets a value indicating whether the Avalonia.Controls.TextBox.PlaceholderText will still be shown above the Avalonia.Controls.TextBox.Text even after a text value is set. Inherited from TextBox.
UseLayoutRoundingGets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable.
VerticalAlignmentGets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable.
VerticalContentAlignmentGets or sets the vertical alignment of the content within the control. Inherited from TextBox.
WatermarkGets or sets the placeholder or descriptive text that is displayed even if the Avalonia.Controls.TextBox.Text property is not yet set. Inherited from TextBox.
WatermarkForegroundGets or sets the brush used for the foreground color of the placeholder text. Inherited from TextBox.
WidthGets or sets the width of the element. Inherited from Layoutable.
ZIndexGets or sets the Z index of the control. Inherited from Visual.

AsciiOnly Property

Gets or sets a value indicating if the masked text box is restricted to accept only ASCII characters. Default value is false.

public bool AsciiOnly { get; set; }

Culture Property

Gets or sets the culture information associated with the masked text box.

public System.Globalization.CultureInfo Culture { get; set; }

HidePromptOnLeave Property

Gets or sets a value indicating if the prompt character is hidden when the masked text box loses focus.

public bool HidePromptOnLeave { get; set; }

Mask Property

Gets or sets the mask to apply to the TextBox.

public string Mask { get; set; }

MaskCompleted Property

Specifies whether the test string required input positions, as specified by the mask, have all been assigned.

public Nullable<bool> MaskCompleted { get; set; }

MaskFull Property

Specifies whether all inputs (required and optional) have been provided into the mask successfully.

public Nullable<bool> MaskFull { get; set; }

MaskProvider Property

Gets the MaskTextProvider for the specified Mask.

public System.ComponentModel.MaskedTextProvider MaskProvider { get; set; }

PromptChar Property

Gets or sets the character used to represent the absence of user input in MaskedTextBox.

public char PromptChar { get; set; }

ResetOnPrompt Property

Gets or sets a value indicating if selected characters should be reset when the prompt character is pressed.

public bool ResetOnPrompt { get; set; }

ResetOnSpace Property

Gets or sets a value indicating if selected characters should be reset when the space character is pressed.

public bool ResetOnSpace { get; set; }

Fields

NameDescription
AcceptsReturnPropertyDefines the Avalonia.Controls.TextBox.AcceptsReturn property Inherited from TextBox.
AcceptsTabPropertyDefines the Avalonia.Controls.TextBox.AcceptsTab property Inherited from TextBox.
AsciiOnlyPropertyNo summary available.
BackgroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
BoundsPropertyDefines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModePropertyDefines the Avalonia.Visual.CacheMode property. Inherited from Visual.
CanCopyPropertyDefines the Avalonia.Controls.TextBox.CanCopy property Inherited from TextBox.
CanCutPropertyDefines the Avalonia.Controls.TextBox.CanCut property Inherited from TextBox.
CanPastePropertyDefines the Avalonia.Controls.TextBox.CanPaste property Inherited from TextBox.
CanRedoPropertyDefines the Avalonia.Controls.TextBox.CanRedo property Inherited from TextBox.
CanUndoPropertyDefines the Avalonia.Controls.TextBox.CanUndo property Inherited from TextBox.
CaretBlinkIntervalPropertyDefines the Avalonia.Controls.TextBox.CaretBlinkInterval property Inherited from TextBox.
CaretBrushPropertyDefines the Avalonia.Controls.TextBox.CaretBrush property Inherited from TextBox.
CaretIndexPropertyDefines the Avalonia.Controls.TextBox.CaretIndex property Inherited from TextBox.
ClearSelectionOnLostFocusPropertyDefines the Avalonia.Controls.TextBox.ClearSelectionOnLostFocus property Inherited from TextBox.
ClipPropertyDefines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsPropertyDefines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
ContextCanceledEventProvides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextFlyoutPropertyDefines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuPropertyDefines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
ContextRequestedEventProvides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CopyingToClipboardEventDefines the Avalonia.Controls.TextBox.CopyingToClipboard event. Inherited from TextBox.
CornerRadiusPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
CulturePropertyNo summary available.
CursorPropertyGets or sets associated mouse cursor. Inherited from InputElement.
CuttingToClipboardEventDefines the Avalonia.Controls.TextBox.CuttingToClipboard event. Inherited from TextBox.
DataContextPropertyDefines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
DesiredSizePropertyDefines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
DoubleTappedEventDefines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
EffectPropertyDefines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionPropertyDefines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
FocusablePropertyDefines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
FocusAdornerPropertyDefines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
FontFamilyPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStylePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
GettingFocusEventDefines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEventDefines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HasMirrorTransformPropertyDefines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
HeightPropertyDefines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HidePromptOnLeavePropertyNo summary available.
HoldingEventDefines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
HorizontalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
HorizontalContentAlignmentPropertyDefines the Avalonia.Layout.HorizontalAlignment property. Inherited from TextBox.
InnerLeftContentPropertyDefines the Avalonia.Controls.TextBox.InnerLeftContent property Inherited from TextBox.
InnerRightContentPropertyDefines the Avalonia.Controls.TextBox.InnerRightContent property Inherited from TextBox.
IsEffectivelyEnabledPropertyDefines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledPropertyDefines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedPropertyDefines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsHitTestVisiblePropertyDefines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldingEnabledPropertyDefines the IsHoldingEnabled attached property. Inherited from InputElement.
IsHoldWithMouseEnabledPropertyDefines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsInactiveSelectionHighlightEnabledPropertyDefines the Avalonia.Controls.TextBox.IsInactiveSelectionHighlightEnabled property Inherited from TextBox.
IsKeyboardFocusWithinPropertyDefines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsPointerOverPropertyDefines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsReadOnlyPropertyDefines the Avalonia.Controls.TextBox.IsReadOnly property Inherited from TextBox.
IsTabStopPropertyDefines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
IsTemplateFocusTargetPropertyDefines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
IsUndoEnabledPropertyDefines the Avalonia.Controls.TextBox.IsUndoEnabled property Inherited from TextBox.
IsVisiblePropertyDefines the Avalonia.Visual.IsVisible property. Inherited from Visual.
KeyDownEventDefines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEventDefines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LetterSpacingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
LineHeightPropertyDefines see Avalonia.Controls.Presenters.TextPresenter.LineHeight property. Inherited from TextBox.
LoadedEventDefines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
LosingFocusEventDefines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEventDefines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
MarginPropertyDefines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaskCompletedPropertyNo summary available.
MaskFullPropertyNo summary available.
MaskPropertyNo summary available.
MaxHeightPropertyDefines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxLengthPropertyDefines the Avalonia.Controls.TextBox.MaxLength property Inherited from TextBox.
MaxLinesPropertyDefines the Avalonia.Controls.TextBox.MaxLines property Inherited from TextBox.
MaxWidthPropertyDefines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MinHeightPropertyDefines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinLinesPropertyDefines the Avalonia.Controls.TextBox.MinLines property Inherited from TextBox.
MinWidthPropertyDefines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
NamePropertyDefines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
NewLinePropertyDefines the Avalonia.Controls.TextBox.NewLine property Inherited from TextBox.
OpacityMaskPropertyDefines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityPropertyDefines the Avalonia.Visual.Opacity property. Inherited from Visual.
PaddingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
ParentPropertyDefines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
PasswordCharPropertyDefines the Avalonia.Controls.TextBox.PasswordChar property Inherited from TextBox.
PastingFromClipboardEventDefines the Avalonia.Controls.TextBox.PastingFromClipboard event. Inherited from TextBox.
PinchEndedEventDefines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEventDefines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PlaceholderForegroundPropertyDefines the Avalonia.Controls.TextBox.PlaceholderForeground property. Inherited from TextBox.
PlaceholderTextPropertyDefines the Avalonia.Controls.TextBox.PlaceholderText property. Inherited from TextBox.
PointerCaptureLostEventDefines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEventDefines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEventDefines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEventDefines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEventDefines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEventDefines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEventDefines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PromptCharPropertyNo summary available.
PullGestureEndedEventDefines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEventDefines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RenderTransformOriginPropertyDefines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformPropertyDefines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
RequestBringIntoViewEventEvent raised when an element wishes to be scrolled into view. Inherited from Control.
ResetOnPromptPropertyNo summary available.
ResetOnSpacePropertyNo summary available.
RevealPasswordPropertyDefines the Avalonia.Controls.TextBox.RevealPassword property Inherited from TextBox.
RightTappedEventDefines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
ScrollGestureEndedEventDefines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEventDefines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEventDefines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
SelectionBrushPropertyDefines the Avalonia.Controls.TextBox.SelectionBrush property Inherited from TextBox.
SelectionEndPropertyDefines the Avalonia.Controls.TextBox.SelectionEnd property Inherited from TextBox.
SelectionForegroundBrushPropertyDefines the Avalonia.Controls.TextBox.SelectionForegroundBrush property Inherited from TextBox.
SelectionStartPropertyDefines the Avalonia.Controls.TextBox.SelectionStart property Inherited from TextBox.
SizeChangedEventDefines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
SwipeGestureEndedEventDefines the Avalonia.Input.InputElement.SwipeGestureEnded event. Inherited from InputElement.
SwipeGestureEventDefines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexPropertyDefines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TagPropertyDefines the Avalonia.Controls.Control.Tag property. Inherited from Control.
TappedEventDefines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TemplateAppliedEventDefines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplatedParentPropertyDefines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
TemplatePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
TextAlignmentPropertyDefines the Avalonia.Controls.TextBox.TextAlignment property Inherited from TextBox.
TextChangedEventDefines the Avalonia.Controls.TextBox.TextChanged event. Inherited from TextBox.
TextChangingEventDefines the Avalonia.Controls.TextBox.TextChanging event. Inherited from TextBox.
TextInputEventDefines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEventDefines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
TextPropertyDefines the Avalonia.Controls.TextBox.Text property Inherited from TextBox.
TextWrappingPropertyInherited from TextBox.
ThemePropertyDefines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.
UndoLimitPropertyDefines the Avalonia.Controls.TextBox.UndoLimit property Inherited from TextBox.
UnloadedEventDefines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
UseFloatingPlaceholderPropertyDefines the Avalonia.Controls.TextBox.UseFloatingPlaceholder property. Inherited from TextBox.
UseFloatingWatermarkPropertyDefines the Avalonia.Controls.TextBox.UseFloatingWatermark property. Inherited from TextBox.
UseLayoutRoundingPropertyDefines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
VerticalContentAlignmentPropertyDefines the Avalonia.Layout.VerticalAlignment property. Inherited from TextBox.
VisualParentPropertyDefines the Avalonia.Visual.VisualParent property. Inherited from Visual.
WatermarkForegroundPropertyDefines the Avalonia.Controls.TextBox.WatermarkForeground property. Inherited from TextBox.
WatermarkPropertyDefines the Avalonia.Controls.TextBox.Watermark property. Inherited from TextBox.
WidthPropertyDefines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
ZIndexPropertyDefines the Avalonia.Visual.ZIndex property. Inherited from Visual.

AsciiOnlyProperty Field

public Avalonia.StyledProperty<bool> AsciiOnlyProperty

CultureProperty Field

public Avalonia.StyledProperty<System.Globalization.CultureInfo> CultureProperty

HidePromptOnLeaveProperty Field

public Avalonia.StyledProperty<bool> HidePromptOnLeaveProperty

MaskCompletedProperty Field

public Avalonia.DirectProperty<Avalonia.Controls.MaskedTextBox, Nullable<bool>> MaskCompletedProperty

MaskFullProperty Field

public Avalonia.DirectProperty<Avalonia.Controls.MaskedTextBox, Nullable<bool>> MaskFullProperty

MaskProperty Field

public Avalonia.StyledProperty<string> MaskProperty

PromptCharProperty Field

public Avalonia.StyledProperty<char> PromptCharProperty

ResetOnPromptProperty Field

public Avalonia.StyledProperty<bool> ResetOnPromptProperty

ResetOnSpaceProperty Field

public Avalonia.StyledProperty<bool> ResetOnSpaceProperty

Events

NameDescription
ActualThemeVariantChangedRaised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement.
AttachedToLogicalTreeRaised when the styled element is attached to a rooted logical tree. Inherited from StyledElement.
AttachedToVisualTreeRaised when the control is attached to a rooted visual tree. Inherited from Visual.
ContextCanceledOccurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement.
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement.
CopyingToClipboardRaised when content is being copied to the clipboard Inherited from TextBox.
CuttingToClipboardRaised when content is being cut to the clipboard Inherited from TextBox.
DataContextChangedOccurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement.
DetachedFromLogicalTreeRaised when the styled element is detached from a rooted logical tree. Inherited from StyledElement.
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree. Inherited from Visual.
DoubleTappedOccurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement.
EffectiveViewportChangedOccurs when the element's effective viewport changes. Inherited from Layoutable.
GettingFocusOccurs before the control receives focus. Inherited from InputElement.
GotFocusOccurs when the control receives focus. Inherited from InputElement.
HoldingOccurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement.
InitializedOccurs when the styled element has finished initialization. Inherited from StyledElement.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from InputElement.
KeyUpOccurs when a key is released while the control has focus. Inherited from InputElement.
LayoutUpdatedOccurs when a layout pass completes for the control. Inherited from Layoutable.
LoadedOccurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
LosingFocusOccurs before the control loses focus. Inherited from InputElement.
LostFocusOccurs when the control loses focus. Inherited from InputElement.
PastingFromClipboardRaised when content is being pasted from the clipboard Inherited from TextBox.
PinchOccurs when the user moves two contact points closer together. Inherited from InputElement.
PinchEndedOccurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement.
PointerCaptureLostOccurs 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.
PointerEnteredOccurs when the pointer enters the control. Inherited from InputElement.
PointerExitedOccurs when the pointer leaves the control. Inherited from InputElement.
PointerMovedOccurs when the pointer moves over the control. Inherited from InputElement.
PointerPressedOccurs when the pointer is pressed over the control. Inherited from InputElement.
PointerReleasedOccurs when the pointer is released over the control. Inherited from InputElement.
PointerTouchPadGestureMagnifyOccurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement.
PointerTouchPadGestureRotateOccurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement.
PointerTouchPadGestureSwipeOccurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement.
PointerWheelChangedOccurs when the mouse is scrolled over the control. Inherited from InputElement.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.
PullGestureOccurs when the user drags from the edge of a control. Inherited from InputElement.
PullGestureEndedOccurs when the user releases the pointer after a pull gesture. Inherited from InputElement.
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
RightTappedOccurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement.
ScrollGestureOccurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement.
ScrollGestureEndedOccurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement.
ScrollGestureInertiaStartingOccurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement.
SizeChangedOccurs when the bounds (actual size) of the control have changed. Inherited from Control.
SwipeGestureOccurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement.
SwipeGestureEndedOccurs when a swipe gesture ends on the control. Inherited from InputElement.
TappedOccurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement.
TemplateAppliedRaised when the control's template is applied. Inherited from TemplatedControl.
TextChangedOccurs asynchronously after text changes and the new text is rendered. Inherited from TextBox.
TextChangingOccurs synchronously when text starts to change but before it is rendered. Inherited from TextBox.
TextInputOccurs when a user typed some text while the control has focus. Inherited from InputElement.
TextInputMethodClientRequestedOccurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement.
UnloadedOccurs when the control is removed from the visual tree. Inherited from Control.