WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridCellComboBoxRenderer - WPF API Reference | Syncfusion as editor for TreeGridComboBoxColumn. ">

    Show / Hide Table of Contents

    Class TreeGridCellComboBoxRenderer

    Represents the class that loads the as editor for TreeGridComboBoxColumn.

    Inheritance
    System.Object
    TreeGridCellRendererBase
    TreeGridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>
    TreeGridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>
    TreeGridCellComboBoxRenderer
    Implements
    ITreeGridCellRenderer
    System.IDisposable
    Inherited Members
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.TextAlignmentToHorizontalAlignment(TextAlignment)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.CurrentRendererValueChanged()
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.OnInitializeTemplateElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.OnUpdateTemplateBinding(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.OnInitializeDisplayElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.OnUpdateDisplayBinding(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.OnInitializeEditElement(TreeDataColumnBase, ComboBox, Object)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.OnUpdateEditBinding(TreeDataColumnBase, ComboBox, Object)
    TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>.EditorType
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnPrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.BeginEdit(RowColumnIndex, FrameworkElement, TreeGridColumn, Object)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnEnteredEditMode(TreeDataColumnBase, FrameworkElement)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.EndEdit(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnEditingComplete(TreeDataColumnBase, FrameworkElement)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnUnloadUIElements(TreeDataColumnBase)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnUpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.UpdateToolTip(TreeDataColumnBase)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnCreateEditUIElement()
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnCreateDisplayUIElement()
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.InitializeEditElement(TreeDataColumnBase, ComboBox, Object)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.InitializeDisplayElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.InitializeTemplateElement(TreeDataColumnBase, ContentControl, Object)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnWireDisplayUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnUnwireDisplayUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnWireTemplateUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnUnwireTemplateUIElement(ContentControl)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnWireEditUIElement(ComboBox)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnUnwireEditUIElement(ComboBox)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnEditElementLoaded(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnEditElementUnloaded(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnEditElementLostFocus(Object, RoutedEventArgs)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.InitializeCellStyle(TreeDataColumnBase, Object)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.OnUpdateStyleInfo(TreeDataColumn)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.ClearRecycleBin()
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.Dispose(Boolean)
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.DisplayRecycleBin
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.EditRecycleBin
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.TemplateRecycleBin
    TreeGridVirtualizingCellRendererBase<ContentControl, ComboBox>.AllowRecycle
    TreeGridCellRendererBase.OnPrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.OnPreviewTextInput(TextCompositionEventArgs)
    TreeGridCellRendererBase.CanValidate()
    TreeGridCellRendererBase.CanUpdateBinding(TreeGridColumn)
    TreeGridCellRendererBase.OnArrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridCellRendererBase.OnMeasure(RowColumnIndex, FrameworkElement, Size)
    TreeGridCellRendererBase.UpdateToolTip(TreeDataColumnBase)
    TreeGridCellRendererBase.OnUnloadUIElements(TreeDataColumnBase)
    TreeGridCellRendererBase.OnUpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.SetFocus(FrameworkElement, Boolean)
    TreeGridCellRendererBase.ITreeGridCellRenderer.ShouldGridTryToHandleKeyDown(KeyEventArgs)
    TreeGridCellRendererBase.Arrange(RowColumnIndex, FrameworkElement, Rect)
    TreeGridCellRendererBase.Measure(RowColumnIndex, FrameworkElement, Size)
    TreeGridCellRendererBase.PrepareUIElements(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.UnloadUIElements(TreeDataColumnBase)
    TreeGridCellRendererBase.ITreeGridCellRenderer.UpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.UpdateBindingInfo(TreeDataColumnBase, Object, Boolean)
    TreeGridCellRendererBase.PreviewTextInput(TextCompositionEventArgs)
    TreeGridCellRendererBase.SetCurrentCellState(RowColumnIndex, FrameworkElement, Boolean, Boolean, TreeGridColumn, TreeDataColumnBase)
    TreeGridCellRendererBase.UpdateCurrentCellState(FrameworkElement, Boolean)
    TreeGridCellRendererBase.ResetCurrentCellState()
    TreeGridCellRendererBase.SetFocus(Boolean)
    TreeGridCellRendererBase.RaiseCurrentCellValidatingEvent(SfTreeGrid, TreeGridColumn, Object, Object, Object, Object, TreeNode)
    TreeGridCellRendererBase.RaiseCurrentCellValidatedEvent(SfTreeGrid, TreeGridColumn, Object, Object, Object, TreeNode)
    TreeGridCellRendererBase.RaiseCurrentCellValueChangedEvent(SfTreeGrid, TreeDataColumnBase)
    TreeGridCellRendererBase.BeginEdit(RowColumnIndex, FrameworkElement, TreeGridColumn, Object)
    TreeGridCellRendererBase.UpdateSource(FrameworkElement)
    TreeGridCellRendererBase.ClearRecycleBin()
    TreeGridCellRendererBase.Dispose()
    TreeGridCellRendererBase.Dispose(Boolean)
    TreeGridCellRendererBase.UpdateCellStyle(TreeDataColumn)
    TreeGridCellRendererBase.OnUpdateStyleInfo(TreeDataColumn)
    TreeGridCellRendererBase.PreviewInputText
    TreeGridCellRendererBase.TreeGrid
    TreeGridCellRendererBase.BindingExpression
    TreeGridCellRendererBase.SupportsRenderOptimization
    TreeGridCellRendererBase.UseOnlyRendererElement
    TreeGridCellRendererBase.HasCurrentCellState
    TreeGridCellRendererBase.CurrentCellIndex
    TreeGridCellRendererBase.CurrentCellElement
    TreeGridCellRendererBase.CurrentCellRendererElement
    TreeGridCellRendererBase.IsInEditing
    TreeGridCellRendererBase.IsFocused
    TreeGridCellRendererBase.IsEditable
    TreeGridCellRendererBase.IsFocusable
    TreeGridCellRendererBase.IsDropDownable
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.UI.Xaml.TreeGrid.Cells
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public class TreeGridCellComboBoxRenderer : TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>, ITreeGridCellRenderer, IDisposable
    Examples
    this.sfTreeGrid.CellRenderers.Remove("ComboBox");
    this.sfTreeGrid.CellRenderers.Add("ComboBox", new TreeGridCellComboBoxRendererExt());
    public class TreeGridCellComboBoxRendererExt : TreeGridCellComboBoxRenderer
    {
       public override void OnInitializeDisplayElement(TreeDataColumnBase dataColumn, ContentControl uiElement, object dataContext)
       {
           base.OnInitializeDisplayElement(dataColumn, uiElement, dataContext);
           uiElement.Foreground = new SolidColorBrush(Colors.DarkOrange);
       }
    }

    Constructors

    TreeGridCellComboBoxRenderer()

    Initializes a new instance of TreeGridCellComboBoxRenderer class.

    Declaration
    public TreeGridCellComboBoxRenderer()

    Fields

    lastKeyPressed

    Declaration
    public Key? lastKeyPressed
    Field Value
    Type Description
    System.Nullable<System.Windows.Input.Key>

    Methods

    EndEdit(TreeDataColumnBase, Object, Boolean)

    Ends the edit occuring on the cell.

    Declaration
    public override bool EndEdit(TreeDataColumnBase dc, object record, bool canResetBinding = false)
    Parameters
    Type Name Description
    TreeDataColumnBase dc

    Specifies the TreeDataColumnBase.

    System.Object record

    Specifies the record.

    System.Boolean canResetBinding

    Indicates whether binding can be reset or not.

    Returns
    Type Description
    System.Boolean

    True if the edit ends on the cell; otherwise false.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.EndEdit(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Object, System.Boolean)

    GetControlValue()

    Gets the control value of the cell.

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

    Returns the control value as null by default .

    Overrides
    TreeGridCellRendererBase.GetControlValue()

    OnCreateDisplayUIElement()

    Creates a new UIElement for the display mode of cell.

    Declaration
    protected override ContentControl OnCreateDisplayUIElement()
    Returns
    Type Description
    System.Windows.Controls.ContentControl

    The new UIElement for the display mode of cell.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.OnCreateDisplayUIElement()

    OnCreateEditUIElement()

    Creates a new UIElement for the edit mode of cell.

    Declaration
    protected override ComboBox OnCreateEditUIElement()
    Returns
    Type Description
    System.Windows.Controls.ComboBox

    Returns the new UIElement for edit mode of cell.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.OnCreateEditUIElement()

    OnEditElementLoaded(Object, RoutedEventArgs)

    Invoked when the edit element(ComboBox) 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 that contains the corresponding edit UIElement.

    System.Windows.RoutedEventArgs e

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

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.OnEditElementLoaded(System.Object, System.Windows.RoutedEventArgs)

    OnEnteredEditMode(TreeDataColumnBase, FrameworkElement)

    Invoked when the cell is being entered the edit mode.

    Declaration
    protected override void OnEnteredEditMode(TreeDataColumnBase dataColumn, FrameworkElement currentRendererElement)
    Parameters
    Type Name Description
    TreeDataColumnBase dataColumn

    The corresponding data column.

    System.Windows.FrameworkElement currentRendererElement

    The current renderer element.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.OnEnteredEditMode(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Windows.FrameworkElement)

    OnInitializeDisplayElement(TreeDataColumnBase, ContentControl, Object)

    Method which initialize the display element of the column.

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

    Specifies the TreeDataColumnBase.

    System.Windows.Controls.ContentControl uiElement

    Specifies the corresponding renderer element.

    System.Object dataContext

    Specifies the data context.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Windows.Controls.ContentControl, System.Object)

    OnInitializeEditElement(TreeDataColumnBase, ComboBox, Object)

    Invoked when the edit element is initialized on the cell.

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

    Specified the TreeDataColumnBase.

    System.Windows.Controls.ComboBox uiElement

    Specifies the corresponding renderer element.

    System.Object dataContext

    Specifies the data context of the cell.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.OnInitializeEditElement(Syncfusion.UI.Xaml.TreeGrid.TreeDataColumnBase, System.Windows.Controls.ComboBox, System.Object)

    OnUnwireEditUIElement(ComboBox)

    Unwires the events associated with edit UIElement

    Declaration
    protected override void OnUnwireEditUIElement(ComboBox uiElement)
    Parameters
    Type Name Description
    System.Windows.Controls.ComboBox uiElement

    The corresponding edit UIElement to unwire its events.

    Overrides
    Syncfusion.UI.Xaml.TreeGrid.Cells.TreeGridVirtualizingCellRendererBase<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.OnUnwireEditUIElement(System.Windows.Controls.ComboBox)

    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
    TreeGridCellRendererBase.SetControlValue(Object)

    ShouldGridTryToHandleKeyDown(KeyEventArgs)

    Handles the key interaction with editor of corresponding column.

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

    The System.Windows.Input.KeyEventArgs 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.TreeGrid.Cells.TreeGridVirtualizingCellRenderer<System.Windows.Controls.ContentControl, System.Windows.Controls.ComboBox>.ShouldGridTryToHandleKeyDown(System.Windows.Input.KeyEventArgs)

    Implements

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