Version

EditorWithMask Class Members

The following tables list the members exposed by EditorWithMask.

Public Constructors
 NameDescription
Public ConstructorEditorWithMask ConstructorOverloaded.   
Protected Fields
 NameDescription
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Public Properties
 NameDescription
Public PropertyAllowShiftingAcrossSectionsSpecifies whether to shift characters across section boundaries when deleting characters.  
Public PropertyAutoFillDateSpecifies whether to auto-fill empty date components when the user attempts to leave the editor. The default is None.  
Public PropertyAutoFillTimeSpecifies whether to auto-fill empty time components when the user attempts to leave the editor. The default is None.  
Public PropertyButtonsLeftReturns of a collection of Infragistics.Win.UltraWinEditors.EditorButtonBase instances displayed on the left side of the editor. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyButtonsRightReturns of a collection of Infragistics.Win.UltraWinEditors.EditorButtonBase instances displayed on the right side of the editor. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyCanFocusOverridden. Returns true if the editor can take focus while in edit mode (read-only).  
Public PropertyCurrentEditTextOverridden. Returns the current text being edited without doing any validation. This will return the text currently typed in. If the editor does not have an textbox-like control, it will return the current edit value in form of text.  
Public PropertyCurrentStateReturns bit flags that signify the current editing state of the control.  
Public PropertyDataFilterIf different than null, specifies custom data filter used by the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyDefaultOwnerReturns the default embeddable editor owner, which may provide default owner-specific values for an editor (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyDisplayCharsA collection of the display characters used in the control. Only returns a valid collection if currently in edit mode and if mask has been parsed.  
Public PropertyDisplayFormattedTextWhenNotFocusedIndicates whether the mask editor displays NullText if the value entered is null and the control doesn't have focus.  
Public PropertyDisplayNullTextWhenNotFocusedIndicates whether the mask editor displays NullText if the value entered is null and the control doesn't have focus.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyEditorSharedObjectNameSpecifies name of the shared object that was defined for this editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyElementBeingEditedReturns the embeddable element that is currently in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyExpectedTypeOverridden. Default type used by the editor in the case of data filter. Null means that editor supports multiple data types and expects type to be set or provided by the owner. If EmbeddableEditorBase.DataFilter is used for conversions between Owner and Editor, this property should also be set. EditorWithMask will use specified type to set default mask in editor constructor (before first call to IEditorDataFilter.Convert).  
Public PropertyFocusedOverridden. Returns true if the editor has focus (read-only).  
Public PropertyHasButtonsLeftIndicates if there are any buttons in the collection. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyHasButtonsRightIndicates if there are any buttons in the collection. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public PropertyInsertModeReturns or sets the editing mode (insert or overstrike) of the control.  
Public PropertyIsDroppedDownReturns true if in edit mode and dropped down (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyIsInEditModeReturns true if the editor is in edit mode (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyIsValidOverridden. Returns true if the edited value is valid (read-only).  
Public PropertyKeyActionMappingsGives you the ability to reconfigure the way the control responds to user keystrokes.  
Public Propertystatic (Shared in Visual Basic)MaskDataModeRawSetValueSkipsLiteralsGets or sets whether setting the Text property of a masked edit whose MaskDataMode is set to Raw will skip over the literals in the mask when the Value or Text property is set.  
Public PropertySectionsA collection of the sections used in the control. Only returns a valid collection if currently in edit mode and if mask has been parsed.  
Public PropertySelectAllBehaviorSpecifies whether to select only the entered characters or all the characters (including prompt characters) when the editor performs the operation of select all text. The default value of the property is SelectAllCharacters.  
Public PropertySelectedTextGets or sets the currently selected text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySelectedTextBackColorReturns or sets the background color of selected text.  
Public PropertySelectedTextForeColorgets or sets the fore color of the selected text  
Public PropertySelectionLengthGets or sets the number of characters selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySelectionStartGets or sets the starting point of text selected in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySpinButtonDisplayStyleSpinButtonDisplay style dictates whether to show spin buttons and where to show them.  
Public PropertySpinButtonIntervalSettingsContains properties pertaining to the intervals used by the built-in spin button (not a SpinEditorButton).  
Public PropertySpinIncrementReturns or sets a value indicating the amount the control's Value will be incremented/decremented by when the control's spin functionality.  
Public PropertySpinWrapReturns or sets a value indicating whether the control's spin buttons should wrap its value.  
Public PropertySpinWrapBehaviorReturns or sets a value determines the behavior of the control when spinng a section past the limits of it's value.  
Public Propertystatic (Shared in Visual Basic)SpinWrapBehaviorDefaultReturns or sets a value determines the default behavior of all masked editors when spinning a section past the limits of it's value.  
Public PropertySupportsAutoSizeEditSpecifies whether the editor supports AutoSizeEdit (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsDropDownReturns true if this editor supports a dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsSelectableTextOverridden. Returns true if this editor supports selecting text.  
Public PropertySupportsSpellCheckingReturns true if this editor supports spell checking. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertySupportsValueListSpecifies whether the editor supports value list (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyTabNavigationDetermines whether the Tab key will tab between number sections in a masked editor control.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTextLengthGets the length of the text in the editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public PropertyValueOverridden. The current value being edited.  
Protected Properties
 NameDescription
Protected PropertyHasOwnDefaultContextMenuOverridden. Indicates that this editor has its own default ContextMenu, so a ContextMenu from an ancestor control is ignored  
Protected PropertySelectedTextInternalOverridden. Gets or sets the currently selected text in the editor.  
Protected PropertySelectionLengthInternalOverridden. Gets or sets the number of characters selected in the editor.  
Protected PropertySelectionStartInternalOverridden. Gets or sets the starting point of text selected in the editor.  
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Protected PropertyTextLengthInternalOverridden. Gets the length of the text in the editor.  
Protected PropertyWantsOwnerKeyEventsSpecifies whether the editor wants to receive key events from the owner while in edit mode (read-only). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public Methods
 NameDescription
Public MethodApplyValueAppearanceApplies any appearance associated with the dataVal data value. Base implementation does nothing. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodAreTouchMetricsEnabledReturns whether Touch mode is currently enabled on this control. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodBeepCalls the MessageBeep api  
Public MethodCalcDefaultCurrencyMaskOverloaded. Calculates the default mask for currency based on the cultureInfo.  
Public MethodCalcDefaultDateMaskOverloaded. Calculates the default mask for a date based on the specified IFormatProvider implementation, optionally including culture-specific separator/formatting characters.  
Public MethodCalcDefaultDoubleMaskOverloaded. Calculates the default mask for double mask based on the CultureInfo  
Public MethodCalcDefaultTimeMaskCalculates the default mask for currency based on the cultureInfo.  
Public MethodCanEditTypeOverridden. Determines if the type can be edited.  
Public MethodCanRenderTypeOverridden. Determines if the type can be rendered.  
Public MethodCloneOverridden. Creates a copy of the embeddable editor with the specified default owner.  
Public MethodCloseUpCalled to have the dropdown close up. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodComparesByValueReturns whether the owner should compare items based on their underlying value rather than their display text. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodCopyPerforms a Copy edit operation on the currently selected text, placing it on the clipboard.  
Public MethodCreateAccessibilityInstanceOverridden. Used by an editor owner to create an accessible object for a specific object managed by an editor.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodCreateUIAutomationProviderOverridden. Creates the UI automation provider.  
Public MethodCutPerforms a Cut edit operation on the currently selected text, removing it from the control and placing it on the clipboard.  
Public MethodDataValueToTextOverloaded. Overridden. Converts data value to text making use of any format provider and format strings that owner may provide. If unsuccessful, returns null.  
Public MethodDeleteDeletes currently selected text if possible and shifts characters accordingly.  
Public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
Public MethodDropDownCalled to drop down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodEnsureCaretPositionForNumericSectionsEnsures the caret position is set to the next non-filled char in the a number section so when a character is typed, caret is moved there. This only applies to number and fraction sections.  
Public MethodEnterEditModeCalled to place the editor in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodExitEditModeCalled to have the editor exit edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodFocusOverridden. Sets input focus to the editor.  
Public MethodGetDropDownStateReturns information about whether the dropdown is dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetEditStatusReturns information about whether the object is in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetEmbeddableElementOverloaded. Overridden. Called from inside the UIElement.PositionChildElements method of the parent element to create and position the embedded element or elements.  
Public MethodGetEmbeddableElementTypeOverridden. Returns the type of the EmbeddableUIElementBase derived class that this editor uses as it's embeddable element.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetMaskForTypeReturns the default mask used for editing values of dataType. If the dataType is not supported then returns null.  
Public MethodGetMinimumTouchFriendlyHeightReturns the minimum height needed to display in touch-friendly mode. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public MethodGetSizeOverloaded. Overridden. Used to determine the size preferred/required by the editor.  
Public MethodGetSpellCheckTargetGets the current spell check target (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodGetTextReturns the text for the object using the specified mask mode.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIsInputKeyOverridden. Returns whether the key is used by the editor.  
Public Methodstatic (Shared in Visual Basic)IsMaskValidForDataTypeOverloaded. Returns true if mask is valid for the type.  
Public Methodstatic (Shared in Visual Basic)IsValidPromptCharIndicates if the specified character is valid for use as a prompt character for the EditorWithMask.  
Public MethodIsValidValueOverridden. Returns true if the edited value is valid (read-only). If the value is invalid, the 'errorMessage' out parameter can contain an error message.  
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodOnTouchMetricsChangedCalled when the TouchProvider's state or registration has changed (e.g. when its Visble or Enabled property has changed). (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodPastePerforms a Paste edit operation.  
Public MethodPerformActionSimulates user interaction with the control.  
Public MethodResetButtonsLeftUsed to reset the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsLeft collection (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public MethodResetButtonsRightUsed to reset the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsRight collection (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public MethodResetSelectedTextBackColorReset TextSlectionBackColor  
Public MethodResetSelectedTextForeColorReset TextSlectionForeColor  
Public MethodResetSpinButtonDisplayStyleReset SpinButtonDisplayStyle  
Public MethodScrollFirstFilledCharacterIntoViewScrolls the first filled character in the mask into view. If no characters in the mask are filled, this will do nothing.  
Public MethodSelectAllOverridden. Selects all the text in the control.  
Public MethodSetTextOverloaded. Sets the text.  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public Methodstatic (Shared in Visual Basic)SupportsDataTypeReturns true if the data type is supported by the EditorWithMask, false otherwise.  
Public MethodToggleInsertModeToggles between insert and overstrike mode.  
Public MethodValueToDataValueOverloaded. Converts val to an object of type returned by owner's GetDataType method. If it can not convert, it returns null. It makes use of any format provided and format string off the owner. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodAdjustSizeForOwnerBordersAdjusts the specified Size to account for the owner-specified borders (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodAdjustSizeForOwnerPaddingAdjusts (increases) the specified size for the owner padding. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodDoCloseUpCloses the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodDoDropDownDrops down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetAutoConvertedDestinationValueOverride this in specific editor to provide automatic conversions for that editor. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetDisplayValueOverridden. Provides editor-specific display value.  
Protected MethodGetEditorValueOverridden. Provides editor-specific editor value.  
Protected MethodGetInkProviderGets the InkProvider registered for the owner's container. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodGetTextSizeOfValueReturns the size required to render the editor's value for the specified owner and ownerContext. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodHasAnySpinButtonsReturns true if the editor displays any spin buttons. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodHookOwnersKeyEventsStart listening to the owner's key events (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodInitializeFromOverridden. Used to initialize the state of the object based on another editor instance.  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodIsDestinationValueValidOverridden. Checks validity of converted values.  
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnAfterCloseUpCalled after the dropdown has been closed up. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnAfterDropDownCalled after the dropdown has been dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnAfterEditorButtonCheckStateChangedUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.AfterEditorButtonCheckStateChanged event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnAfterEditorButtonCloseUpUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.AfterEditorButtonCloseUp event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnAfterEnterEditModeOverridden. Called after edit mode has been entered.  
Protected MethodOnAfterExitEditModeOverridden. Called after edit mode has been exited.  
Protected MethodOnBeforeDropDownCalled before the dropdown has been dropped down. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeEditorButtonCheckStateChangedUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.BeforeEditorButtonCheckStateChanged event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnBeforeEditorButtonDropDownUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.BeforeEditorButtonDropDown event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnBeforeEnterEditModeCalled before edit mode has been entered. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Protected MethodOnBeforeExitEditModeOverridden. Called before edit mode has been exited.  
Protected MethodOnDisposeOverridden. Called when the editor is disposed  
Protected MethodOnEditorButtonClickUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.EditorButtonClick event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnEditorSpinButtonClickUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.EditorSpinButtonClick event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnInitializeEditorButtonCheckStateUsed to invoke the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.InitializeEditorButtonCheckState event (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnOwnerKeyDownOverridden. Occurs when the owner gets a key down while in edit mode.  
Protected MethodOnOwnerKeyPressOverridden. Occurs when the owner gets a key press while in edit mode.  
Protected MethodOnOwnerKeyUpOverridden. Occurs when the owner gets a key up while in edit mode.  
Protected MethodOnSubObjectPropChangedOverridden. Invoked when a property on a subobject has changed.  
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeButtonsLeftIndicates if the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsLeft property should be serialized (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodShouldSerializeButtonsRightIndicates if the Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase.ButtonsRight property should be serialized (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Protected MethodUnhookOwnersKeyEventsUnhook from the owner's key events (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public Events
 NameDescription
Public EventAfterCloseUpOccurs after closing up the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterDropDownOccurs after dropping down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterEditorButtonCheckStateChangedInvoked after the Infragistics.Win.UltraWinEditors.StateEditorButton.CheckState has changed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventAfterEditorButtonCloseUpInvoked when a dropdown editor button has closed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventAfterEnterEditModeOccurs after entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventAfterExitEditModeOccurs after exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeDropDownOccurs before dropping down the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeEditorButtonCheckStateChangedInvoked before the Infragistics.Win.UltraWinEditors.StateEditorButton.CheckState has changed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventBeforeEditorButtonDropDownInvoked before a dropdown editor button has been displayed. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventBeforeEnterEditModeOccurs before entering edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventBeforeExitEditModeOccurs before exiting edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventEditorButtonAddedInvoked when an editor button is added to the collection (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventEditorButtonClickInvoked when an editor button is clicked (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventEditorSpinButtonClickInvoked when an spin editor button is clicked (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventInitializeEditorButtonCheckStateInvoked when the checkstate of an editor button should be initialized. (Inherited from Infragistics.Win.UltraWinEditors.EmbeddableEditorButtonBase)
Public EventInvalidCharOccurs when the user types a character that fails mask validation.  
Public EventInvalidOperationOccurs when the user attempts to perform an operation that cannot be completed.  
Public EventKeyDownOccurs on a key down while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyPressOccurs on a key press while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventKeyUpOccurs on a key up while the editor is in edit mode and the editor has focus. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventSelectionChangedOccurs when a new value is selected from the dropdown. (Inherited from Infragistics.Win.EmbeddableEditorBase)
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Public EventValueChangedOccurs when the value is changed in edit mode. (Inherited from Infragistics.Win.EmbeddableEditorBase)
See Also