MaskPatternField Class

Represents GrapeCity.Windows.InputMan.Fields.MaskPatternField class which can filter input text based on pattern for GrapeCity.Windows.InputMan.GcMask.

Inheritance

object

Visual

MaskPatternField

Implements

IAnimatable

IFrameworkInputElement

IInputElement

IQueryAmbient

ISupportInitialize

Namespace: GrapeCity.Wpf.SpreadSheet.CellType.Editors

Assembly: GrapeCity.Wpf.SpreadSheet.CellType.dll

Syntax

public sealed class MaskPatternField : MaskField, IAnimatable, IFrameworkInputElement, IInputElement, IQueryAmbient, ISupportInitialize

Public NotInheritable Class MaskPatternField
    Inherits MaskField
    Implements IAnimatable, IFrameworkInputElement, IInputElement, IQueryAmbient, ISupportInitialize

Remarks

MaskPatternField support following patterns:
Pattern Description
\Ａ \Ａ Upper case DBCS alphabet (A-Z).
\ａ \ａ Lower case DBCS alphabet (a-z).
\Ｄ \Ｄ Matches any DBCS decimal digit. Same as [０-９].
\Ｂ \Ｂ Matches DBCS binary. Same as [０-１].
\Ｘ \Ｘ Matches DBCS hexadecimal. Same as [０-９Ａ-Ｆａ-ｆ].
\Ｗ \Ｗ Matches any DBCS word character. It is same as [ａ-ｚＡ-Ｚ＿０-９].
\Ｋ \Ｋ DBCS Katakana.
\Ｊ \Ｊ Hiragana.
\Ｚ \Ｚ All DBCS characters.
\Ｎ \Ｎ Matches DBCS big Katakana.
\Ｇ \Ｇ Matches DBCS big Hiragana.
\Ｔ \Ｔ Only surrogate char.
\A \A Matches any upper case alphabet [A-Z].
\a \a Matches any lower case alphabet [a-z].
\D \D Matches any decimal digit. Same as [0-9].
\B \B Matches binary. Same as [0-1].
\X \X Matches hexadecimal. Same as [0-9A-Fa-f].
\W \W Matches any word character. It is same as [a-zA-Z_0-9].
\K \K SBCS Katakana.
\H \H Matches all SBCS characters.
\N \N Matches all SBCS big Katakana.

Pattern	Description
\Ａ	\Ａ Upper case DBCS alphabet (A-Z).
\ａ	\ａ Lower case DBCS alphabet (a-z).
\Ｄ	\Ｄ Matches any DBCS decimal digit. Same as [０-９].
\Ｂ	\Ｂ Matches DBCS binary. Same as [０-１].
\Ｘ	\Ｘ Matches DBCS hexadecimal. Same as [０-９Ａ-Ｆａ-ｆ].
\Ｗ	\Ｗ Matches any DBCS word character. It is same as [ａ-ｚＡ-Ｚ＿０-９].
\Ｋ	\Ｋ DBCS Katakana.
\Ｊ	\Ｊ Hiragana.
\Ｚ	\Ｚ All DBCS characters.
\Ｎ	\Ｎ Matches DBCS big Katakana.
\Ｇ	\Ｇ Matches DBCS big Hiragana.
\Ｔ	\Ｔ Only surrogate char.
\A	\A Matches any upper case alphabet [A-Z].
\a	\a Matches any lower case alphabet [a-z].
\D	\D Matches any decimal digit. Same as [0-9].
\B	\B Matches binary. Same as [0-1].
\X	\X Matches hexadecimal. Same as [0-9A-Fa-f].
\W	\W Matches any word character. It is same as [a-zA-Z_0-9].
\K	\K SBCS Katakana.
\H	\H Matches all SBCS characters.
\N	\N Matches all SBCS big Katakana.

note

When user set AutoConvert to false, the field doesn't convert the text into valid chars.

Supported VisualState list:
VisualStateGroup Name
VisualState Name
Description
CommonStates
Normal
Represents the visual appearance when control is in normal state.
CommonStates
Disabled
Represents the visual appearance when IsEnabled is false.
CommonStates
MouseOver
Represents the visual appearance when IsMouseOver is true.
ActiveStates
Active
Represents the visual appearance when IsActive is true.
ActiveStates
Inactive
Represents the visual appearance when IsActive is false.
InputStates
Full
Represents the visual appearance when IsFull is true.
InputStates
Completed
Represents the visual appearance when IsCompleted is true.
InputStates
Empty
Represents the visual appearance when IsEmpty is true.
InputStates
Part
Represents the visual appearance when IsFull, IsCompleted and IsEmpty all are false.
ValidationStates
Valid
Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns false.
ValidationStates
InvalidFocused
Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns true and control has focus.
ValidationStates
InvalidUnfocused
Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns true and control has no focus.

VisualStateGroup Name	VisualState Name	Description
CommonStates	Normal	Represents the visual appearance when control is in normal state.
CommonStates	Disabled	Represents the visual appearance when IsEnabled is false.
CommonStates	MouseOver	Represents the visual appearance when IsMouseOver is true.
ActiveStates	Active	Represents the visual appearance when IsActive is true.
ActiveStates	Inactive	Represents the visual appearance when IsActive is false.
InputStates	Full	Represents the visual appearance when IsFull is true.
InputStates	Completed	Represents the visual appearance when IsCompleted is true.
InputStates	Empty	Represents the visual appearance when IsEmpty is true.
InputStates	Part	Represents the visual appearance when IsFull, IsCompleted and IsEmpty all are false.
ValidationStates	Valid	Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns false.
ValidationStates	InvalidFocused	Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns true and control has focus.
ValidationStates	InvalidUnfocused	Represents the visual appearance when System.Windows.Controls.Validation.GetHasError(System.Windows.DependencyObject) returns true and control has no focus.

Constructors

Name	Description
MaskPatternField()	Initializes a new instance of the MaskPatternField class.
MaskPatternField(string, int, int)	Initializes a new instance of the MaskPatternField class.

Fields

Name	Description
AutoConvertProperty	Identifies the GrapeCity.Windows.InputMan.Fields.MaskPatternField.AutoConvert dependency property.
MaxLengthProperty	Identifies the GrapeCity.Windows.InputMan.Fields.MaskPatternField.MaxLength dependency property.
MinLengthProperty	Identifies the GrapeCity.Windows.InputMan.Fields.MaskPatternField.MinLength dependency property.
PatternProperty	Identifies the GrapeCity.Windows.InputMan.Fields.MaskPatternField.Pattern dependency property.
PromptCharProperty	Identifies the GrapeCity.Windows.InputMan.Fields.MaskPatternField.PromptChar dependency property.

Properties

Name	Description
AutoConvert	Gets or sets a value indicating whether MaskPatternField can auto convert. This is a dependency property.
MaxLength	Gets or sets the maximum length of the MaskPatternField. This is a dependency property.
MinLength	Gets or sets the minimum length of the MaskPatternField. This is a dependency property.
Pattern	Gets the pattern of MaskPatternField. This is a dependency property.
PromptChar	Gets or sets the prompt char of the field. This is a dependency property.

Methods

Name	Description
Activate()	Attempts to activate current field and put caret to default caret position.
EndInit()	Indicates that the initialization process for the element is complete.