Class GridMaskColumn

Represents a column that displays the masked data in its cell content.

Inheritance
System.Object
SfGridColumnBase<SfGridBase>
GridColumnBase
GridColumn
GridTextColumnBase
GridMaskColumn
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class GridMaskColumn : GridTextColumnBase, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinition

Constructors

GridMaskColumn()

Initializes a new instance of the GridMaskColumn class.

Declaration
public GridMaskColumn()

Fields

DateSeparatorProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.DateSeparator dependency property.

Declaration
public static readonly DependencyProperty DateSeparatorProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.DateSeparator dependency property.

DecimalSeparatorProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.DecimalSeparator dependency property.

Declaration
public static readonly DependencyProperty DecimalSeparatorProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.DecimalSeparator dependency property.

IsNumericProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.IsNumeric dependency property.

Declaration
public static readonly DependencyProperty IsNumericProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.IsNumeric dependency property.

MaskFormatProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.MaskFormat dependency property.

Declaration
public static readonly DependencyProperty MaskFormatProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.MaskFormat dependency property.

MaskProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.Mask dependency property.

Declaration
public static readonly DependencyProperty MaskProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.Mask dependency property.

PromptCharProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.PromptChar dependency property.

Declaration
public static readonly DependencyProperty PromptCharProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.PromptChar dependency property.

SelectTextOnFocusProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.SelectTextOnFocus dependency property.

Declaration
public static readonly DependencyProperty SelectTextOnFocusProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.SelectTextOnFocus dependency property.

TimeSeparatorProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridMaskColumn.TimeSeparator dependency property.

Declaration
public static readonly DependencyProperty TimeSeparatorProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridMaskColumn.TimeSeparator dependency property.

Properties

DateSeparator

Gets or sets the string that separates the components of date,that is, day ,month and year in GridMaskColumn.

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

The string that separates the components of date,that is, day ,month and year in GridMaskColumn.

DecimalSeparator

Gets or sets the string that separates groups of digits to the left of the decimal in values.

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

The string that separates groups of digits to the left of the decimal in values.

IsNumeric

Gets or sets a value that indicates whether the GridMaskColumn that loads the numeric values in it.

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

true if the GridMaskColumn loaded with numeric values; otherwise , false . The default value is false.

Mask

Gets or sets the input mask to use at runtime.

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

A string that representing the current mask. The default value is the empty string which allows any input.

MaskFormat

Gets or sets the format of masked input.

Declaration
public MaskFormat MaskFormat { get; set; }
Property Value
Type Description
MaskFormat

One of the MaskFormat that specifies the format of masked input. The default value is ExcludePromptAndLiterals.

PromptChar

Gets or sets the character used to represent the absence of user input in GridMaskColumn.

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

The character used to prompt the user for input. The default is an underscore (_).

SelectTextOnFocus

Gets or sets a value that indicates whether the entire cell value is selected when it receives focus.

Declaration
[Obsolete]
public bool SelectTextOnFocus { get; set; }
Property Value
Type Description
System.Boolean

true if the entire cell value is selected when it receives focus ; otherwise , false. The default value is false.

TimeSeparator

Gets or sets the string that separates the components of time, that is, the hour , minutes and seconds .

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

The string that separates the components of time, that is, the hour , minutes and seconds .

Methods

SetDisplayBindingConverter()

Sets the converter for the of column.

Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks

You can override this method to specify the converter for .

UpdateBindingBasedOnAllowEditing()

Updates the binding for the AllowEdit property changes in the GridMaskColumn.

Declaration
protected override void UpdateBindingBasedOnAllowEditing()
Overrides

Implements

System.IDisposable