TextMaskFormat Property

While working with RadMaskedEditBox you may come to a case where you want to get a Value that differs from what the end-user sees in the editor, or, in other words, from what the Text property provides. In such cases the you will find the TextMaskFormat property useful. It allows you to get variations of the Text property value taking into account whether you want to get the prompt characters, and the literals used in the mask. The type of the TextMaskFormat property is the MaskFormat enum which provides the following values:

• IncludePromptAndLiterals (default value): The Value property returns Return the text input by the user as well as any literal characters defined in the mask and any instances of the prompt character.

• ExcludePromptAndLiterals: The Value property returns only the text input by the user.

• IncludePrompt: The Value property returns the text input by the user as well as any instances of the prompt character.

• IncludeLiterals: The Value property returns the text input by the user as well as any literal characters defined in the mask.

Let's now analyze how this property works in the context of several popular masks.

Using Phone mask

1. First, we need to define our mask:

this.radMaskedEditBox1.MaskType = Telerik.WinControls.UI.MaskType.Standard;
this.radMaskedEditBox1.Mask = "[phone]";
this.radMaskedEditBox1.PromptChar = '_';

Me.RadMaskedEditBox1.MaskType = Telerik.WinControls.UI.MaskType.Standard
Me.RadMaskedEditBox1.Mask = "[phone]"
Me.RadMaskedEditBox1.PromptChar = "_"

2. Then, let's assume that the user types "123123123". As you can notice, the number of digits is smaller than the provided prompt places by one and this is for demonstration purposes. The result in the UI of RadMaskedEditBox will look like this:

So, here we have:

• An instance of the prompt character '_'

• Literals: '(' , ')', '-' and ' ' (empty space)

• User input: "123123123"

And here is what the Value property of RadMaskedEditBox will return depending on the TextMaskFormat value:

• IncludePromptAndLiterals: (123) 123-123_

• ExcludePromptAndLiterals: 123123123

• IncludePrompt: 123123123_

• IncludeLiterals: (123) 123-123

Using Currency mask

1. Define the Current mask as show below:

this.radMaskedEditBox1.MaskType = Telerik.WinControls.UI.MaskType.Numeric;
this.radMaskedEditBox1.Mask = "C2";

Me.RadMaskedEditBox1.MaskType = Telerik.WinControls.UI.MaskType.Numeric
Me.RadMaskedEditBox1.Mask = "C2"

2. Now, assume that the user types "-1234.12". The UI of RadMaskedEditBox in this case look like this:

So, here we have:

• Literals: '$' and ','

• '-' and '.' are not considered literals, because they are a part of the real decimal value.

• We do not have prompt characters in the Currency mask.

And here is what the Value property of RadMaskedEditBox will return depending on the TextMaskFormat value:

• IncludePromptAndLiterals: -$1,234.12

• ExcludePromptAndLiterals: -1234.12

• IncludePrompt: -1234.12

• IncludeLiterals: -$1,234.12

See Also

• Working with RadMaskedEditBox