dotnet-api

C1.Win.Input.Formating.MaskInfo

MaskInfo Class

Contains edit mask settings.

Inheritance

object

MaskInfo

Implements

ISupportInitialize

Namespace: C1.Win.Input.Formating

Assembly: C1.Win.Input.8.dll

Syntax

[TypeConverter(typeof(GenericInheritConverter))]
public class MaskInfo : ISupportInitialize

Properties

Name	Description
AutoTabWhenFilled	Gets or sets a value that indicates whether the focus automatically moves to the next control when the mask is filled.
CaseSensitive	Gets or sets a value that indicates whether string comparisons within the mask literals are case-sensitive.
Content	Text entered by the user without literals (mask literals stripped).
CopyWithLiterals	Gets or sets a value that indicates whether the text copied to the clipboard includes literals.
CustomPlaceholders	Gets the collection of user-defined mask characters.
EditMask	Gets or sets the edit mask string restricting user input.
EditablePositionCount	Returns the number of editable positions in the edit mask.
EffectiveText	Text in a readable format, with literals and without blanks.
EmptyAsNull	Gets or sets a value that indicates whether empty strings are interpreted as null values (DbNull).
ErrorMessage	Gets or sets a value that indicates whether a error message shown in the standard message box and/or if an exception occurs.
Inherit	Gets or sets a value that manages inheritance of the MaskInfo properties from the host control properties.
IsRegexpPatternRecognized	Gets a value indicates whether the mask pattern in regular expression style was succesfully recognized or not.
PromptChar	Character displayed on empty mask positions in edit mode.
RegexpEditMask	A string representing the mask in regular expression style with custom keywords.
RegexpMaskType	Gets ot sets a value that indicate RegexpMaskType of the mask in regular expression style.
SaveBlanks	Gets or sets a value that indicates whether the stored text includes blank positions as StoredEmptyChar.
SaveLiterals	Gets or sets a value that indicates whether the stored text includes literals.
ShowLiterals	Gets or sets the literal display method.
SkipOptional	Gets or sets a value that indicates whether optional mask positions are automatically skipped until the first position allowing the typed character.
StoredContent	The stored string obtained from the user input string.
StoredEmptyChar	Gets or sets a value that indicates whether the сharacter stored in empty mask positions.

Methods

Name	Description
GetContent(string, bool, bool, char)	Returns the string containing characters entered by the user, including those on optional positions that were left blank (skipped).
GetDisplayText(string, bool)	Returns a string formatted for display using edit mask.
GetStoredText(string)	Returns the string that will be stored in the database, in accordance with current values of SaveLiterals, SaveBlanks and StoredEmptyChar properties.
IsMaskedMode()	Returns True if EditMask is non-empty and the control is in edit mode.
IsValid()	Returns True if the input string is valid with respect to the edit mask.
Reset()	Resets whole MaskInfo property of base control
ResetCaseSensitive()	Restores the default value of the CaseSensitive property.
ResetContent()	Resets the text to the string representing a DBNull value.
ResetCustomPlaceholders()	Restores the default value of the CustomPlaceholders property.
ResetEmptyAsNull()	Restores the default value of the EmptyAsNull property.
ResetErrorMessage()	Restores the default value of the ErrorMessage property.
ShouldSerializeCaseSensitive()	Specifies whether to save the value of the CaseSensitive property.
ShouldSerializeCustomPlaceholders()	Specifies whether to save the value of the CustomPlaceholders property.
ShouldSerializeEditMask()	Specifies whether to save the value of the EditMask property.
ShouldSerializeEmptyAsNull()	Specifies whether to save the value of the EmptyAsNull property.
ShouldSerializeErrorMessage()	Specifies whether to save the value of the ErrorMessage property.