MaskedTextStepper Class

Text box with masking capabilities.

Inheritance Hierarchy

SystemObject
  EtoWidget
    Eto.FormsBindableWidget
      Eto.FormsControl
        Eto.FormsCommonControl
          Eto.FormsTextControl
            Eto.FormsTextBox
              Eto.FormsTextStepper
                Eto.FormsMaskedTextStepper
                  Eto.FormsMaskedTextStepperT

Namespace: Eto.Forms
Assembly: Eto (in Eto.dll) Version: 2.5.3-dev

Syntax

Copy

[ContentPropertyAttribute("Provider")]
public class MaskedTextStepper : TextStepper

<ContentPropertyAttribute("Provider")>
Public Class MaskedTextStepper
	Inherits TextStepper

[<ContentPropertyAttribute("Provider")>]
type MaskedTextStepper =  
    class
        inherit TextStepper
    end

The MaskedTextStepper type exposes the following members.

Constructors

	Name	Description
	MaskedTextStepper	Initializes a new instance of the MaskedTextStepper class.
	MaskedTextStepper(IMaskedTextProvider)	Initializes a new instance of the MaskedTextStepper class with the specified masked text provider.

Top

Properties

	Name	Description
	InsertMode	Gets or sets the mode for insertion. Use IsOverwrite to determine the current mode.
	IsOverwrite	Gets a value indicating whether typing will overwrite text.
	MaskCompleted	Gets a value indicating whether the mask is completed.
	Provider	Gets or sets the masked text provider to specify the mask format.
	ShowPlaceholderWhenEmpty	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	Gets or sets the mode for when the input prompts should be shown
	ShowPromptOnFocus	Obsolete. Gets or sets a value indicating that the prompt characters should only be shown when the control has focus.
	Text	Gets or sets the text of the control including any mask characters. (Overrides TextControlText.)

Top

Methods

	Name	Description
	OnGotFocus	Raises the GotFocus event. (Overrides ControlOnGotFocus(EventArgs).)
	OnKeyDown	Raises the KeyDown event. (Overrides ControlOnKeyDown(KeyEventArgs).)
	OnLoadComplete	Raises the LoadComplete event. (Overrides ControlOnLoadComplete(EventArgs).)
	OnLostFocus	Raises the LostFocus event. (Overrides ControlOnLostFocus(EventArgs).)
	OnTextChanged	Raises the TextChanged event. (Overrides TextControlOnTextChanged(EventArgs).)
	OnTextChanging	Raises the TextChanging event. (Overrides TextBoxOnTextChanging(TextChangingEventArgs).)
	UpdateText	Updates the text to the display text from the provider.

Top

Remarks

This uses the IMaskedTextProvider 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. 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 NumericMaskedTextBoxT 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.

Reference

Eto.Forms Namespace