Class TreeGridCellComboBoxRenderer
Represents the class that loads the ComboBox as editor for TreeGridComboBoxColumn.
Inheritance
Inherited Members
Namespace: Syncfusion.UI.Xaml.TreeGrid.Cells
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class TreeGridCellComboBoxRenderer : TreeGridVirtualizingCellRenderer<ContentControl, ComboBox>, ITreeGridCellRenderer, IDisposableExamples
this.sfTreeGrid.CellRenderers.Remove("ComboBox");
this.sfTreeGrid.CellRenderers.Add("ComboBox", new TreeGridCellComboBoxRendererExt());
public class TreeGridCellComboBoxRendererExt : TreeGridCellComboBoxRenderer
{
public override void OnInitializeEditElement(DataColumnBase dataColumn, ComboBox uiElement, object dataContext)
{
uiElement.SelectionShape = SelectionShape.Circle;
uiElement.SelectionHighlightMode = SelectionHighlightMode.Filled;
base.OnInitializeEditElement(dataColumn, uiElement, dataContext);
}
}Constructors
TreeGridCellComboBoxRenderer()
Initializes a new instance of TreeGridCellComboBoxRenderer class.
Declaration
public TreeGridCellComboBoxRenderer()Fields
lastKeyPressed
Declaration
public Key? lastKeyPressedField 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 | The data column. |
| System.Object | record | 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
GetControlValue()
Gets the control value.
Declaration
public override object GetControlValue()Returns
| Type | Description |
|---|---|
| System.Object |
Overrides
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
OnCreateEditUIElement()
Called when [create edit unique identifier element].
Declaration
protected override ComboBox OnCreateEditUIElement()Returns
| Type | Description |
|---|---|
| System.Windows.Controls.ComboBox |
Overrides
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. |
| System.Windows.RoutedEventArgs | e | The System.Windows.RoutedEventArgs instance containing the event data. |
Overrides
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
OnInitializeDisplayElement(TreeDataColumnBase, ContentControl, Object)
Called when [initialize display element].
Declaration
public override void OnInitializeDisplayElement(TreeDataColumnBase dataColumn, ContentControl uiElement, object dataContext)Parameters
| Type | Name | Description |
|---|---|---|
| TreeDataColumnBase | dataColumn | TreeDataColumn Which holds TreeGridColumn, RowColumnIndex and GridCell |
| System.Windows.Controls.ContentControl | uiElement | Corresponding Renderer Element |
| System.Object | dataContext | The data context. |
Overrides
OnInitializeEditElement(TreeDataColumnBase, ComboBox, Object)
Called when [initialize edit element].
Declaration
public override void OnInitializeEditElement(TreeDataColumnBase dataColumn, ComboBox uiElement, object dataContext)Parameters
| Type | Name | Description |
|---|---|---|
| TreeDataColumnBase | dataColumn | DataColumn Which holds TreeGridColumn, RowColumnIndex and TreeGridCell |
| System.Windows.Controls.ComboBox | uiElement | Corresponding Renderer Element |
| System.Object | dataContext | The data context. |
Overrides
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 UIElement. |
Overrides
SetControlValue(Object)
Sets the control value.
Declaration
public override void SetControlValue(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value | The value. |
Overrides
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. |