WinUI

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridUnboundCellTextBoxRenderer

    Show / Hide Table of Contents

    Class GridUnboundCellTextBoxRenderer

    Class that deals with Unbound column with TextColumn Behavior.

    Inheritance
    System.Object
    GridCellRendererBase
    GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>
    GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>
    GridUnboundCellTextBoxRenderer
    Implements
    IGridCellRenderer
    System.IDisposable
    Inherited Members
    GridVirtualizingCellRenderer<TextBlock, TextBox>.TextAlignmentToHorizontalAlignment(TextAlignment)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.CurrentRendererValueChanged()
    GridVirtualizingCellRenderer<TextBlock, TextBox>.ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.OnInitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.OnUpdateTemplateBinding(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.OnInitializeDisplayElement(DataColumnBase, TextBlock, Object)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.OnUpdateDisplayBinding(DataColumnBase, TextBlock, Object)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.OnInitializeEditElement(DataColumnBase, TextBox, Object)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.OnUpdateEditBinding(DataColumnBase, TextBox, Object)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.UpdateToolTip(DataColumnBase)
    GridVirtualizingCellRenderer<TextBlock, TextBox>.EditorType
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnEnteredEditMode(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.EndEdit(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnEditingComplete(DataColumnBase, FrameworkElement)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnloadUIElements(DataColumnBase)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnUpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnUpdateStyleInfo(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnCreateEditUIElement()
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnCreateDisplayUIElement()
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.InitializeEditElement(DataColumnBase, TextBox, Object)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.InitializeDisplayElement(DataColumnBase, TextBlock, Object)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.InitializeTemplateElement(DataColumnBase, ContentControl, Object)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnWireDisplayUIElement(TextBlock)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnwireDisplayUIElement(TextBlock)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnWireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnwireTemplateUIElement(ContentControl)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnWireEditUIElement(TextBox)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnwireEditUIElement(TextBox)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnEditElementLoaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnEditElementUnloaded(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.OnEditElementLostFocus(Object, RoutedEventArgs)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.InitializeCellStyle(DataColumnBase, Object)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.ClearRecycleBin()
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.Dispose(Boolean)
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.DisplayRecycleBin
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.EditRecycleBin
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.TemplateRecycleBin
    GridVirtualizingCellRendererBase<TextBlock, TextBox>.AllowRecycle
    GridCellRendererBase.OnPrepareUIElements(DataColumnBase, Object, Boolean)
    GridCellRendererBase.OnPrepareUIElements()
    GridCellRendererBase.CanValidate()
    GridCellRendererBase.CommitUnboundCellValue(Object, GridColumn, Object)
    GridCellRendererBase.UpdateToolTip(DataColumnBase)
    GridCellRendererBase.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    GridCellRendererBase.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    GridCellRendererBase.OnUnloadUIElements(DataColumnBase)
    GridCellRendererBase.OnUpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.OnUpdateStyleInfo(DataColumnBase, Object)
    GridCellRendererBase.SetFocus(FrameworkElement, Boolean)
    GridCellRendererBase.IGridCellRenderer.ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)
    GridCellRendererBase.Arrange(RowColumnIndex, FrameworkElement, Rect)
    GridCellRendererBase.Measure(RowColumnIndex, FrameworkElement, Size)
    GridCellRendererBase.PrepareUIElements(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UnloadUIElements(DataColumnBase)
    GridCellRendererBase.IGridCellRenderer.UpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UpdateBindingInfo(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UpdateCellStyle(DataColumnBase, Object)
    GridCellRendererBase.PreviewTextInput(KeyRoutedEventArgs)
    GridCellRendererBase.SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, GridColumn, DataColumnBase)
    GridCellRendererBase.UpdateCurrentCellState(FrameworkElement, Boolean)
    GridCellRendererBase.ResetCurrentCellState()
    GridCellRendererBase.SetFocus(Boolean)
    GridCellRendererBase.BeginEdit(RowColumnIndex, FrameworkElement, GridColumn, Object)
    GridCellRendererBase.EndEdit(DataColumnBase, Object, Boolean)
    GridCellRendererBase.UpdateSource(FrameworkElement)
    GridCellRendererBase.ClearRecycleBin()
    GridCellRendererBase.Dispose()
    GridCellRendererBase.Dispose(Boolean)
    GridCellRendererBase.PreviewInputText
    GridCellRendererBase.DataGrid
    GridCellRendererBase.BindingExpression
    GridCellRendererBase.SupportsRenderOptimization
    GridCellRendererBase.UseOnlyRendererElement
    GridCellRendererBase.HasCurrentCellState
    GridCellRendererBase.CurrentCellIndex
    GridCellRendererBase.CurrentCellElement
    GridCellRendererBase.CurrentCellRendererElement
    GridCellRendererBase.IsInEditing
    GridCellRendererBase.IsFocused
    GridCellRendererBase.IsEditable
    GridCellRendererBase.IsFocusible
    GridCellRendererBase.IsDropDownable
    Namespace: Syncfusion.UI.Xaml.DataGrid.Renderers
    Assembly: Syncfusion.Grid.WinUI.dll
    Syntax
    public class GridUnboundCellTextBoxRenderer : GridVirtualizingCellRenderer<TextBlock, TextBox>, IGridCellRenderer, IDisposable

    Constructors

    GridUnboundCellTextBoxRenderer()

    Declaration
    public GridUnboundCellTextBoxRenderer()

    Methods

    CanUpdateBinding(GridColumn)

    Determines whether the binding for the column can be updated.Implement this method to update binding on particular renderer whether the data context is set.

    Declaration
    public override bool CanUpdateBinding(GridColumn column)
    Parameters
    Type Name Description
    GridColumn column

    Specifies the corresponding GridColumn.

    Returns
    Type Description
    System.Boolean

    True if the binding is updated for the column; otherwise false.

    Overrides
    GridCellRendererBase.CanUpdateBinding(GridColumn)

    GetControlValue()

    Gets the control value of the cell.

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

    Returns the control value of the cell.

    Overrides
    GridCellRendererBase.GetControlValue()

    OnEditElementLoaded(Object, RoutedEventArgs)

    Invoked when the edit element(TextBox) 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.

    Microsoft.UI.Xaml.RoutedEventArgs e

    The Microsoft.UI.Xaml.RoutedEventArgs instance containing the event data.

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnEditElementLoaded(System.Object, Microsoft.UI.Xaml.RoutedEventArgs)

    OnEditElementUnloaded(Object, RoutedEventArgs)

    Invoked when the edit element(TextBox) 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.

    Microsoft.UI.Xaml.RoutedEventArgs e

    The Microsoft.UI.Xaml.RoutedEventArgs instance containing the event data.

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnEditElementUnloaded(System.Object, Microsoft.UI.Xaml.RoutedEventArgs)

    OnEditingComplete(DataColumnBase, FrameworkElement)

    When complete edit, we need to raise query again to provide entered value to customer.

    Declaration
    protected override void OnEditingComplete(DataColumnBase dataColumn, FrameworkElement currentRendererElement)
    Parameters
    Type Name Description
    DataColumnBase dataColumn

    Specifies the corresponding DataColumnBase.

    Microsoft.UI.Xaml.FrameworkElement currentRendererElement

    Specifies the UIElement that resides in GridUnBoundCell

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnEditingComplete(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, Microsoft.UI.Xaml.FrameworkElement)

    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

    Specifies the corresponding DataColumnBase.

    Microsoft.UI.Xaml.Controls.TextBlock uiElement

    Specifies the corresponding renderer element

    System.Object dataContext

    Specifies the data context.

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, Microsoft.UI.Xaml.Controls.TextBlock, System.Object)

    OnInitializeEditElement(DataColumnBase, TextBox, Object)

    Initializes the binding for editor of corresponding column.

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

    Specifies the corresponding DataColumnBase.

    Microsoft.UI.Xaml.Controls.TextBox uiElement

    Specifies the corresponding UIElement.

    System.Object dataContext

    Specifies the data context.

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnInitializeEditElement(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, Microsoft.UI.Xaml.Controls.TextBox, System.Object)

    OnInitializeTemplateElement(DataColumnBase, ContentControl, Object)

    Initializes the binding for the Grid cell by column's cellTemplate and CellTemplateSelector.

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

    Specifies the DataColumnBase.

    Microsoft.UI.Xaml.Controls.ContentControl uiElement

    Specifies the corresponding UIElement.

    System.Object dataContext

    Specifies the data context.

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnInitializeTemplateElement(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, Microsoft.UI.Xaml.Controls.ContentControl, System.Object)

    OnPreviewTextInput(KeyRoutedEventArgs)

    Raises the PreviewTextInput(KeyRoutedEventArgs) event.

    Declaration
    protected override void OnPreviewTextInput(KeyRoutedEventArgs e)
    Parameters
    Type Name Description
    Microsoft.UI.Xaml.Input.KeyRoutedEventArgs e

    The Microsoft.UI.Xaml.Input.KeyRoutedEventArgs instance containing the event data.

    Overrides
    GridCellRendererBase.OnPreviewTextInput(KeyRoutedEventArgs)

    OnUnwireEditUIElement(TextBox)

    Unwires the events associated with edit UIElement.

    Declaration
    protected override void OnUnwireEditUIElement(TextBox uiElement)
    Parameters
    Type Name Description
    Microsoft.UI.Xaml.Controls.TextBox uiElement

    Specifies the corresponding edit UIElement to unwire its events.

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRendererBase<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnUnwireEditUIElement(Microsoft.UI.Xaml.Controls.TextBox)

    OnUpdateTemplateBinding(DataColumnBase, ContentControl, Object)

    Update the binding for the Grid cell by column's cellTemplate and CellTemplateSelector.

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

    Specifies the corresponding DataColumnBase.

    Microsoft.UI.Xaml.Controls.ContentControl uiElement

    Specifies the corresponding UIElement.

    System.Object dataContext

    Specifies the data context.

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.OnUpdateTemplateBinding(Syncfusion.UI.Xaml.DataGrid.DataColumnBase, Microsoft.UI.Xaml.Controls.ContentControl, System.Object)

    SetControlValue(Object)

    Sets the control value of the cell.

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

    Specifies the value to set the control value of the cell.

    Overrides
    GridCellRendererBase.SetControlValue(Object)

    ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)

    Handles the key interaction with editor of corresponding column.

    Declaration
    protected override bool ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs e)
    Parameters
    Type Name Description
    Microsoft.UI.Xaml.Input.KeyRoutedEventArgs e

    The Microsoft.UI.Xaml.Input.KeyRoutedEventArgs instance containing the event data.

    Returns
    Type Description
    System.Boolean

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

    Overrides
    Syncfusion.UI.Xaml.DataGrid.Renderers.GridVirtualizingCellRenderer<Microsoft.UI.Xaml.Controls.TextBlock, Microsoft.UI.Xaml.Controls.TextBox>.ShouldGridTryToHandleKeyDown(Microsoft.UI.Xaml.Input.KeyRoutedEventArgs)

    Implements

    IGridCellRenderer
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved