IMaskedTextProvider

References
public interface IMaskedTextProvider
Interface for a masked text provider that can be used with MaskedTextBox.
Remarks: This defines the interface that the MaskedTextBox uses when inserting, deleting, and clearing characters from a masked string. This can be implemented by both variable and fixed masks (unlike the standard System.ComponentModel.MaskedTextProvider), and provides a way to create your own completely custom masks. You can also use the VariableMaskedTextProvider as a base for custom masks to implement the default functionality.

Properties

DisplayText

#
string DisplayText { get; }
Gets the display text, including prompt characters.
Value: The display text.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:59

EditPositions

#
IEnumerable<int> EditPositions { get; }
Gets an enumeration of all valid edit positions in the mask.
Value: The valid edit positions.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:77

IsEmpty

#
bool IsEmpty { get; }
Gets a value indicating the mask is empty with no characters filled out.
Value: true if the mask value is empty; otherwise, false.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:83

MaskCompleted

#
bool MaskCompleted { get; }
Gets a value indicating whether the mask has all required text to pass its validation.
Value: true if mask is completed; otherwise, false.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:71

Text

#
string Text { get; set; }
Gets or sets the text, usually excluding prompt or literal characters depending on the mask provider.
Value: The text.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:65

Methods

Clear

#
bool Clear(ref int position, int length, bool forward)
Called to clear a range of characters at the specified position in the masked text.
Remarks: The cleared characters usually show the prompt character after cleared. This is useful for fixed length mask providers. For variable length, this is usually the same as calling Delete(int, int, bool).
Parameters:
position (ref int)Position to clear at.
length (int)Length of text (in the mask) to clear
forward (bool)true to delete the text forward, or false to delete backward
Returns: true when the deletion was successful, or false if it failed.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:53

CommitText

#Since v2.12
void CommitText()
Called to update the display text after changes to the mask value.
Remarks: This is called after user changes to the mask value is complete, such as when the control loses focus, or when the user presses enter. This allows the mask provider to update the display text after changes are made to the value, while still allowing the user to type in the text without it changing until they are done.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:94

Delete

#
bool Delete(ref int position, int length, bool forward)
Called to delete a range of characters at the specified position in the masked text.
Parameters:
position (ref int)Position to delete at.
length (int)Length of text (in the mask) to delete
forward (bool)true to delete the text forward, or false to delete backward
Returns: true when the deletion was successful, or false if it failed.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:39

Insert

#
bool Insert(char character, ref int position)
Called to insert a character at the specified position in the masked text.
Parameters:
character (char)Character to insert.
position (ref int)Position to insert at.
Returns: true when the insertion was successful, or false if it failed.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:22

Replace

#
bool Replace(char character, ref int position)
Called to replace a character at the specified position in the masked text.
Parameters:
character (char)Character to insert.
position (ref int)Position to insert at.
Returns: true when the replacement was successful, or false if it failed.
https://github.com/picoe/Eto/blob/fc8395dc3630c1ea5e1b1e8cb900e9cfb80c800e/src/Eto/Forms/MaskedTextProvider/IMaskedTextProvider.cs:30