Version

MaskInput Property (UltraNumericEditorBase)

Returns or sets the input mask used by the control.
Syntax
'Declaration
 
Public Overridable Property MaskInput As String
public virtual string MaskInput {get; set;}
Remarks

When inputting data, placeholder characters are displayed, and the user can only replace a placeholder with a character that is of the same type as the one specified in the input mask. The control can distinguish between numeric and alphabetic characters for validation, but cannot validate for valid content, such as the correct month or time of day.

When data masking is enabled, the MaskClipMode property determines how the control's contents are copied to the clipboard, the MaskDataMode property specifies how the control's contents are returned by the Value property, and the MaskDisplayMode property indicates how cell values are displayed.

Character

Description
{double:i.f:c} {double:i.f:c} is a place holder for a mask that allows floating point input where i and f in i.f specify the number of digits in the integer and fraction portions respectively. The :c portion of the mask is optional and it specifies that the inputting of the value should be done continous across fraction and integer portions. For example, with :c in the mask, in order to enter 12.34 the user types in "1234". Notice that the decimal separator character is missing. This allevietes the user from having to type in the decimal separator.
{double:-i.f:c} Same as {double:i.f:c} except this allows negative numbers.
{currency:i.f:c} Same as {double:i.f:c} except the mask is constructed based on currency formatting information of the underlying format provider or the culture. It typically has the currency symbol and also displays the group characters.
{currency:-i.f:c} Same as {currency:i.f:c} except this allows negative numbers.

.

Decimal placeholder. The actual character used is the one specified as the decimal placeholder by the system's international settings. This character is treated as a literal for masking purposes.

,

Thousands separator. The actual character used is the one specified as the thousands separator by the system's international settings. This character is treated as a literal for masking purposes.
- Minus sign when followed by a number section defined by series of 'n's (like in "-nn,nnn.nn") indicates that negative numbers are allowed. When not followed by a series of 'n's, it's taken as a literal. Minus sign will only be shown when the number is actually negative.
+ Plus sign when followed by a number section defined by series of 'n's (like in "-nn,nnn.nn") indicates that negative numbers are allowed. However, it differs from '-' in the respect that it will always show a '+' or a '-' sign depending on whether the number is positive or negative.
n Digit placeholder. A group of n's can be used to create a numeric section where numbers are entered from right to left. Character must be numeric (0-9) but entry is not required.
Literal All other symbols are displayed as literals; that is, they appear as themselves.

Example
This example sets the masking-related properties of the UltraDateTimeEditor, UltraNumericEditor, and UltraCurrencyEditor controls.

Imports Infragistics.Win
Imports Infragistics.Win.UltraWinEditors

    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
        Me.SetupMasking()
    End Sub

    Private Sub SetupMasking()

        '	Set the UltraDateTimeEditor to display the 2-digit representation of the year
        Me.UltraDateTimeEditor1.MaskInput = "mm/dd/yy"

        '	Set the UltraNumericEditor to display a thousands separator
        Me.UltraNumericEditor1.MaskInput = "n,nnn,nnn"

        '	Set the UltraCurrencyEditor to display a thousands separator,
        '	and no currency symbol
        Me.UltraCurrencyEditor1.MaskInput = "n,nnn.nn"

        '	Set the masking modes of the UltraDateTimeEditor to include literals,
        '	because the "/" character is part of the data in that it separates the
        '	components of the date (year, month, day)
        Me.UltraDateTimeEditor1.MaskDataMode = MaskMode.IncludeLiterals
        Me.UltraDateTimeEditor1.MaskClipMode = MaskMode.IncludeLiterals
        Me.UltraDateTimeEditor1.MaskDisplayMode = MaskMode.IncludeLiterals

        '	For the UltraNumericEditor and UltraCurrencyEditor, we don't
        '	want the thousands separator to be considered part of the data,
        '	so set the MaskDataMode to Raw. For the clipboard and display,
        '	however, we will display the literals.
        Me.UltraNumericEditor1.MaskDataMode = MaskMode.Raw
        Me.UltraNumericEditor1.MaskClipMode = MaskMode.IncludeLiterals
        Me.UltraNumericEditor1.MaskDisplayMode = MaskMode.IncludeLiterals

        Me.UltraCurrencyEditor1.MaskDataMode = MaskMode.Raw
        Me.UltraCurrencyEditor1.MaskClipMode = MaskMode.IncludeLiterals
        Me.UltraCurrencyEditor1.MaskDisplayMode = MaskMode.IncludeLiterals

        '	Set the PromptChar to the space character for all
        Me.UltraDateTimeEditor1.PromptChar = Chr(32)
        Me.UltraNumericEditor1.PromptChar = Chr(32)
        Me.UltraCurrencyEditor1.PromptChar = Chr(32)

    End Sub
using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinEditors;

		private void button1_Click(object sender, System.EventArgs e)
		{
			this.SetupMasking();
		}

		private void SetupMasking()
		{
			//	Set the UltraDateTimeEditor to display the 2-digit representation of the year
			this.ultraDateTimeEditor1.MaskInput = "mm/dd/yy";

			//	Set the UltraNumericEditor to display a thousands separator
			this.ultraNumericEditor1.MaskInput = "n,nnn,nnn";

			//	Set the UltraCurrencyEditor to display a thousands separator,
			//	and no currency symbol
			this.ultraCurrencyEditor1.MaskInput = "n,nnn.nn";

			//	Set the masking modes of the UltraDateTimeEditor to include literals,
			//	because the "/" character is part of the data in that it separates the
			//	components of the date (year, month, day)
			this.ultraDateTimeEditor1.MaskDataMode = MaskMode.IncludeLiterals;
			this.ultraDateTimeEditor1.MaskClipMode = MaskMode.IncludeLiterals;
			this.ultraDateTimeEditor1.MaskDisplayMode = MaskMode.IncludeLiterals;

			//	For the UltraNumericEditor and UltraCurrencyEditor, we don't
			//	want the thousands separator to be considered part of the data,
			//	so set the MaskDataMode to Raw. For the clipboard and display,
			//	however, we will display the literals.
			this.ultraNumericEditor1.MaskDataMode = MaskMode.Raw;			
			this.ultraNumericEditor1.MaskClipMode = MaskMode.IncludeLiterals;
			this.ultraNumericEditor1.MaskDisplayMode = MaskMode.IncludeLiterals;

			this.ultraCurrencyEditor1.MaskDataMode = MaskMode.Raw;			
			this.ultraCurrencyEditor1.MaskClipMode = MaskMode.IncludeLiterals;
			this.ultraCurrencyEditor1.MaskDisplayMode = MaskMode.IncludeLiterals;

			//	Set the PromptChar to the space character for all
			this.ultraDateTimeEditor1.PromptChar = ' ';
			this.ultraNumericEditor1.PromptChar = ' ';
			this.ultraCurrencyEditor1.PromptChar = ' ';

		}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also