Class GridMaskEditInfo

Provides a StyleInfoSubObjectBase object for masked edit properties in a cell.

Each property in this sub object can be configured individually. Properties that have not been initialized will inherit default values from a base style.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
StyleInfoBase
StyleInfoSubObjectBase
GridMaskEditInfo
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridMaskEditInfo : StyleInfoSubObjectBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

Constructors

GridMaskEditInfo()

Initializes a new instance for GridMaskEditInfo class.

Declaration
public GridMaskEditInfo()

GridMaskEditInfo(StyleInfoSubObjectIdentity)

Initializes a new GridMaskEditInfo object and associates it with an existing GridStyleInfoSubObjectIdentity.

Declaration
public GridMaskEditInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A GridStyleInfoSubObjectIdentity that holds the indentity for this GridMaskEditInfo.

GridMaskEditInfo(StyleInfoSubObjectIdentity, GridMaskEditInfoStore)

Initializes a new GridMaskEditInfo object and associates it with an existing GridStyleInfoSubObjectIdentity.

Declaration
public GridMaskEditInfo(StyleInfoSubObjectIdentity identity, GridMaskEditInfoStore store)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A GridStyleInfoSubObjectIdentity that holds the indentity for this GridMaskEditInfo.
GridMaskEditInfoStore store

A GridMaskEditInfoStore that holds data for this GridMaskEditInfo. All changes in this style object will be saved in the GridMaskEditInfoStore object.

Properties

AllowPrompt

Gets or sets a value indicating whether the prompt character can be allowed to be entered as an input character.

Declaration
public bool AllowPrompt { get; set; }
Property Value
Type
System.Boolean

ClipMode

Gets or sets the format of the text that will be returned by the MaskedEditBox control. The nature of the formatting is set the the ClipModes type.

Declaration
public ClipModes ClipMode { get; set; }
Property Value
Type
ClipModes

DateSeparator

Gets or sets the character to use when a date separator position is specified.

Declaration
public char DateSeparator { get; set; }
Property Value
Type
System.Char

DateTimeFormatInfoObject

Gets or sets the System.Globalization.DateTimeFormatInfo provides the necessary globalization information for the properties that rely on the datetime settings.

Declaration
public DateTimeFormatInfo DateTimeFormatInfoObject { get; set; }
Property Value
Type
System.Globalization.DateTimeFormatInfo

DecimalSeparator

Gets or sets the character to use when a decimal separator position is specified.

Declaration
public char DecimalSeparator { get; set; }
Property Value
Type
System.Char

Default

Gets a default GridMaskEditInfo to be used with a default style.

Declaration
public static GridMaskEditInfo Default { get; }
Property Value
Type
GridMaskEditInfo
Remarks

The Default of the GridStyleInfo class will return the validation info that this method generates through its overridden version of GetDefaultStyle().

Default settings are:

PropertyValue
AllowPromptFalse
ClipModeClipModes.IncludeInternals
DateSeparator'/'
DateTimeFormatInfoObjectCulture.DateTimeFormat
DecimalSeparator'.'
MaskString.Empty
MaxValueint.MaxValue
MinValue0
NumberFormatInfoObjectCulture.NumberFormatInfo
PaddingCharacter' '
PassivePromptCharacter' '
SpecialCultureValueSpecialCultureValues.None
ThousandSeparator','
TimeSeparator':'
UsageModeMaskedUsageMode.Normal
UseLocaleDefaultfalse
UseUserOverridetrue

HasAllowPrompt

Gets a value indicating whether AllowPrompt property is initialized.

Declaration
public bool HasAllowPrompt { get; }
Property Value
Type
System.Boolean

HasClipMode

Gets a value indicating whether ClipMode property is initialized.

Declaration
public bool HasClipMode { get; }
Property Value
Type
System.Boolean

HasDateSeparator

Gets a value indicating whether DateSeparator property is initialized.

Declaration
public bool HasDateSeparator { get; }
Property Value
Type
System.Boolean

HasDateTimeFormatInfoObject

Gets a value indicating whether DateTimeFormatInfoObject property is initialized.

Declaration
public bool HasDateTimeFormatInfoObject { get; }
Property Value
Type
System.Boolean

HasDecimalSeparator

Gets a value indicating whether the DecimalSeparator property is initialized.

Declaration
public bool HasDecimalSeparator { get; }
Property Value
Type
System.Boolean

HasMask

Gets a value indicating whether the Mask property is initialized.

Declaration
public bool HasMask { get; }
Property Value
Type
System.Boolean

HasMaxValue

Gets a value indicating whether the MaxValue property is initialized.

Declaration
public bool HasMaxValue { get; }
Property Value
Type
System.Boolean

HasMinValue

Gets a value indicating whether the MinValue property is initialized.

Declaration
public bool HasMinValue { get; }
Property Value
Type
System.Boolean

HasNumberFormatInfoObject

Gets a value indicating whether the NumberFormatInfoObject property is initialized.

Declaration
public bool HasNumberFormatInfoObject { get; }
Property Value
Type
System.Boolean

HasPaddingCharacter

Gets a value indicating whether the PaddingCharacter property is initialized.

Declaration
public bool HasPaddingCharacter { get; }
Property Value
Type
System.Boolean

HasPassivePromptCharacter

Gets a value indicating whether PassivePromptCharacter property is initialized.

Declaration
public bool HasPassivePromptCharacter { get; }
Property Value
Type
System.Boolean

HasPromptCharacter

Gets a value indicating whether PromptCharacter property is initialized.

Declaration
public bool HasPromptCharacter { get; }
Property Value
Type
System.Boolean

HasSpecialCultureValue

Gets a value indicating whether SpecialCultureValue property is initialized.

Declaration
public bool HasSpecialCultureValue { get; }
Property Value
Type
System.Boolean

HasThousandSeparator

Gets a value indicating whether the ThousandSeparator property is initialized.

Declaration
public bool HasThousandSeparator { get; }
Property Value
Type
System.Boolean

HasTimeSeparator

Gets a value indicating whether the TimeSeparator property is initialized.

Declaration
public bool HasTimeSeparator { get; }
Property Value
Type
System.Boolean

HasUsageMode

Gets a value indicating whether UsageMode property is initialized.

Declaration
public bool HasUsageMode { get; }
Property Value
Type
System.Boolean

HasUseLocaleDefault

Gets a value indicating whether the UseLocaleDefault property is initialized.

Declaration
public bool HasUseLocaleDefault { get; }
Property Value
Type
System.Boolean

HasUseUserOverride

Gets a value indicating whether UseUserOverride property is initialized.

Declaration
public bool HasUseUserOverride { get; }
Property Value
Type
System.Boolean

Mask

Gets or sets the mask string for the MaskedEditBox control.

Declaration
public string Mask { get; set; }
Property Value
Type
System.String

MaxValue

Gets or sets the Maximum Value that can be set through the MaskedEditBox.

Declaration
public decimal MaxValue { get; set; }
Property Value
Type
System.Decimal

MinValue

Gets or sets the Minimum Value that can be set through the MaskedEditBox.

Declaration
public decimal MinValue { get; set; }
Property Value
Type
System.Decimal

NumberFormatInfoObject

Gets or sets the System.Globalization.NumberFormatInfo provides the necessary globalization information for the properties that rely on these settings.

Declaration
public NumberFormatInfo NumberFormatInfoObject { get; set; }
Property Value
Type
System.Globalization.NumberFormatInfo

PaddingCharacter

Gets or sets the character that will be used instead of mask characters when the mask position has not been filled.

Declaration
public char PaddingCharacter { get; set; }
Property Value
Type
System.Char
Examples

This example shows how to specify the character that will be used instead of mask characters when the mask position has not been filled.

this.gridControl1[4, 8].CellType = GridCellTypeName.MaskEdit;
 this.gridControl1[4, 8].MaskEdit.Mask = "###-###########";
 //sets the character that will be used instead of mask characters when the mask position has not been filled. 
this.gridControl1.TableStyle.MaskEdit.PaddingCharacter = 'T';
Me.gridControl1(4, 8).CellType = GridCellTypeName.MaskEdit
Me.gridControl1(4, 8).MaskEdit.Mask = "###-###########"
'sets the character that will be used instead of mask characters when the mask position has not been filled. 
Me.gridControl1.TableStyle.MaskEdit.PaddingCharacter = "T"

PassivePromptCharacter

Gets or sets the character that will be used instead of mask characters when the mask position has not been filled (when the control does not have the focus).

Declaration
public char PassivePromptCharacter { get; set; }
Property Value
Type
System.Char

PromptCharacter

Gets or sets the character that will be used instead of mask characters when the mask position has not been filled.

Declaration
public char PromptCharacter { get; set; }
Property Value
Type
System.Char

SpecialCultureValue

Gets or sets the mode for the cultures.

Declaration
public SpecialCultureValues SpecialCultureValue { get; set; }
Property Value
Type
SpecialCultureValues

ThousandSeparator

Gets or sets the character to use when a thousands separator position is specified.

Declaration
public char ThousandSeparator { get; set; }
Property Value
Type
System.Char

TimeSeparator

Gets or sets the character to use when a time separator position is specified.

Declaration
public char TimeSeparator { get; set; }
Property Value
Type
System.Char

UsageMode

Gets or sets the usage mode for the MaskedEditBox.

Declaration
public MaskedUsageMode UsageMode { get; set; }
Property Value
Type
MaskedUsageMode

UseLocaleDefault

Gets or sets a value indicating whether the individual globalization property changes are to be ignored. If set to True, the individual values will be ignored and the locale default will be used.

Declaration
public bool UseLocaleDefault { get; set; }
Property Value
Type
System.Boolean

UseUserOverride

Gets or sets a value indicating whether to UseUserOverride parameter for CultureInfo.

Declaration
public bool UseUserOverride { get; set; }
Property Value
Type
System.Boolean

Methods

GetDefaultStyle()

Returns Default.

Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type Description
StyleInfoBase

A GridMaskEditInfo object with default values.
Overrides

MakeCopy(StyleInfoBase, StyleInfoProperty)

Creates an exact copy of the current object.

Declaration
public override IStyleInfoSubObject MakeCopy(StyleInfoBase newOwner, StyleInfoProperty sip)
Parameters
Type Name Description
StyleInfoBase newOwner

The new owner style object for the copied object.
StyleInfoProperty sip

An identifier for the current object.
Returns
Type Description
IStyleInfoSubObject

A copy of the current object.
Overrides

ResetAllowPrompt()

Resets the AllowPrompt property.

Declaration
public void ResetAllowPrompt()

ResetClipMode()

Resets the ClipModeProperty property.

Declaration
public void ResetClipMode()

ResetDateSeparator()

Resets the DateSeparatorProperty property.

Declaration
public void ResetDateSeparator()

ResetDateTimeFormatInfoObject()

Resets the DateTimeFormatInfoObjectProperty property.

Declaration
public void ResetDateTimeFormatInfoObject()

ResetDecimalSeparator()

Resets the DecimalSeparatorProperty property.

Declaration
public void ResetDecimalSeparator()

ResetMask()

Resets the MaskProperty property.

Declaration
public void ResetMask()

ResetMaxValue()

Resets the MaxValueProperty property.

Declaration
public void ResetMaxValue()

ResetMinValue()

Resets the MinValueProperty property.

Declaration
public void ResetMinValue()

ResetNumberFormatInfoObject()

Resets the NumberFormatInfoObjectProperty property.

Declaration
public void ResetNumberFormatInfoObject()

ResetPaddingCharacter()

Resets the PaddingCharacterProperty property.

Declaration
public void ResetPaddingCharacter()

ResetPassivePromptCharacter()

Resets the PassivePromptCharacterProperty property.

Declaration
public void ResetPassivePromptCharacter()

ResetPromptCharacter()

Resets the PromptCharacterProperty property.

Declaration
public void ResetPromptCharacter()

ResetSpecialCultureValue()

Resets the SpecialCultureValueProperty property.

Declaration
public void ResetSpecialCultureValue()

ResetThousandSeparator()

Resets the ThousandSeparatorProperty property.

Declaration
public void ResetThousandSeparator()

ResetTimeSeparator()

Resets the TimeSeparatorProperty property.

Declaration
public void ResetTimeSeparator()

ResetUsageMode()

Resets the UsageModeProperty property.

Declaration
public void ResetUsageMode()

ResetUseLocaleDefault()

Resets the UseLocaleDefaultProperty property.

Declaration
public void ResetUseLocaleDefault()

ResetUseUserOverride()

Resets the UseUserOverride property.

Declaration
public void ResetUseUserOverride()

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable