# MaskedTextStepper class

Namespace: [Eto.Forms](https://eto.picoe.ca/api/namespace/eto.forms.md) · Assembly: [Eto](https://eto.picoe.ca/api/assembly/eto.md)

```cs
[ContentProperty("Provider")]
public class MaskedTextStepper : TextStepper
```

Text box with masking capabilities.

**Remarks:** This uses the [IMaskedTextProvider](https://eto.picoe.ca/api/type/eto.forms.imaskedtextprovider.md) as its interface to the mask. The mask can implement any format it wishes, including both fixed or variable length masks. The MaskedTextStepper allows you to mask, or limit which characters can be entered in the text box with either a fixed, variable, or custom mask. A fixed mask can be a phone number, postal code, or something that requires a specific format and can be created using the [FixedMaskedTextProvider](https://eto.picoe.ca/api/type/eto.forms.fixedmaskedtextprovider.md). A variable mask limits which characters can be entered but is not limited to a fixed number of characters. An implementation of a variable mask is the [NumericMaskedTextBox<T>](https://eto.picoe.ca/api/type/eto.forms.numericmaskedtextbox-1.md) which allows you to enter only numeric values in a text box, and places the positive / negative symbol at the beginning regardless of where you type it.

**Derived types:** [MaskedTextStepper<T>](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper-1.md)

## Constructors

- [MaskedTextStepper](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/ctor.md): (2 overloads) Initializes a new instance of the [MaskedTextStepper](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper.md) class.

## Properties

- [AutoSelectEditableRanges](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/autoselecteditableranges.md): Gets or sets a value indicating whether editable mask ranges should be selected automatically.
- [InsertMode](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/insertmode.md): Gets or sets the mode for insertion. Use [MaskedTextStepper.IsOverwrite](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/isoverwrite.md) to determine the current mode.
- [IsOverwrite](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/isoverwrite.md): Gets a value indicating whether typing will overwrite text.
- [MaskCompleted](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/maskcompleted.md): Gets a value indicating whether the mask is completed.
- [Provider](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/provider.md): Gets or sets the masked text provider to specify the mask format.
- [ShowPlaceholderWhenEmpty](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/showplaceholderwhenempty.md): Gets or sets a value indicating that the placeholder should be shown when the mask is empty and the control does not have focus.
- [ShowPromptMode](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/showpromptmode.md): Gets or sets the mode for when the input prompts should be shown
- [ShowPromptOnFocus](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/showpromptonfocus.md): (obsolete) Gets or sets a value indicating that the prompt characters should only be shown when the control has focus.
- [Text](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/text.md): Gets or sets the text of the control including any mask characters.

## Methods

- [CommitText](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/committext.md): Commits the text to the provider and updates the display text.
- [OnGotFocus](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/ongotfocus.md): Raises the [Control.GotFocus](https://eto.picoe.ca/api/type/eto.forms.control/gotfocus.md) event.
- [OnKeyDown](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/onkeydown.md): Raises the [Control.KeyDown](https://eto.picoe.ca/api/type/eto.forms.control/keydown.md) event.
- [OnLoadComplete](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/onloadcomplete.md): Raises the [Control.LoadComplete](https://eto.picoe.ca/api/type/eto.forms.control/loadcomplete.md) event.
- [OnLostFocus](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/onlostfocus.md): Raises the [Control.LostFocus](https://eto.picoe.ca/api/type/eto.forms.control/lostfocus.md) event.
- [OnMouseUp](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/onmouseup.md): Raises the [Control.MouseUp](https://eto.picoe.ca/api/type/eto.forms.control/mouseup.md) event.
- [OnTextChanged](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/ontextchanged.md): Raises the [TextControl.TextChanged](https://eto.picoe.ca/api/type/eto.forms.textcontrol/textchanged.md) event.
- [OnTextChanging](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/ontextchanging.md): Raises the [TextBox.TextChanging](https://eto.picoe.ca/api/type/eto.forms.textbox/textchanging.md) event.
- [SelectEditableRangeAt](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/selecteditablerangeat.md): Selects the editable range at the specified index.
- [UpdateText](https://eto.picoe.ca/api/type/eto.forms.maskedtextstepper/updatetext.md): Updates the text to the display text from the provider.

## Inherited Members

- From [TextStepper](https://eto.picoe.ca/api/type/eto.forms.textstepper.md): [ShowStepper](https://eto.picoe.ca/api/type/eto.forms.textstepper/showstepper.md), [ValidDirection](https://eto.picoe.ca/api/type/eto.forms.textstepper/validdirection.md), [Step](https://eto.picoe.ca/api/type/eto.forms.textstepper/step.md), [GetCallback](https://eto.picoe.ca/api/type/eto.forms.textstepper/getcallback.md), [OnStep](https://eto.picoe.ca/api/type/eto.forms.textstepper/onstep.md)
- From [TextBox](https://eto.picoe.ca/api/type/eto.forms.textbox.md): [AlwaysShowSelection](https://eto.picoe.ca/api/type/eto.forms.textbox/alwaysshowselection.md), [AutoSelectMode](https://eto.picoe.ca/api/type/eto.forms.textbox/autoselectmode.md), [CaretIndex](https://eto.picoe.ca/api/type/eto.forms.textbox/caretindex.md), [MaxLength](https://eto.picoe.ca/api/type/eto.forms.textbox/maxlength.md), [PlaceholderText](https://eto.picoe.ca/api/type/eto.forms.textbox/placeholdertext.md), [ReadOnly](https://eto.picoe.ca/api/type/eto.forms.textbox/readonly.md), [SelectedText](https://eto.picoe.ca/api/type/eto.forms.textbox/selectedtext.md), [Selection](https://eto.picoe.ca/api/type/eto.forms.textbox/selection.md), [ShowBorder](https://eto.picoe.ca/api/type/eto.forms.textbox/showborder.md), [TextAlignment](https://eto.picoe.ca/api/type/eto.forms.textbox/textalignment.md), [ReadOnlyChanged](https://eto.picoe.ca/api/type/eto.forms.textbox/readonlychanged.md), [TextChanging](https://eto.picoe.ca/api/type/eto.forms.textbox/textchanging.md), [GetCharacterIndex](https://eto.picoe.ca/api/type/eto.forms.textbox/getcharacterindex.md), [OnReadOnlyChanged](https://eto.picoe.ca/api/type/eto.forms.textbox/onreadonlychanged.md), [SelectAll](https://eto.picoe.ca/api/type/eto.forms.textbox/selectall.md)
- From [TextControl](https://eto.picoe.ca/api/type/eto.forms.textcontrol.md): [TextBinding](https://eto.picoe.ca/api/type/eto.forms.textcontrol/textbinding.md), [TextColor](https://eto.picoe.ca/api/type/eto.forms.textcontrol/textcolor.md), [TextChanged](https://eto.picoe.ca/api/type/eto.forms.textcontrol/textchanged.md)
- From [CommonControl](https://eto.picoe.ca/api/type/eto.forms.commoncontrol.md): [Font](https://eto.picoe.ca/api/type/eto.forms.commoncontrol/font.md)
- From [Control](https://eto.picoe.ca/api/type/eto.forms.control.md): [AllowDrop](https://eto.picoe.ca/api/type/eto.forms.control/allowdrop.md), [BackgroundColor](https://eto.picoe.ca/api/type/eto.forms.control/backgroundcolor.md), [Bounds](https://eto.picoe.ca/api/type/eto.forms.control/bounds.md), [ContextMenu](https://eto.picoe.ca/api/type/eto.forms.control/contextmenu.md), [Cursor](https://eto.picoe.ca/api/type/eto.forms.control/cursor.md), [Enabled](https://eto.picoe.ca/api/type/eto.forms.control/enabled.md), [Gestures](https://eto.picoe.ca/api/type/eto.forms.control/gestures.md), [Handler](https://eto.picoe.ca/api/type/eto.forms.control/handler.md), [HasFocus](https://eto.picoe.ca/api/type/eto.forms.control/hasfocus.md), [Height](https://eto.picoe.ca/api/type/eto.forms.control/height.md), [IsAttached](https://eto.picoe.ca/api/type/eto.forms.control/isattached.md), [IsMouseCaptured](https://eto.picoe.ca/api/type/eto.forms.control/ismousecaptured.md), [IsSuspended](https://eto.picoe.ca/api/type/eto.forms.control/issuspended.md), [IsVisualControl](https://eto.picoe.ca/api/type/eto.forms.control/isvisualcontrol.md), [Loaded](https://eto.picoe.ca/api/type/eto.forms.control/loaded.md), [Location](https://eto.picoe.ca/api/type/eto.forms.control/location.md), [LogicalParent](https://eto.picoe.ca/api/type/eto.forms.control/logicalparent.md), [Parent](https://eto.picoe.ca/api/type/eto.forms.control/parent.md), [ParentWindow](https://eto.picoe.ca/api/type/eto.forms.control/parentwindow.md), [Size](https://eto.picoe.ca/api/type/eto.forms.control/size.md), [SupportedPlatformCommands](https://eto.picoe.ca/api/type/eto.forms.control/supportedplatformcommands.md), [TabIndex](https://eto.picoe.ca/api/type/eto.forms.control/tabindex.md), [TabStop](https://eto.picoe.ca/api/type/eto.forms.control/tabstop.md), [Tag](https://eto.picoe.ca/api/type/eto.forms.control/tag.md), [ToolTip](https://eto.picoe.ca/api/type/eto.forms.control/tooltip.md), [Visible](https://eto.picoe.ca/api/type/eto.forms.control/visible.md), [VisualControls](https://eto.picoe.ca/api/type/eto.forms.control/visualcontrols.md), [VisualParent](https://eto.picoe.ca/api/type/eto.forms.control/visualparent.md), [Width](https://eto.picoe.ca/api/type/eto.forms.control/width.md), [DragDrop](https://eto.picoe.ca/api/type/eto.forms.control/dragdrop.md), [DragEnd](https://eto.picoe.ca/api/type/eto.forms.control/dragend.md), [DragEnter](https://eto.picoe.ca/api/type/eto.forms.control/dragenter.md), [DragLeave](https://eto.picoe.ca/api/type/eto.forms.control/dragleave.md), [DragOver](https://eto.picoe.ca/api/type/eto.forms.control/dragover.md), [EnabledChanged](https://eto.picoe.ca/api/type/eto.forms.control/enabledchanged.md), [GotFocus](https://eto.picoe.ca/api/type/eto.forms.control/gotfocus.md), [KeyDown](https://eto.picoe.ca/api/type/eto.forms.control/keydown.md), [KeyUp](https://eto.picoe.ca/api/type/eto.forms.control/keyup.md), [Load](https://eto.picoe.ca/api/type/eto.forms.control/load.md), [LoadComplete](https://eto.picoe.ca/api/type/eto.forms.control/loadcomplete.md), [LostFocus](https://eto.picoe.ca/api/type/eto.forms.control/lostfocus.md), [MouseDoubleClick](https://eto.picoe.ca/api/type/eto.forms.control/mousedoubleclick.md), [MouseDown](https://eto.picoe.ca/api/type/eto.forms.control/mousedown.md), [MouseEnter](https://eto.picoe.ca/api/type/eto.forms.control/mouseenter.md), [MouseLeave](https://eto.picoe.ca/api/type/eto.forms.control/mouseleave.md), [MouseMove](https://eto.picoe.ca/api/type/eto.forms.control/mousemove.md), [MouseUp](https://eto.picoe.ca/api/type/eto.forms.control/mouseup.md), [MouseWheel](https://eto.picoe.ca/api/type/eto.forms.control/mousewheel.md), [PreLoad](https://eto.picoe.ca/api/type/eto.forms.control/preload.md), [Shown](https://eto.picoe.ca/api/type/eto.forms.control/shown.md), [SizeChanged](https://eto.picoe.ca/api/type/eto.forms.control/sizechanged.md), [TextInput](https://eto.picoe.ca/api/type/eto.forms.control/textinput.md), [ThemeChanged](https://eto.picoe.ca/api/type/eto.forms.control/themechanged.md), [UnLoad](https://eto.picoe.ca/api/type/eto.forms.control/unload.md), [ApplyStyles](https://eto.picoe.ca/api/type/eto.forms.control/applystyles.md), [AttachNative](https://eto.picoe.ca/api/type/eto.forms.control/attachnative.md), [CaptureMouse](https://eto.picoe.ca/api/type/eto.forms.control/capturemouse.md), [Detach](https://eto.picoe.ca/api/type/eto.forms.control/detach.md), [DetachNative](https://eto.picoe.ca/api/type/eto.forms.control/detachnative.md), [Dispose](https://eto.picoe.ca/api/type/eto.forms.control/dispose.md), [DoDragDrop](https://eto.picoe.ca/api/type/eto.forms.control/dodragdrop.md), [FindParent](https://eto.picoe.ca/api/type/eto.forms.control/findparent.md), [Focus](https://eto.picoe.ca/api/type/eto.forms.control/focus.md), [GetPreferredSize](https://eto.picoe.ca/api/type/eto.forms.control/getpreferredsize.md), [Invalidate](https://eto.picoe.ca/api/type/eto.forms.control/invalidate.md), [MapPlatformCommand](https://eto.picoe.ca/api/type/eto.forms.control/mapplatformcommand.md), [OnApplyCascadingStyles](https://eto.picoe.ca/api/type/eto.forms.control/onapplycascadingstyles.md), [OnDragDrop](https://eto.picoe.ca/api/type/eto.forms.control/ondragdrop.md), [OnDragEnd](https://eto.picoe.ca/api/type/eto.forms.control/ondragend.md), [OnDragEnter](https://eto.picoe.ca/api/type/eto.forms.control/ondragenter.md), [OnDragLeave](https://eto.picoe.ca/api/type/eto.forms.control/ondragleave.md), [OnDragOver](https://eto.picoe.ca/api/type/eto.forms.control/ondragover.md), [OnEnabledChanged](https://eto.picoe.ca/api/type/eto.forms.control/onenabledchanged.md), [OnKeyUp](https://eto.picoe.ca/api/type/eto.forms.control/onkeyup.md), [OnLoad](https://eto.picoe.ca/api/type/eto.forms.control/onload.md), [OnMouseDoubleClick](https://eto.picoe.ca/api/type/eto.forms.control/onmousedoubleclick.md), [OnMouseDown](https://eto.picoe.ca/api/type/eto.forms.control/onmousedown.md), [OnMouseEnter](https://eto.picoe.ca/api/type/eto.forms.control/onmouseenter.md), [OnMouseLeave](https://eto.picoe.ca/api/type/eto.forms.control/onmouseleave.md), [OnMouseMove](https://eto.picoe.ca/api/type/eto.forms.control/onmousemove.md), [OnMouseWheel](https://eto.picoe.ca/api/type/eto.forms.control/onmousewheel.md), [OnPreLoad](https://eto.picoe.ca/api/type/eto.forms.control/onpreload.md), [OnShown](https://eto.picoe.ca/api/type/eto.forms.control/onshown.md), [OnSizeChanged](https://eto.picoe.ca/api/type/eto.forms.control/onsizechanged.md), [OnStyleChanged](https://eto.picoe.ca/api/type/eto.forms.control/onstylechanged.md), [OnTextInput](https://eto.picoe.ca/api/type/eto.forms.control/ontextinput.md), [OnThemeChanged](https://eto.picoe.ca/api/type/eto.forms.control/onthemechanged.md), [OnUnLoad](https://eto.picoe.ca/api/type/eto.forms.control/onunload.md), [PointFromScreen](https://eto.picoe.ca/api/type/eto.forms.control/pointfromscreen.md), [PointToScreen](https://eto.picoe.ca/api/type/eto.forms.control/pointtoscreen.md), [Print](https://eto.picoe.ca/api/type/eto.forms.control/print.md), [RectangleFromScreen](https://eto.picoe.ca/api/type/eto.forms.control/rectanglefromscreen.md), [RectangleToScreen](https://eto.picoe.ca/api/type/eto.forms.control/rectangletoscreen.md), [ReleaseMouseCapture](https://eto.picoe.ca/api/type/eto.forms.control/releasemousecapture.md), [ResumeLayout](https://eto.picoe.ca/api/type/eto.forms.control/resumelayout.md), [SuspendLayout](https://eto.picoe.ca/api/type/eto.forms.control/suspendlayout.md), [TriggerStyleChanged](https://eto.picoe.ca/api/type/eto.forms.control/triggerstylechanged.md), [UpdateLayout](https://eto.picoe.ca/api/type/eto.forms.control/updatelayout.md)
- From [BindableWidget](https://eto.picoe.ca/api/type/eto.forms.bindablewidget.md): [Bindings](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/bindings.md), [DataContext](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/datacontext.md), [IsDataContextChanging](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/isdatacontextchanging.md), [Parents](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/parents.md), [DataContextChanged](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/datacontextchanged.md), [OnDataContextChanged](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/ondatacontextchanged.md), [Unbind](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/unbind.md), [UpdateBindings](https://eto.picoe.ca/api/type/eto.forms.bindablewidget/updatebindings.md)
- From [Widget](https://eto.picoe.ca/api/type/eto.widget.md): [ControlObject](https://eto.picoe.ca/api/type/eto.widget/controlobject.md), [ID](https://eto.picoe.ca/api/type/eto.widget/id.md), [IsDisposed](https://eto.picoe.ca/api/type/eto.widget/isdisposed.md), [NativeHandle](https://eto.picoe.ca/api/type/eto.widget/nativehandle.md), [Platform](https://eto.picoe.ca/api/type/eto.widget/platform.md), [Properties](https://eto.picoe.ca/api/type/eto.widget/properties.md), [Style](https://eto.picoe.ca/api/type/eto.widget/style.md), [StyleChanged](https://eto.picoe.ca/api/type/eto.widget/stylechanged.md), [Dispose](https://eto.picoe.ca/api/type/eto.widget/dispose.md), [Initialize](https://eto.picoe.ca/api/type/eto.widget/initialize.md), [ToString](https://eto.picoe.ca/api/type/eto.widget/tostring.md)