menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCellMaskRenderer - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridCellMaskRenderer

    Inheritance
    System.Object
    GridCellRendererBase
    GridVirtualizingCellRendererBase<System.Windows.Controls.TextBlock, MaskedTextBox>
    GridVirtualizingCellRenderer<System.Windows.Controls.TextBlock, MaskedTextBox>
    GridCellMaskRenderer
    Implements
    IGridCellRenderer
    System.IDisposable
    Inherited Members
    GridCellRendererBase.Arrange(RowColumnIndex, FrameworkElement, Rect)
    GridCellRendererBase.BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
    GridCellRendererBase.BindingExpression
    GridCellRendererBase.CanUpdateBinding(GridColumn)
    GridCellRendererBase.CanValidate()
    GridCellRendererBase.ClearRecycleBin()
    GridCellRendererBase.CommitUnBoundCellValue(Object, GridColumn, Object)
    GridCellRendererBase.CurrentCellElement
    GridCellRendererBase.CurrentCellIndex
    GridCellRendererBase.CurrentCellRendererElement
    GridCellRendererBase.DataGrid
    GridCellRendererBase.Dispose()
    GridCellRendererBase.Dispose(Boolean)
    GridCellRendererBase.HasCurrentCellState
    GridCellRendererBase.IGridCellRenderer.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    GridCellRendererBase.IGridCellRenderer.UpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.IsDropDownable
    GridCellRendererBase.IsEditable
    GridCellRendererBase.IsFocused
    GridCellRendererBase.IsFocusible
    GridCellRendererBase.IsInEditing
    GridCellRendererBase.Measure(RowColumnIndex, FrameworkElement, Size)
    GridCellRendererBase.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridCellRendererBase.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridCellRendererBase.OnPrepareUIElements()
    GridCellRendererBase.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridCellRendererBase.OnRenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridCellRendererBase.OnRenderCellBorder(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridCellRendererBase.OnRenderContent(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, Object)
    GridCellRendererBase.OnRenderCurrentCell(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridCellRendererBase.OnUnloadUIElements(DataColumnBase)
    GridCellRendererBase.OnUpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.OnUpdateStyleInfo(DataColumnBase, Object)
    GridCellRendererBase.PrepareUIElements(DataColumnBase, Object, Boolean)
    GridCellRendererBase.PreviewInputText
    GridCellRendererBase.PreviewTextInput(TextCompositionEventArgs)
    GridCellRendererBase.RaiseCurrentCellValidatedEvent(SfDataGrid, GridColumn, Object, Object)
    GridCellRendererBase.RaiseCurrentCellValidatingEvent(SfDataGrid, GridColumn, Object, Object, Object)
    GridCellRendererBase.RaiseCurrentCellValueChangedEvent(SfDataGrid, DataColumnBase)
    GridCellRendererBase.RenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridCellRendererBase.ResetCurrentCellState()
    GridCellRendererBase.SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, GridColumn, DataColumnBase)
    GridCellRendererBase.SetFocus(Boolean)
    GridCellRendererBase.SetFocus(FrameworkElement, Boolean)
    GridCellRendererBase.SupportsRenderOptimization
    GridCellRendererBase.UnloadUIElements(DataColumnBase)
    GridCellRendererBase.UpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UpdateCellStyle(DataColumnBase, Object)
    GridCellRendererBase.UpdateCurrentCellState(FrameworkElement, Boolean)
    GridCellRendererBase.UpdateSource(FrameworkElement)
    GridCellRendererBase.UpdateToolTip(DataColumnBase)
    GridCellRendererBase.UseOnlyRendererElement
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.CurrentRendererValueChanged()
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.EditorType
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.OnInitializeDisplayElement(DataColumnBase, TextBlock, Object)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.OnInitializeEditElement(DataColumnBase, MaskedTextBox, Object)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.OnInitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.OnUpdateDisplayBinding(DataColumnBase, TextBlock, Object)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.OnUpdateEditBinding(DataColumnBase, MaskedTextBox, Object)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.OnUpdateTemplateBinding(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.TextAlignmentToHorizontalAlignment(TextAlignment)
    GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>.UpdateToolTip(DataColumnBase)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.AllowRecycle
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.ClearRecycleBin()
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.DisplayRecycleBin
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.Dispose(Boolean)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.DrawFormattedText(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, String)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.DrawGlyphs(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, String)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.EditRecycleBin
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.EndEdit(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.InitializeCellStyle(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.InitializeDisplayElement(DataColumnBase, TextBlock, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.InitializeEditElement(DataColumnBase, MaskedTextBox, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.InitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnCreateDisplayUIElement()
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnCreateEditUIElement()
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnCreateTemplateUIElement()
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnEditElementLoaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnEditElementLostFocus(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnEditElementUnloaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnEditingComplete(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnEnteredEditMode(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnRenderCell(DrawingContext, Rect, DataColumnBase, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnRenderCellBorder(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnRenderContent(DrawingContext, Rect, Geometry, DataColumnBase, GridCell, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnRenderCurrentCell(DrawingContext, Rect, Geometry, DataColumnBase, GridCell)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnUnloadUIElements(DataColumnBase)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnUnwireDisplayUIElement(TextBlock)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnUnwireEditUIElement(MaskedTextBox)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnUnwireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnUpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnUpdateStyleInfo(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnWireDisplayUIElement(TextBlock)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnWireEditUIElement(MaskedTextBox)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.OnWireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<TextBlock, MaskedTextBox>.TemplateRecycleBin
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Syncfusion.UI.Xaml.Grid.Cells
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public class GridCellMaskRenderer : GridVirtualizingCellRenderer<TextBlock, MaskedTextBox>, IGridCellRenderer, IDisposable

    Constructors

    GridCellMaskRenderer()

    Declaration
    public GridCellMaskRenderer()

    Methods

    EndEdit(DataColumnBase, Object, Boolean)

    Declaration
    public override bool EndEdit(DataColumnBase dc, object record, bool canResetBinding = false)
    Parameters
    Type Name Description
    DataColumnBase dc
    System.Object record
    System.Boolean canResetBinding
    Returns
    Type
    System.Boolean
    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.TextBlock, Syncfusion.Windows.Shared.MaskedTextBox>.EndEdit(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Object, System.Boolean)

    GetControlValue()

    Gets the control value.

    Declaration
    public override object GetControlValue()
    Returns
    Type
    System.Object
    Overrides
    GridCellRendererBase.GetControlValue()

    OnEditElementLoaded(Object, RoutedEventArgs)

    Invoked when the edit element(MaskedTextBox or SfMaskedEdit) is loaded on the cell in column

    Declaration
    protected override void OnEditElementLoaded(object sender, RoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The sender.

    System.Windows.RoutedEventArgs e

    The System.Windows.RoutedEventArgs instance containing the event data.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.TextBlock, Syncfusion.Windows.Shared.MaskedTextBox>.OnEditElementLoaded(System.Object, System.Windows.RoutedEventArgs)

    OnEditElementUnloaded(Object, RoutedEventArgs)

    Invoked when the edit element(MaskedTextBox or SfMaskedEdit) is unloaded on the cell in column

    Declaration
    protected override void OnEditElementUnloaded(object sender, RoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The sender.

    System.Windows.RoutedEventArgs e

    The System.Windows.RoutedEventArgs instance containing the event data.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.TextBlock, Syncfusion.Windows.Shared.MaskedTextBox>.OnEditElementUnloaded(System.Object, System.Windows.RoutedEventArgs)

    OnInitializeDisplayElement(DataColumnBase, TextBlock, Object)

    Called when [initialize display element].

    Declaration
    public override void OnInitializeDisplayElement(DataColumnBase dataColumn, TextBlock uiElement, object dataContext)
    Parameters
    Type Name Description
    DataColumnBase dataColumn

    DataColumn Which holds GridColumn, RowColumnIndex and GridCell

    System.Windows.Controls.TextBlock uiElement

    Corresponding Renderer Element

    System.Object dataContext

    The data context.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.TextBlock, Syncfusion.Windows.Shared.MaskedTextBox>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, System.Windows.Controls.TextBlock, System.Object)

    OnInitializeEditElement(DataColumnBase, MaskedTextBox, Object)

    Called when [initialize edit element].

    Declaration
    public override void OnInitializeEditElement(DataColumnBase dataColumn, MaskedTextBox uiElement, object dataContext)
    Parameters
    Type Name Description
    DataColumnBase dataColumn

    DataColumn Which holds GridColumn, RowColumnIndex and GridCell

    MaskedTextBox uiElement

    Corresponding Renderer Element

    System.Object dataContext

    The data context.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.TextBlock, Syncfusion.Windows.Shared.MaskedTextBox>.OnInitializeEditElement(Syncfusion.UI.Xaml.Grid.DataColumnBase, Syncfusion.Windows.Shared.MaskedTextBox, System.Object)

    OnPreviewTextInput(TextCompositionEventArgs)

    Called when text is entered in the Data Control

    Declaration
    protected override void OnPreviewTextInput(TextCompositionEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TextCompositionEventArgs e

    KeyRoutedEventArgs

    Overrides
    GridCellRendererBase.OnPreviewTextInput(TextCompositionEventArgs)

    OnUnwireEditUIElement(MaskedTextBox)

    Called when [unwire edit UI element].

    Declaration
    protected override void OnUnwireEditUIElement(MaskedTextBox uiElement)
    Parameters
    Type Name Description
    MaskedTextBox uiElement

    The UI element.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRendererBase<System.Windows.Controls.TextBlock, Syncfusion.Windows.Shared.MaskedTextBox>.OnUnwireEditUIElement(Syncfusion.Windows.Shared.MaskedTextBox)

    SetControlValue(Object)

    Sets the control value.

    Declaration
    public override void SetControlValue(object value)
    Parameters
    Type Name Description
    System.Object value

    The value.

    Overrides
    GridCellRendererBase.SetControlValue(Object)

    ShouldGridTryToHandleKeyDown(KeyEventArgs)

    Let Renderer decide whether the parent grid should be allowed to handle keys and prevent the key event from being handled by the visual UIElement for this renderer. If this method returns true the parent grid will handle arrow keys and set the Handled flag in the event data. Keys that the grid does not handle will be ignored and be routed to the UIElement for this renderer.

    Declaration
    protected override bool ShouldGridTryToHandleKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e

    A System.Windows.Input.KeyEventArgs object.

    Returns
    Type Description
    System.Boolean

    True if the parent grid should be allowed to handle keys; false otherwise.

    Overrides
    Syncfusion.UI.Xaml.Grid.Cells.GridVirtualizingCellRenderer<System.Windows.Controls.TextBlock, Syncfusion.Windows.Shared.MaskedTextBox>.ShouldGridTryToHandleKeyDown(System.Windows.Input.KeyEventArgs)

    Implements

    IGridCellRenderer
    System.IDisposable
    In This Article
    • Constructors
      • GridCellMaskRenderer()
    • Methods
      • EndEdit(DataColumnBase, Object, Boolean)
      • GetControlValue()
      • OnEditElementLoaded(Object, RoutedEventArgs)
      • OnEditElementUnloaded(Object, RoutedEventArgs)
      • OnInitializeDisplayElement(DataColumnBase, TextBlock, Object)
      • OnInitializeEditElement(DataColumnBase, MaskedTextBox, Object)
      • OnPreviewTextInput(TextCompositionEventArgs)
      • OnUnwireEditUIElement(MaskedTextBox)
      • SetControlValue(Object)
      • ShouldGridTryToHandleKeyDown(KeyEventArgs)
    • Implements
    Was this page helpful? Yes No
    Thank you for your feedback!
    Thank you for your feedback and comments. We will rectify this as soon as possible!
    An unknown error has occurred. Please try again.
    SEND FEEDBACK REGARDING THIS TOPIC

    Please provide additional information

    Please provide additional information

    Please provide additional information

    Please provide additional information
    Please provide additional information
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved