Class GridCellComboBoxRenderer
Represents the class that loads the SfComboBox as editor for GridComboBoxColumn.
Inheritance
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid.Renderers
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class GridCellComboBoxRenderer : GridVirtualizingCellRenderer<ContentControl, SfComboBox>, IGridCellRenderer, IDisposableExamples
this.sfDataGrid.CellRenderers.Remove("ComboBox");
this.sfDataGrid.CellRenderers.Add("ComboBox", new GridCellComboBoxRendererExt());
public class GridCellComboBoxBoxRendererExt : GridCellComboBoxRenderer
{
public override void OnInitializeDisplayElement(DataColumnBase dataColumn, ContentControl uiElement, object dataContext)
{
base.OnInitializeDisplayElement(dataColumn, uiElement, dataContext);
uiElement.Foreground = new SolidColorBrush(Colors.DarkOrange);
}
}Constructors
GridCellComboBoxRenderer()
Initializes a new instance of the GridCellComboBoxRenderer class.
Declaration
public GridCellComboBoxRenderer()Methods
EndEdit(DataColumnBase, Object, Boolean)
Ends the edit occuring on the cell.
Declaration
public override bool EndEdit(DataColumnBase dc, object record, bool canResetBinding = false)Parameters
| Type | Name | Description |
|---|---|---|
| DataColumnBase | dc | Specifies the DataColumnBase. |
| 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
GetControlValue()
Gets the control value of the cell.
Declaration
public override object GetControlValue()Returns
| Type | Description |
|---|---|
| System.Object | The control value of the cell. |
Overrides
OnCreateDisplayUIElement()
Creates a new UIElement for the display mode of cell.
Declaration
protected override ContentControl OnCreateDisplayUIElement()Returns
| Type | Description |
|---|---|
| Microsoft.UI.Xaml.Controls.ContentControl | The new UIElement for the display mode of cell. |
Overrides
OnCreateEditUIElement()
Creates a new UIElement for the edit mode of cell.
Declaration
protected override SfComboBox OnCreateEditUIElement()Returns
| Type | Description |
|---|---|
| SfComboBox | Returns the new UIElement for edit mode of cell. |
Overrides
OnEditElementLoaded(Object, RoutedEventArgs)
Invoked when the edit element 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
OnEnteredEditMode(DataColumnBase, FrameworkElement)
Invoked when the cell is being entered the edit mode.
Declaration
protected override void OnEnteredEditMode(DataColumnBase dataColumn, FrameworkElement currentRendererElement)Parameters
| Type | Name | Description |
|---|---|---|
| DataColumnBase | dataColumn | Specifies the corresponding DataColumnBase. |
| Microsoft.UI.Xaml.FrameworkElement | currentRendererElement | Specifies the current renderer element. |
Overrides
OnInitializeDisplayElement(DataColumnBase, ContentControl, Object)
Method which initialize the display element of the column.
Declaration
public override void OnInitializeDisplayElement(DataColumnBase dataColumn, ContentControl uiElement, object dataContext)Parameters
| Type | Name | Description |
|---|---|---|
| DataColumnBase | dataColumn | Specifies the DataColumnBase. |
| Microsoft.UI.Xaml.Controls.ContentControl | uiElement | Specifies the corresponding renderer element. |
| System.Object | dataContext | Specifies the data context. |
Overrides
OnInitializeEditElement(DataColumnBase, SfComboBox, Object)
Method which is used to initialize the renderer element bindings with corresponding column values.
Declaration
public override void OnInitializeEditElement(DataColumnBase dataColumn, SfComboBox uiElement, object dataContext)Parameters
| Type | Name | Description |
|---|---|---|
| DataColumnBase | dataColumn | Specifies the DataColumnBase. |
| SfComboBox | uiElement | Specifies the corresponding renderer element. |
| System.Object | dataContext | Specifies the data context of the cell. |
Overrides
OnUnwireEditUIElement(SfComboBox)
Unwires the events associated with edit UIElement
Declaration
protected override void OnUnwireEditUIElement(SfComboBox uiElement)Parameters
| Type | Name | Description |
|---|---|---|
| SfComboBox | uiElement | Specifies the corresponding UIElement. |
Overrides
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
Exceptions
| Type | Condition |
|---|---|
| System.Exception | Thrown when value cannot be set for Unloaded editor. |
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. |