MaskedTextBox Class

Uses a mask to distinguish between proper and improper user input.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[DefaultBindingPropertyAttribute("Text")]
public class MaskedTextBox : TextBoxBase

The MaskedTextBox type exposes the following members.

  NameDescription
Public methodMaskedTextBox()Initializes a new instance of the MaskedTextBox class using defaults.
Public methodMaskedTextBox(MaskedTextProvider)Initializes a new instance of the MaskedTextBox class using the specified custom mask language provider.
Public methodMaskedTextBox(String)Initializes a new instance of the MaskedTextBox class using the specified input mask.
Top

  NameDescription
Public propertyAcceptsTabGets or sets a value determining how TAB keys are handled for multiline configurations. This property is not supported by MaskedTextBox.
Public propertyAccessibilityObjectGets the AccessibleObject assigned to the control. (Inherited from Control.)
Public propertyAccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. (Inherited from Control.)
Public propertyAccessibleDescriptionGets or sets the description of the control used by accessibility client applications. (Inherited from Control.)
Public propertyAccessibleNameGets or sets the name of the control used by accessibility client applications. (Inherited from Control.)
Public propertyAccessibleRoleGets or sets the accessible role of the control (Inherited from Control.)
Public propertyAllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. (Inherited from Control.)
Public propertyAllowPromptAsInputGets or sets a value indicating whether PromptChar can be entered as valid data by the user.
Public propertyAnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. (Inherited from Control.)
Public propertyAsciiOnlyGets or sets a value indicating whether the MaskedTextBox control accepts characters outside of the ASCII character set.
Public propertyAutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView. (Inherited from Control.)
Public propertyAutoSizeGets or sets a value indicating whether the height of the control automatically adjusts when the font assigned to the control is changed. (Inherited from TextBoxBase.)
Public propertyBackColorGets or sets the background color of the control. (Inherited from TextBoxBase.)
Public propertyBackgroundImageInfrastructure. This property is not relevant for this class. (Inherited from TextBoxBase.)
Public propertyBackgroundImageLayoutInfrastructure. This property is not relevant for this class. (Inherited from TextBoxBase.)
Public propertyBeepOnErrorGets or sets a value indicating whether the masked text box control raises the system beep for each user key stroke that it rejects.
Public propertyBindingContextGets or sets the BindingContext for the control. (Inherited from Control.)
Public propertyBorderStyleGets or sets the border type of the text box control. (Inherited from TextBoxBase.)
Public propertyBottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. (Inherited from Control.)
Public propertyBoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. (Inherited from Control.)
Protected propertyCanEnableImeGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. (Inherited from TextBoxBase.)
Public propertyCanFocusGets a value indicating whether the control can receive focus. (Inherited from Control.)
Protected propertyCanRaiseEventsDetermines if events can be raised on the control. (Inherited from Control.)
Public propertyCanSelectGets a value indicating whether the control can be selected. (Inherited from Control.)
Public propertyCanUndoGets a value indicating whether the user can undo the previous operation. This property is not supported by MaskedTextBox.
Public propertyCaptureGets or sets a value indicating whether the control has captured the mouse. (Inherited from Control.)
Public propertyCausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. (Inherited from Control.)
Public propertyClientRectangleGets the rectangle that represents the client area of the control. (Inherited from Control.)
Public propertyClientSizeGets or sets the height and width of the client area of the control. (Inherited from Control.)
Public propertyCompanyNameGets the name of the company or creator of the application containing the control. (Inherited from Control.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. (Inherited from Control.)
Public propertyContextMenuGets or sets the shortcut menu associated with the control. (Inherited from Control.)
Public propertyContextMenuStripGets or sets the ContextMenuStrip associated with this control. (Inherited from Control.)
Public propertyControlsGets the collection of controls contained within the control. (Inherited from Control.)
Public propertyCreatedGets a value indicating whether the control has been created. (Inherited from Control.)
Protected propertyCreateParamsGets the required creation parameters when the control handle is created. (Overrides TextBoxBase.CreateParams.)
Public propertyCultureGets or sets the culture information associated with the masked text box.
Public propertyCursorGets or sets the cursor that is displayed when the mouse pointer is over the control. (Inherited from Control.)
Public propertyCutCopyMaskFormatGets or sets a value that determines whether literals and prompt characters are copied to the clipboard.
Public propertyDataBindingsGets the data bindings for the control. (Inherited from Control.)
Protected propertyDefaultCursorGets or sets the default cursor for the control. (Inherited from TextBoxBase.)
Protected propertyDefaultImeModeGets the default Input Method Editor (IME) mode supported by the control. (Inherited from Control.)
Protected propertyDefaultMarginGets the space, in pixels, that is specified by default between controls. (Inherited from Control.)
Protected propertyDefaultMaximumSizeGets the length and height, in pixels, that is specified as the default maximum size of a control. (Inherited from Control.)
Protected propertyDefaultMinimumSizeGets the length and height, in pixels, that is specified as the default minimum size of a control. (Inherited from Control.)
Protected propertyDefaultPaddingGets the internal spacing, in pixels, of the contents of a control. (Inherited from Control.)
Protected propertyDefaultSizeGets the default size of the control. (Inherited from TextBoxBase.)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public propertyDisplayRectangleGets the rectangle that represents the display area of the control. (Inherited from Control.)
Public propertyDisposingGets a value indicating whether the base Control class is in the process of disposing. (Inherited from Control.)
Public propertyDockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. (Inherited from Control.)
Protected propertyDoubleBufferedInfrastructure. Gets or sets a value indicating whether control drawing is done in a buffer before the control is displayed. This property is not relevant for this class. (Inherited from TextBoxBase.)
Public propertyEnabledGets or sets a value indicating whether the control can respond to user interaction. (Inherited from Control.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyFocusedGets a value indicating whether the control has input focus. (Inherited from Control.)
Public propertyFontGets or sets the font of the text displayed by the control. (Inherited from Control.)
Protected propertyFontHeightGets or sets the height of the font of the control. (Inherited from Control.)
Public propertyForeColorGets or sets the foreground color of the control. (Inherited from TextBoxBase.)
Public propertyFormatProviderGets or sets the IFormatProvider to use when performing type validation.
Public propertyHandleGets the window handle that the control is bound to. (Inherited from Control.)
Public propertyHasChildrenGets a value indicating whether the control contains one or more child controls. (Inherited from Control.)
Public propertyHeightGets or sets the height of the control. (Inherited from Control.)
Public propertyHidePromptOnLeaveGets or sets a value indicating whether the prompt characters in the input mask are hidden when the masked text box loses focus.
Public propertyHideSelectionGets or sets a value indicating whether the selected text in the text box control remains highlighted when the control loses focus. (Inherited from TextBoxBase.)
Public propertyImeModeGets or sets the Input Method Editor (IME) mode of the control. (Inherited from Control.)
Protected propertyImeModeBaseGets or sets the Input Method Editor (IME) mode of a control. (Inherited from TextBoxBase.)
Public propertyInsertKeyModeGets or sets the text insertion mode of the masked text box control.
Public propertyInvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. (Inherited from Control.)
Public propertyIsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. (Inherited from Control.)
Public propertyIsDisposedGets a value indicating whether the control has been disposed of. (Inherited from Control.)
Public propertyIsHandleCreatedGets a value indicating whether the control has a handle associated with it. (Inherited from Control.)
Public propertyIsMirroredGets a value indicating whether the control is mirrored. (Inherited from Control.)
Public propertyIsOverwriteModeGets a value that specifies whether new user input overwrites existing input.
Public propertyLayoutEngineGets a cached instance of the control's layout engine. (Inherited from Control.)
Public propertyLeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area. (Inherited from Control.)
Public propertyLinesGets or sets the lines of text in multiline configurations. This property is not supported by MaskedTextBox.
Public propertyLocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. (Inherited from Control.)
Public propertyMarginGets or sets the space between controls. (Inherited from Control.)
Public propertyMaskGets or sets the input mask to use at run time.
Public propertyMaskCompletedGets a value indicating whether all required inputs have been entered into the input mask.
Public propertyMaskedTextProviderGets a clone of the mask provider associated with this instance of the masked text box control.
Public propertyMaskFullGets a value indicating whether all required and optional inputs have been entered into the input mask.
Public propertyMaximumSizeGets or sets the size that is the upper limit that GetPreferredSize can specify. (Inherited from Control.)
Public propertyMaxLengthGets or sets the maximum number of characters the user can type or paste into the text box control. This property is not supported by MaskedTextBox. (Overrides TextBoxBase.MaxLength.)
Public propertyMinimumSizeGets or sets the size that is the lower limit that GetPreferredSize can specify. (Inherited from Control.)
Public propertyModifiedGets or sets a value that indicates that the text box control has been modified by the user since the control was created or its contents were last set. (Inherited from TextBoxBase.)
Public propertyMultilineGets or sets a value indicating whether this is a multiline text box control. This property is not fully supported by MaskedTextBox. (Overrides TextBoxBase.Multiline.)
Public propertyNameGets or sets the name of the control. (Inherited from Control.)
Public propertyPaddingInfrastructure. This property is not relevant for this class. (Inherited from TextBoxBase.)
Public propertyParentGets or sets the parent container of the control. (Inherited from Control.)
Public propertyPasswordCharGets or sets the character to be displayed in substitute for user input.
Public propertyPreferredHeightGets the preferred height for a text box. (Inherited from TextBoxBase.)
Public propertyPreferredSizeGets the size of a rectangular area into which the control can fit. (Inherited from Control.)
Public propertyProductNameGets the product name of the assembly containing the control. (Inherited from Control.)
Public propertyProductVersionGets the version of the assembly containing the control. (Inherited from Control.)
Public propertyPromptCharGets or sets the character used to represent the absence of user input in MaskedTextBox.
Public propertyReadOnlyGets or sets a value indicating whether text in the text box is read-only.
Public propertyRecreatingHandleGets a value indicating whether the control is currently re-creating its handle. (Inherited from Control.)
Public propertyRegionGets or sets the window region associated with the control. (Inherited from Control.)
Public propertyRejectInputOnFirstFailureGets or sets a value indicating whether the parsing of user input should stop after the first invalid character is reached.
Protected propertyRenderRightToLeft Obsolete. This property is now obsolete. (Inherited from Control.)
Public propertyResetOnPromptGets or sets a value that determines how an input character that matches the prompt character should be handled.
Public propertyResetOnSpaceGets or sets a value that determines how a space input character should be handled.
Protected propertyResizeRedrawGets or sets a value indicating whether the control redraws itself when resized. (Inherited from Control.)
Public propertyRightGets the distance, in pixels, between the right edge of the control and the left edge of its container's client area. (Inherited from Control.)
Public propertyRightToLeftGets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. (Inherited from Control.)
Protected propertyScaleChildrenGets a value that determines the scaling of child controls. (Inherited from Control.)
Public propertySelectedTextGets or sets the current selection in the MaskedTextBox control. (Overrides TextBoxBase.SelectedText.)
Public propertySelectionLengthGets or sets the number of characters selected in the text box. (Inherited from TextBoxBase.)
Public propertySelectionStartGets or sets the starting point of text selected in the text box. (Inherited from TextBoxBase.)
Public propertyShortcutsEnabledGets or sets a value indicating whether the defined shortcuts are enabled. (Inherited from TextBoxBase.)
Protected propertyShowFocusCuesGets a value indicating whether the control should display focus rectangles. (Inherited from Control.)
Protected propertyShowKeyboardCuesGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. (Inherited from Control.)
Public propertySiteGets or sets the site of the control. (Inherited from Control.)
Public propertySizeGets or sets the height and width of the control. (Inherited from Control.)
Public propertySkipLiteralsGets or sets a value indicating whether the user is allowed to reenter literal values.
Public propertyTabIndexGets or sets the tab order of the control within its container. (Inherited from Control.)
Public propertyTabStopGets or sets a value indicating whether the user can give the focus to this control using the TAB key. (Inherited from Control.)
Public propertyTagGets or sets the object that contains data about the control. (Inherited from Control.)
Public propertyTextGets or sets the text as it is currently displayed to the user. (Overrides TextBoxBase.Text.)
Public propertyTextAlignGets or sets how text is aligned in a masked text box control.
Public propertyTextLengthGets the length of the displayed text. (Overrides TextBoxBase.TextLength.)
Public propertyTextMaskFormatGets or sets a value that determines whether literals and prompt characters are included in the formatted string.
Public propertyTopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area. (Inherited from Control.)
Public propertyTopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. (Inherited from Control.)
Public propertyUseSystemPasswordCharGets or sets a value indicating whether the operating system-supplied password character should be used.
Public propertyUseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. (Inherited from Control.)
Public propertyValidatingTypeGets or sets the data type used to verify the data input by the user.
Public propertyVisibleGets or sets a value indicating whether the control and all its child controls are displayed. (Inherited from Control.)
Public propertyWidthGets or sets the width of the control. (Inherited from Control.)
Public propertyWindowTargetInfrastructure. This property is not relevant for this class. (Inherited from Control.)
Public propertyWordWrapGets or sets a value indicating whether a multiline text box control automatically wraps words to the beginning of the next line when necessary. This property is not supported by MaskedTextBox.
Top

  NameDescription
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32)Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. (Inherited from Control.)
Protected methodAccessibilityNotifyClients(AccessibleEvents, Int32, Int32)Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control . (Inherited from Control.)
Public methodAppendTextAppends text to the current text of a text box. (Inherited from TextBoxBase.)
Public methodBeginInvoke(Delegate)Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. (Inherited from Control.)
Public methodBeginInvoke(Delegate, Object[])Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on. (Inherited from Control.)
Public methodBringToFrontBrings the control to the front of the z-order. (Inherited from Control.)
Public methodClearClears all text from the text box control. (Inherited from TextBoxBase.)
Public methodClearUndoClears information about the most recent operation from the undo buffer of the text box. This method is not supported by MaskedTextBox.
Public methodContainsRetrieves a value indicating whether the specified control is a child of the control. (Inherited from Control.)
Public methodCopyCopies the current selection in the text box to the Clipboard. (Inherited from TextBoxBase.)
Protected methodCreateAccessibilityInstanceCreates a new accessibility object for the control. (Inherited from Control.)
Public methodCreateControlForces the creation of the visible control, including the creation of the handle and any visible child controls. (Inherited from Control.)
Protected methodCreateControlsInstanceCreates a new instance of the control collection for the control. (Inherited from Control.)
Public methodCreateGraphicsCreates the Graphics for the control. (Inherited from Control.)
Protected methodCreateHandleCreates a handle for the control. (Overrides TextBoxBase.CreateHandle().)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodCutMoves the current selection in the text box to the Clipboard. (Inherited from TextBoxBase.)
Protected methodDefWndProcSends the specified message to the default window procedure. (Inherited from Control.)
Public methodDeselectAllSpecifies that the value of the SelectionLength property is zero so that no characters are selected in the control. (Inherited from TextBoxBase.)
Protected methodDestroyHandleDestroys the handle associated with the control. (Inherited from Control.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources. (Inherited from Control.)
Public methodDoDragDropBegins a drag-and-drop operation. (Inherited from Control.)
Public methodDrawToBitmapSupports rendering to the specified bitmap. (Inherited from Control.)
Public methodEndInvokeRetrieves the return value of the asynchronous operation represented by the IAsyncResult passed. (Inherited from Control.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodFindFormRetrieves the form that the control is on. (Inherited from Control.)
Public methodFocusSets input focus to the control. (Inherited from Control.)
Protected methodGetAccessibilityObjectByIdRetrieves the specified AccessibleObject. (Inherited from Control.)
Protected methodGetAutoSizeModeRetrieves a value indicating how a control will behave when its AutoSize property is enabled. (Inherited from Control.)
Public methodGetCharFromPositionRetrieves the character that is closest to the specified location within the control. (Overrides TextBoxBase.GetCharFromPosition(Point).)
Public methodGetCharIndexFromPositionRetrieves the index of the character nearest to the specified location. (Overrides TextBoxBase.GetCharIndexFromPosition(Point).)
Public methodGetChildAtPoint(Point)Retrieves the child control that is located at the specified coordinates. (Inherited from Control.)
Public methodGetChildAtPoint(Point, GetChildAtPointSkip)Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. (Inherited from Control.)
Public methodGetContainerControlReturns the next ContainerControl up the control's chain of parent controls. (Inherited from Control.)
Public methodGetFirstCharIndexFromLineRetrieves the index of the first character of a given line. This method is not supported by MaskedTextBox.
Public methodGetFirstCharIndexOfCurrentLineRetrieves the index of the first character of the current line. This method is not supported by MaskedTextBox.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetLineFromCharIndexRetrieves the line number from the specified character position within the text of the control. This method is not supported by MaskedTextBox. (Overrides TextBoxBase.GetLineFromCharIndex(Int32).)
Public methodGetNextControlRetrieves the next control forward or back in the tab order of child controls. (Inherited from Control.)
Public methodGetPositionFromCharIndexRetrieves the location within the control at the specified character index. (Overrides TextBoxBase.GetPositionFromCharIndex(Int32).)
Public methodGetPreferredSizeRetrieves the size of a rectangular area into which a control can be fitted. (Inherited from Control.)
Protected methodGetScaledBoundsRetrieves the bounds within which the control is scaled. (Inherited from Control.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Protected methodGetStyleRetrieves the value of the specified control style bit for the control. (Inherited from Control.)
Protected methodGetTopLevelDetermines if the control is a top-level control. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHideConceals the control from the user. (Inherited from Control.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodInitLayoutCalled after the control has been added to another container. (Inherited from Control.)
Public methodInvalidate()Invalidates the entire surface of the control and causes the control to be redrawn. (Inherited from Control.)
Public methodInvalidate(Boolean)Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. (Inherited from Control.)
Public methodInvalidate(Rectangle)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. (Inherited from Control.)
Public methodInvalidate(Region)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. (Inherited from Control.)
Public methodInvalidate(Rectangle, Boolean)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. (Inherited from Control.)
Public methodInvalidate(Region, Boolean)Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. (Inherited from Control.)
Public methodInvoke(Delegate)Executes the specified delegate on the thread that owns the control's underlying window handle. (Inherited from Control.)
Public methodInvoke(Delegate, Object[])Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. (Inherited from Control.)
Protected methodInvokeGotFocusRaises the GotFocus event for the specified control. (Inherited from Control.)
Protected methodInvokeLostFocusRaises the LostFocus event for the specified control. (Inherited from Control.)
Protected methodInvokeOnClickRaises the Click event for the specified control. (Inherited from Control.)
Protected methodInvokePaintRaises the Paint event for the specified control. (Inherited from Control.)
Protected methodInvokePaintBackgroundRaises the PaintBackground event for the specified control. (Inherited from Control.)
Protected methodIsInputCharDetermines if a character is an input character that the control recognizes. (Inherited from Control.)
Protected methodIsInputKeyDetermines whether the specified key is an input key or a special key that requires preprocessing. (Overrides TextBoxBase.IsInputKey(Keys).)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodNotifyInvalidateInfrastructure. Raises the Invalidated event with a specified region of the control to invalidate. (Inherited from Control.)
Protected methodOnAcceptsTabChangedRaises the AcceptsTabChanged event. (Inherited from TextBoxBase.)
Protected methodOnAutoSizeChangedRaises the AutoSizeChanged event. (Inherited from Control.)
Protected methodOnBackColorChangedOccurs when the value of the BackColor property changes. (Overrides Control.OnBackColorChanged(EventArgs).)
Protected methodOnBackgroundImageChangedRaises the BackgroundImageChanged event. (Inherited from Control.)
Protected methodOnBackgroundImageLayoutChangedRaises the BackgroundImageLayoutChanged event. (Inherited from Control.)
Protected methodOnBindingContextChangedRaises the BindingContextChanged event. (Inherited from Control.)
Protected methodOnBorderStyleChangedRaises the BorderStyleChanged event. (Inherited from TextBoxBase.)
Protected methodOnCausesValidationChangedRaises the CausesValidationChanged event. (Inherited from Control.)
Protected methodOnChangeUICuesRaises the ChangeUICues event. (Inherited from Control.)
Protected methodOnClickRaises the Click event. (Inherited from Control.)
Protected methodOnClientSizeChangedRaises the ClientSizeChanged event. (Inherited from Control.)
Protected methodOnContextMenuChangedRaises the ContextMenuChanged event. (Inherited from Control.)
Protected methodOnContextMenuStripChangedRaises the ContextMenuStripChanged event. (Inherited from Control.)
Protected methodOnControlAddedRaises the ControlAdded event. (Inherited from Control.)
Protected methodOnControlRemovedRaises the ControlRemoved event. (Inherited from Control.)
Protected methodOnCreateControlRaises the CreateControl method. (Inherited from Control.)
Protected methodOnCursorChangedRaises the CursorChanged event. (Inherited from Control.)
Protected methodOnDockChangedRaises the DockChanged event. (Inherited from Control.)
Protected methodOnDoubleClickRaises the DoubleClick event. (Inherited from Control.)
Protected methodOnDragDropRaises the DragDrop event. (Inherited from Control.)
Protected methodOnDragEnterRaises the DragEnter event. (Inherited from Control.)
Protected methodOnDragLeaveRaises the DragLeave event. (Inherited from Control.)
Protected methodOnDragOverRaises the DragOver event. (Inherited from Control.)
Protected methodOnEnabledChangedRaises the EnabledChanged event. (Inherited from Control.)
Protected methodOnEnterRaises the Enter event. (Inherited from Control.)
Protected methodOnFontChangedRaises the FontChanged event. (Inherited from TextBoxBase.)
Protected methodOnForeColorChangedRaises the ForeColorChanged event. (Inherited from Control.)
Protected methodOnGiveFeedbackRaises the GiveFeedback event. (Inherited from Control.)
Protected methodOnGotFocusRaises the GotFocus event. (Inherited from Control.)
Protected methodOnHandleCreatedRaises the HandleCreated event. (Overrides TextBoxBase.OnHandleCreated(EventArgs).)
Protected methodOnHandleDestroyedRaises the HandleDestroyed event. (Inherited from TextBoxBase.)
Protected methodOnHelpRequestedRaises the HelpRequested event. (Inherited from Control.)
Protected methodOnHideSelectionChangedRaise the HideSelectionChanged event. (Inherited from TextBoxBase.)
Protected methodOnImeModeChangedRaises the ImeModeChanged event. (Inherited from Control.)
Protected methodOnInvalidatedRaises the Invalidated event. (Inherited from Control.)
Protected methodOnIsOverwriteModeChangedRaises the IsOverwriteModeChanged event.
Protected methodOnKeyDownRaises the KeyDown event. (Overrides Control.OnKeyDown(KeyEventArgs).)
Protected methodOnKeyPressRaises the KeyPress event. (Overrides Control.OnKeyPress(KeyPressEventArgs).)
Protected methodOnKeyUpRaises the KeyUp event. (Overrides Control.OnKeyUp(KeyEventArgs).)
Protected methodOnLayoutRaises the Layout event. (Inherited from Control.)
Protected methodOnLeaveRaises the Leave event. (Inherited from Control.)
Protected methodOnLocationChangedRaises the LocationChanged event. (Inherited from Control.)
Protected methodOnLostFocusRaises the LostFocus event. (Inherited from Control.)
Protected methodOnMarginChangedRaises the MarginChanged event. (Inherited from Control.)
Protected methodOnMaskChangedRaises the MaskChanged event.
Protected methodOnModifiedChangedRaises the ModifiedChanged event. (Inherited from TextBoxBase.)
Protected methodOnMouseCaptureChangedRaises the MouseCaptureChanged event. (Inherited from Control.)
Protected methodOnMouseClickRaises the MouseClick event. (Inherited from Control.)
Protected methodOnMouseDoubleClickRaises the MouseDoubleClick event. (Inherited from Control.)
Protected methodOnMouseDownRaises the MouseDown event. (Inherited from Control.)
Protected methodOnMouseEnterRaises the MouseEnter event. (Inherited from Control.)
Protected methodOnMouseHoverRaises the MouseHover event. (Inherited from Control.)
Protected methodOnMouseLeaveRaises the MouseLeave event. (Inherited from Control.)
Protected methodOnMouseMoveRaises the MouseMove event. (Inherited from Control.)
Protected methodOnMouseUpRaises the MouseUp event. (Inherited from TextBoxBase.)
Protected methodOnMouseWheelRaises the MouseWheel event. (Inherited from Control.)
Protected methodOnMoveRaises the Move event. (Inherited from Control.)
Protected methodOnMultilineChangedTypically raises the MultilineChanged event, but disabled for MaskedTextBox. (Overrides TextBoxBase.OnMultilineChanged(EventArgs).)
Protected methodOnNotifyMessageNotifies the control of Windows messages. (Inherited from Control.)
Protected methodOnPaddingChangedInfrastructure. This method is not relevant for this class. (Inherited from TextBoxBase.)
Protected methodOnPaintRaises the Paint event. (Inherited from Control.)
Protected methodOnPaintBackgroundPaints the background of the control. (Inherited from Control.)
Protected methodOnParentBackColorChangedRaises the BackColorChanged event when the BackColor property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentBackgroundImageChangedRaises the BackgroundImageChanged event when the BackgroundImage property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentBindingContextChangedRaises the BindingContextChanged event when the BindingContext property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentChangedRaises the ParentChanged event. (Inherited from Control.)
Protected methodOnParentCursorChangedRaises the CursorChanged event. (Inherited from Control.)
Protected methodOnParentEnabledChangedRaises the EnabledChanged event when the Enabled property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentFontChangedRaises the FontChanged event when the Font property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentForeColorChangedRaises the ForeColorChanged event when the ForeColor property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentRightToLeftChangedRaises the RightToLeftChanged event when the RightToLeft property value of the control's container changes. (Inherited from Control.)
Protected methodOnParentVisibleChangedRaises the VisibleChanged event when the Visible property value of the control's container changes. (Inherited from Control.)
Protected methodOnPreviewKeyDownRaises the PreviewKeyDown event. (Inherited from Control.)
Protected methodOnPrintRaises the Paint event. (Inherited from Control.)
Protected methodOnQueryContinueDragRaises the QueryContinueDrag event. (Inherited from Control.)
Protected methodOnReadOnlyChangedRaises the ReadOnlyChanged event. (Inherited from TextBoxBase.)
Protected methodOnRegionChangedRaises the RegionChanged event. (Inherited from Control.)
Protected methodOnResizeRaises the Resize event. (Inherited from Control.)
Protected methodOnRightToLeftChangedRaises the RightToLeftChanged event. (Inherited from Control.)
Protected methodOnSizeChangedRaises the SizeChanged event. (Inherited from Control.)
Protected methodOnStyleChangedRaises the StyleChanged event. (Inherited from Control.)
Protected methodOnSystemColorsChangedRaises the SystemColorsChanged event. (Inherited from Control.)
Protected methodOnTabIndexChangedRaises the TabIndexChanged event. (Inherited from Control.)
Protected methodOnTabStopChangedRaises the TabStopChanged event. (Inherited from Control.)
Protected methodOnTextAlignChangedRaises the TextAlignChanged event.
Protected methodOnTextChangedRaises the TextChanged event. (Overrides TextBoxBase.OnTextChanged(EventArgs).)
Protected methodOnValidatedRaises the Validated event. (Inherited from Control.)
Protected methodOnValidatingRaises the Validating event. (Overrides Control.OnValidating(CancelEventArgs).)
Protected methodOnVisibleChangedRaises the VisibleChanged event. (Inherited from Control.)
Public methodPasteReplaces the current selection in the text box with the contents of the Clipboard. (Inherited from TextBoxBase.)
Public methodPerformLayout()Forces the control to apply layout logic to all its child controls. (Inherited from Control.)
Public methodPerformLayout(Control, String)Forces the control to apply layout logic to all its child controls. (Inherited from Control.)
Public methodPointToClientComputes the location of the specified screen point into client coordinates. (Inherited from Control.)
Public methodPointToScreenComputes the location of the specified client point into screen coordinates. (Inherited from Control.)
Public methodPreProcessControlMessagePreprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from Control.)
Public methodPreProcessMessagePreprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from Control.)
Protected methodProcessCmdKeyProcesses a command key. (Overrides TextBoxBase.ProcessCmdKey(Message, Keys).)
Protected methodProcessDialogCharProcesses a dialog character. (Inherited from Control.)
Protected methodProcessDialogKeyProcesses a dialog key. (Inherited from TextBoxBase.)
Protected methodProcessKeyEventArgsProcesses a key message and generates the appropriate control events. (Inherited from Control.)
Protected methodProcessKeyMessageOverrides the base implementation of this method to handle input language changes. (Overrides Control.ProcessKeyMessage(Message).)
Protected methodProcessKeyPreviewPreviews a keyboard message. (Inherited from Control.)
Protected methodProcessMnemonicProcesses a mnemonic character. (Inherited from Control.)
Protected methodRaiseDragEventInfrastructure. Raises the appropriate drag event. (Inherited from Control.)
Protected methodRaiseKeyEventInfrastructure. Raises the appropriate key event. (Inherited from Control.)
Protected methodRaiseMouseEventInfrastructure. Raises the appropriate mouse event. (Inherited from Control.)
Protected methodRaisePaintEventInfrastructure. Raises the appropriate paint event. (Inherited from Control.)
Protected methodRecreateHandleForces the re-creation of the handle for the control. (Inherited from Control.)
Public methodRectangleToClientComputes the size and location of the specified screen rectangle in client coordinates. (Inherited from Control.)
Public methodRectangleToScreenComputes the size and location of the specified client rectangle in screen coordinates. (Inherited from Control.)
Public methodRefreshForces the control to invalidate its client area and immediately redraw itself and any child controls. (Inherited from Control.)
Public methodResetBackColorResets the BackColor property to its default value. (Inherited from Control.)
Public methodResetBindingsCauses a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. (Inherited from Control.)
Public methodResetCursorResets the Cursor property to its default value. (Inherited from Control.)
Public methodResetFontResets the Font property to its default value. (Inherited from Control.)
Public methodResetForeColorResets the ForeColor property to its default value. (Inherited from Control.)
Public methodResetImeModeResets the ImeMode property to its default value. (Inherited from Control.)
Protected methodResetMouseEventArgsInfrastructure. Resets the control to handle the MouseLeave event. (Inherited from Control.)
Public methodResetRightToLeftResets the RightToLeft property to its default value. (Inherited from Control.)
Public methodResetTextResets the Text property to its default value. (Inherited from Control.)
Public methodResumeLayout()Resumes usual layout logic. (Inherited from Control.)
Public methodResumeLayout(Boolean)Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. (Inherited from Control.)
Protected methodRtlTranslateAlignment(ContentAlignment)Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateAlignment(HorizontalAlignment)Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateAlignment(LeftRightAlignment)Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateContentConverts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateHorizontalConverts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. (Inherited from Control.)
Protected methodRtlTranslateLeftRightConverts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. (Inherited from Control.)
Public methodScale(Single) Obsolete. Scales the control and any child controls. (Inherited from Control.)
Public methodScale(SizeF)Scales the control and all child controls by the specified scaling factor. (Inherited from Control.)
Public methodScale(Single, Single) Obsolete. Scales the entire control and any child controls. (Inherited from Control.)
Protected methodScaleControlScales a control's location, size, padding and margin. (Inherited from Control.)
Protected methodScaleCoreInfrastructure. This method is not relevant for this class. (Inherited from Control.)
Public methodScrollToCaretScrolls the contents of the control to the current caret position. This method is not supported by MaskedTextBox.
Public methodSelect()Activates the control. (Inherited from Control.)
Protected methodSelect(Boolean, Boolean)Activates a child control. Optionally specifies the direction in the tab order to select the control from. (Inherited from Control.)
Public methodSelect(Int32, Int32)Selects a range of text in the text box. (Inherited from TextBoxBase.)
Public methodSelectAllSelects all text in the text box. (Inherited from TextBoxBase.)
Public methodSelectNextControlActivates the next control. (Inherited from Control.)
Public methodSendToBackSends the control to the back of the z-order. (Inherited from Control.)
Protected methodSetAutoSizeModeSets a value indicating how a control will behave when its AutoSize property is enabled. (Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32)Sets the bounds of the control to the specified location and size. (Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)Sets the specified bounds of the control to the specified location and size. (Inherited from Control.)
Protected methodSetBoundsCoreSets the specified bounds of the TextBoxBase control. (Inherited from TextBoxBase.)
Protected methodSetClientSizeCoreSets the size of the client area of the control. (Inherited from Control.)
Protected methodSetStyleSets a specified ControlStyles flag to either true or false. (Inherited from Control.)
Protected methodSetTopLevelSets the control as the top-level control. (Inherited from Control.)
Protected methodSetVisibleCoreSets the control to the specified visible state. (Inherited from Control.)
Public methodShowDisplays the control to the user. (Inherited from Control.)
Protected methodSizeFromClientSizeDetermines the size of the entire control from the height and width of its client area. (Inherited from Control.)
Public methodSuspendLayoutTemporarily suspends the layout logic for the control. (Inherited from Control.)
Public methodToStringReturns a string that represents the current masked text box. This method overrides ToString. (Overrides TextBoxBase.ToString().)
Public methodUndoUndoes the last edit operation in the text box. This method is not supported by MaskedTextBox.
Public methodUpdateCauses the control to redraw the invalidated regions within its client area. (Inherited from Control.)
Protected methodUpdateBounds()Updates the bounds of the control with the current size and location. (Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32)Updates the bounds of the control with the specified size and location. (Inherited from Control.)
Protected methodUpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32)Updates the bounds of the control with the specified size, location, and client size. (Inherited from Control.)
Protected methodUpdateStylesForces the assigned styles to be reapplied to the control. (Inherited from Control.)
Protected methodUpdateZOrderUpdates the control in its parent's z-order. (Inherited from Control.)
Public methodValidateTextConverts the user input string to an instance of the validating type.
Protected methodWndProcProcesses text messages. (Overrides TextBoxBase.WndProc(Message).)
Top

  NameDescription
Public eventAcceptsTabChangedOccurs when the value of the AcceptsTab property has changed. This event is not raised by MaskedTextBox.
Public eventAutoSizeChangedInfrastructure. This event is not relevant for this class. (Inherited from TextBoxBase.)
Public eventBackColorChangedOccurs when the value of the BackColor property changes. (Inherited from Control.)
Public eventBackgroundImageChangedInfrastructure. Occurs when the value of the BackgroundImage property changes. This event is not relevant for this class. (Inherited from TextBoxBase.)
Public eventBackgroundImageLayoutChangedInfrastructure. Occurs when the value of the BackgroundImageLayout property changes. This event is not relevant for this class. (Inherited from TextBoxBase.)
Public eventBindingContextChangedOccurs when the value of the BindingContext property changes. (Inherited from Control.)
Public eventBorderStyleChangedOccurs when the value of the BorderStyle property has changed. (Inherited from TextBoxBase.)
Public eventCausesValidationChangedOccurs when the value of the CausesValidation property changes. (Inherited from Control.)
Public eventChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change. (Inherited from Control.)
Public eventClickOccurs when the text box is clicked. (Inherited from TextBoxBase.)
Public eventClientSizeChangedOccurs when the value of the ClientSize property changes. (Inherited from Control.)
Public eventContextMenuChangedOccurs when the value of the ContextMenu property changes. (Inherited from Control.)
Public eventContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes. (Inherited from Control.)
Public eventControlAddedOccurs when a new control is added to the Control.ControlCollection. (Inherited from Control.)
Public eventControlRemovedOccurs when a control is removed from the Control.ControlCollection. (Inherited from Control.)
Public eventCursorChangedOccurs when the value of the Cursor property changes. (Inherited from Control.)
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventDockChangedOccurs when the value of the Dock property changes. (Inherited from Control.)
Public eventDoubleClickOccurs when the control is double-clicked. (Inherited from Control.)
Public eventDragDropOccurs when a drag-and-drop operation is completed. (Inherited from Control.)
Public eventDragEnterOccurs when an object is dragged into the control's bounds. (Inherited from Control.)
Public eventDragLeaveOccurs when an object is dragged out of the control's bounds. (Inherited from Control.)
Public eventDragOverOccurs when an object is dragged over the control's bounds. (Inherited from Control.)
Public eventEnabledChangedOccurs when the Enabled property value has changed. (Inherited from Control.)
Public eventEnterOccurs when the control is entered. (Inherited from Control.)
Public eventFontChangedOccurs when the Font property value changes. (Inherited from Control.)
Public eventForeColorChangedOccurs when the ForeColor property value changes. (Inherited from Control.)
Public eventGiveFeedbackOccurs during a drag operation. (Inherited from Control.)
Public eventGotFocusOccurs when the control receives focus. (Inherited from Control.)
Public eventHandleCreatedOccurs when a handle is created for the control. (Inherited from Control.)
Public eventHandleDestroyedOccurs when the control's handle is in the process of being destroyed. (Inherited from Control.)
Public eventHelpRequestedOccurs when the user requests help for a control. (Inherited from Control.)
Public eventHideSelectionChangedOccurs when the value of the HideSelection property has changed. (Inherited from TextBoxBase.)
Public eventImeModeChangedOccurs when the ImeMode property has changed. (Inherited from Control.)
Public eventInvalidatedOccurs when a control's display requires redrawing. (Inherited from Control.)
Public eventIsOverwriteModeChangedOccurs after the insert mode has changed.
Public eventKeyDownOccurs when a key is pressed while the control has focus. (Inherited from Control.)
Public eventKeyPressOccurs when a character. space or backspace key is pressed while the control has focus. (Inherited from Control.)
Public eventKeyUpOccurs when a key is released while the control has focus. (Inherited from Control.)
Public eventLayoutOccurs when a control should reposition its child controls. (Inherited from Control.)
Public eventLeaveOccurs when the input focus leaves the control. (Inherited from Control.)
Public eventLocationChangedOccurs when the Location property value has changed. (Inherited from Control.)
Public eventLostFocusOccurs when the control loses focus. (Inherited from Control.)
Public eventMarginChangedOccurs when the control's margin changes. (Inherited from Control.)
Public eventMaskChangedOccurs after the input mask is changed.
Public eventMaskInputRejectedOccurs when the user's input or assigned character does not match the corresponding format element of the input mask.
Public eventModifiedChangedOccurs when the value of the Modified property has changed. (Inherited from TextBoxBase.)
Public eventMouseCaptureChangedOccurs when the control loses mouse capture. (Inherited from Control.)
Public eventMouseClickOccurs when the control is clicked by the mouse. (Inherited from TextBoxBase.)
Public eventMouseDoubleClickOccurs when the control is double clicked by the mouse. (Inherited from Control.)
Public eventMouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed. (Inherited from Control.)
Public eventMouseEnterOccurs when the mouse pointer enters the control. (Inherited from Control.)
Public eventMouseHoverOccurs when the mouse pointer rests on the control. (Inherited from Control.)
Public eventMouseLeaveOccurs when the mouse pointer leaves the control. (Inherited from Control.)
Public eventMouseMoveOccurs when the mouse pointer is moved over the control. (Inherited from Control.)
Public eventMouseUpOccurs when the mouse pointer is over the control and a mouse button is released. (Inherited from Control.)
Public eventMouseWheelOccurs when the mouse wheel moves while the control has focus. (Inherited from Control.)
Public eventMoveOccurs when the control is moved. (Inherited from Control.)
Public eventMultilineChangedTypically occurs when the value of the Multiline property has changed; however, this event is not raised by MaskedTextBox.
Public eventPaddingChangedInfrastructure. This event is not relevant for this class. (Inherited from TextBoxBase.)
Public eventPaintInfrastructure. Occurs when the control is redrawn. This event is not relevant for this class. (Inherited from TextBoxBase.)
Public eventParentChangedOccurs when the Parent property value changes. (Inherited from Control.)
Public eventPreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control. (Inherited from Control.)
Public eventQueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications. (Inherited from Control.)
Public eventQueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. (Inherited from Control.)
Public eventReadOnlyChangedOccurs when the value of the ReadOnly property has changed. (Inherited from TextBoxBase.)
Public eventRegionChangedOccurs when the value of the Region property changes. (Inherited from Control.)
Public eventResizeOccurs when the control is resized. (Inherited from Control.)
Public eventRightToLeftChangedOccurs when the RightToLeft property value changes. (Inherited from Control.)
Public eventSizeChangedOccurs when the Size property value changes. (Inherited from Control.)
Public eventStyleChangedOccurs when the control style changes. (Inherited from Control.)
Public eventSystemColorsChangedOccurs when the system colors change. (Inherited from Control.)
Public eventTabIndexChangedOccurs when the TabIndex property value changes. (Inherited from Control.)
Public eventTabStopChangedOccurs when the TabStop property value changes. (Inherited from Control.)
Public eventTextAlignChangedOccurs when the text alignment is changed.
Public eventTextChangedOccurs when the Text property value changes. (Inherited from Control.)
Public eventTypeValidationCompletedOccurs when MaskedTextBox has finished parsing the current value using the ValidatingType property.
Public eventValidatedOccurs when the control is finished validating. (Inherited from Control.)
Public eventValidatingOccurs when the control is validating. (Inherited from Control.)
Public eventVisibleChangedOccurs when the Visible property value changes. (Inherited from Control.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIDropTarget.OnDragDropInfrastructure. Raises the DragDrop event. (Inherited from Control.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragEnterInfrastructure. Raises the DragEnter event. (Inherited from Control.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragLeaveInfrastructure. Raises the DragLeave event. (Inherited from Control.)
Explicit interface implemetationPrivate methodIDropTarget.OnDragOverInfrastructure. Raises the DragOver event. (Inherited from Control.)
Top

The MaskedTextBox class is an enhanced TextBox control that supports a declarative syntax for accepting or rejecting user input. Using the Mask property, you can specify the following input without writing any custom validation logic in your application:

  • Required input characters.

  • Optional input characters.

  • The type of input expected at a given position in the mask; for example, a digit, or an alphabetic or alphanumeric character.

  • Mask literals, or characters that should appear directly in the MaskedTextBox; for example, the hyphens (-) in a phone number, or the currency symbol in a price.

  • Special processing for input characters; for example, to convert alphabetic characters to uppercase.

When a MaskedTextBox control is displayed at run time, it represents the mask as a series of prompt characters and optional literal characters. Each editable mask position, representing a required or optional input, is shown with a single prompt character. For example, the number sign (#) is often used as a placeholder for a numeric character input. You can use the PromptChar property to specify a custom prompt character. The HidePromptOnLeave property determines if the user sees the prompt characters when the control loses input focus.

As the user types input into the masked text box, valid input characters replace their respective prompt characters in a sequential fashion. If the user types an invalid input character, no replacement occurs, but instead a beep is issued if the BeepOnError property is set to true, and the MaskInputRejected event is raised. You can provide your own custom error logic by handing this event.

When the current insertion point is at a literal character, the user has a number of options:

  • If a character other than the prompt character is typed, the literal will automatically be skipped and the input character will be applied to the next editable position, represented by the next prompt character.

  • If the prompt character is typed and the AllowPromptAsInput property is true, the input will overtype the prompt character and insertion point will be moved to the next position in the mask.

  • As is always the case, the arrow keys can be used to navigate to a previous or subsequent position.

You can use the MaskFull property to verify whether or not the user has entered all of the required input. The Text property will always retrieve the user's input formatted according to the mask and the TextMaskFormat property.

The MaskedTextBox control actually defers all mask processing to the System.ComponentModel.MaskedTextProvider class specified by the MaskedTextProvider property. This standard provider supports all Unicode characters except for surrogates and vertically combined characters; however, the AsciiOnly property can be used to restrict input to the characters sets a-z, A-Z, and 0-9.

Masks do not necessarily guarantee that a user's input will represent a valid value for a given type; for example, -9 could be entered for an age in years. You can verify that a user's input represents a valid value by assigning an instance of that value's type to the ValidatingType property. You can detect whether the user removes focus from MaskedTextBox when it contains an invalid value by monitoring for the TypeValidationCompleted event. If type validation succeeds, the object representing the value will be available through the ReturnValue property of the TypeValidationEventArgs parameter.

As with the TextBox control, several common keyboard shortcuts do not work with MaskedTextBox. In particular, CTRL-R (right justify text), CTRL-L (left justify text), and CTRL-L (center text) have no effect.

Compatibility with Visual Basic 6.0

MaskedTextBox was designed to retain most of the functionality of the Masked Edit control in Visual Basic 6.0. The following table lists common properties on the Masked Edit control and gives their equivalents on MaskedTextBox.

Masked Edit control (Visual Basic 6.0) property

Equivalent MaskedTextBox (.NET Framework) property

AllowPrompt property

AllowPromptAsInput

AutoTab property

None

ClipMode property

CutCopyMaskFormat

ClipText property

Text (when TextMaskFormat is set to ExcludePromptAndLiterals)

Format property

None

FormattedText property

Text (when TextMaskFormat is set to IncludePromptAndLiterals)

Mask property

Mask

PromptChar property

PromptChar

PromptInclude property

ResetOnPrompt

ValidationError event

MaskInputRejected

Caution noteCaution

The MaskedTextBox control does not support multiline configuration or undo functionality. However, while the members associated with these features have been retained for compatibility with the TextBoxBase base class, their implementations perform no actions.

The following code example initializes the MaskedTextBox to accept a date, and uses both the MaskInputRejected and TypeValidationCompleted events to alert the user to invalid input.

private void Form1_Load(object sender, EventArgs e)
{
    maskedTextBox1.Mask = "00/00/0000";

    maskedTextBox1.MaskInputRejected += new MaskInputRejectedEventHandler(maskedTextBox1_MaskInputRejected);
    maskedTextBox1.KeyDown += new KeyEventHandler(maskedTextBox1_KeyDown);
}

void maskedTextBox1_MaskInputRejected(object sender, MaskInputRejectedEventArgs e)
{
    if (maskedTextBox1.MaskFull)
    {
        toolTip1.ToolTipTitle = "Input Rejected - Too Much Data";
        toolTip1.Show("You cannot enter any more data into the date field. Delete some characters in order to insert more data.", maskedTextBox1, 0, -20, 5000);
    }
    else if (e.Position == maskedTextBox1.Mask.Length)
    {
        toolTip1.ToolTipTitle = "Input Rejected - End of Field";
        toolTip1.Show("You cannot add extra characters to the end of this date field.", maskedTextBox1, 0, -20, 5000);
    }
    else
    {
        toolTip1.ToolTipTitle = "Input Rejected";
        toolTip1.Show("You can only add numeric characters (0-9) into this date field.", maskedTextBox1, 0, -20, 5000);
    }
}

void maskedTextBox1_KeyDown(object sender, KeyEventArgs e)
{
    // The balloon tip is visible for five seconds; if the user types any data before it disappears, collapse it ourselves.
    toolTip1.Hide(maskedTextBox1);
}

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft