FixedMaskedTextProvider.IHandler
Handler interface for implementations of the FixedMaskedTextProvider.
Properties
AllowPromptAsInput
#Gets a value indicating whether the PromptChar can be a valid input character by the user.
Value:
true to allow prompt as input; otherwise, false.AsciiOnly
#Gets a value indicating whether the input only accepts ascii characters A-Z or a-z.
Value:
true if only ASCII characters are accepted; otherwise, false.AutoAdvance
#Gets or sets a value indicating that the cursor position will advance past literals to the next available edit position automatically.
Value:
true to auto advance past literals; otherwise, false.EditPositions
Gets an enumeration of all valid edit positions in the mask.
IncludeLiterals
#Gets or sets a value indicating that the FixedMaskedTextProvider.Text property includes literals in the mask.
Value:
true to include literals; otherwise, false.IncludePrompt
#Gets or sets a value indicating that the FixedMaskedTextProvider.Text property includes prompt characters for each edit position in the mask.
Value:
true to include prompt; otherwise, false.IsEmpty
Gets a value indicating the mask is empty with no characters filled out.
Value:
true if the mask value is empty; otherwise, false.IsPassword
#Gets or sets a value indicating whether the mask should be password protected.
Value:
true if this instance is password; otherwise, false.MaskCompleted
Gets a value indicating whether the mask has all required text to pass its validation.
Value:
true if mask is completed; otherwise, false.MaskFull
#Gets a value indicating that all available edit positions in the mask have been filled out.
Value:
true if mask the mask is full; otherwise, false.PasswordChar
#In password mode, gets or sets the character to show for filled edit characters in the mask.
SkipLiterals
#Gets or sets a value indicating that the user can type literals to skip them in the mask.
Value:
true to allow the user to enter literals to skip them; otherwise, false.Text
Gets or sets the text, usually excluding prompt or literal characters depending on the mask provider.
Methods
Clear
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 IMaskedTextProvider.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.CommitText
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.
Create
#Called when a new instance of the FixedMaskedTextProvider is created
Parameters:
| mask (string) | Mask for the input. See Mask for mask format. |
| culture (CultureInfo) | Culture to format date/time separators and numeric placeholders. |
| allowPromptAsInput (bool) | If set to true, then allow the PromptChar as valid input. |
| restrictToAscii (bool) | If set to true, restrict input characters to ASCII only (a-z or A-Z). |
Delete
Called to delete a range of characters at the specified position in the masked text.
Insert
Called to insert a character at the specified position in the masked text.
Returns:
true when the insertion was successful, or false if it failed.Replace
Called to replace a character at the specified position in the masked text.
Returns:
true when the replacement was successful, or false if it failed.