Xceed Grid for WinForms v4.3 Documentation
As of version 3.0 of Xceed Grid for WinForms, the ICellEditor interface is obsolete and has been replaced by the CellEditorManager class. This topic provides the information necessary in order to migrate from an older version to the latest version that uses the new editors.
Only in the case where a 3.0 license key is used will the new predefined editors be used as the default editors. If a license key prior to version 3.0 is used, Xceed Grid for WinForms will revert back to the old editors. Note that the old editors are obsolete.
In prior versions, the editors were assigned to either the cell's or the column's CellEditor property and the control being used to edit a cell was retrievable through the cell's CurrentEditor property. Both of these properties are now obsolete and have been replaced by the CellEditorManager and CellEditorControl properties respectively.
The following table provides a list of the properties that are now obsolete and their replacements:
| Old member | New member |
|---|---|
| Cell.CellEditor property | Cell.CellEditorManager property |
| Cell.CurrentEditor property | Cell.CellEditorControl property |
| EnteringEditEventArgs.CellEditor property (Cell EnteringEdit event) |
EnteringEditEventArgs. CellEditorManager property (Cell.EnteringEdit event) |
| LeavingEditEventArgs.CellEditor property (Cell.LeavingEdit event) |
LeavingEditEventArgs. CellEditorControl property (Cell.LeavingEdit event) |
| Column.CellEditor property | Column. CellEditorManager property |
Prior to version 3.0, predefined editors were used to edit the content of cells and columns according to their datatype. The same is true with version 3.0, however the predefined editors that are used have been replaced.
The following table provides a list of the old editors with their new counterparts.
| Old editor (obsolete) | New editor |
|---|---|
| GridCalculatorBox | NumericEditor |
| GridCheckBox | CheckBoxEditor |
| GridComboBox | ComboBoxEditor |
| GridDateTimePicker | DateEditor |
| GridMaskedTextBox | TextEditor |
| GridNumericTextBox | NumericEditor |
| GridRichTextBox | CellEditorManager |
| GridTextBox | TextEditor |
| CustomEditor | CellEditorManager |
Prior to version 3.0, custom editors were created by either wrapping a control in a CustomEditor or by deriving from the desired control and implementing the ICellEditor interface. As of version 3.0, both the CustomEditor class and the ICellEditor interface are obsolete and have been replaced by the CellEditorManager class.
Custom editors can be created by deriving from the CellEditorManager class and implementing the required functionalities, by handling the events that are raised by the CellEditorManager class, or by wrapping a control within an instance of the CellEditorManager class.
In prior versions, the editors were assigned to either the cell's or the column's CellEditor property and the control being used to edit a cell was retrievable through the cell's CurrentEditor property. Both of these properties are now obsolete and have been replaced by the CellEditorManager and CellEditorControl properties respectively.
The following tables provide a list of the ICellEditor interface members and their corresponding member in the CellEditorManager class.
|
ICellEditor interface (obsolete) |
CellEditorManager class
|
Description |
|---|---|---|
|
Control property |
TemplateControl property |
Gets the Control that will be used as a template to create the controls that will edit the content of cells. |
|
HandleActivationClick property |
HandleActivationClick method |
Gets a boolean value indicating if the control should handle the mouse click once it is activated. |
|
InPlace property |
InPlace property |
Gets a boolean value indicating if the Control is painted within the bounds of the cell. |
|
ActivateControl method |
ActivateControl method ActivateControlCore method ActivatingControl event |
Activates the control that will be used to edit the content of the cell. |
|
GetControlValue method |
GetControlValue method GetControlValueCore method GettingControlValue event |
Retrieves the value of the control. |
|
GetFittedHeight method |
GetFittedHeight method GetFittedHeightCore method QueryFittedHeight event |
Retrieves a value representing the fitted height of the editor in pixels. |
|
GetFittedWidth method |
GetFittedWidth method GetFittedWidthCore method QueryFittedWidth event |
Retrieves a value representing the fitted width of the editor in pixels. |
|
IsActivationChar method |
IsActivationChar method IsActivationCharCore method QueryActivationChar event |
Retrieves a boolean value indicating if the editor is activated by the char. |
|
IsActivationKey method |
IsActivationKey method IsActivationKeyCore method QueryActivationKey event |
Retrieves a boolean value indicating if the editor is activated by the key. |
|
IsInputChar method |
IsInputChar method IsInputCharCore method QueryInputChar event |
Determines if a character is an input character that the editor recognizes. |
|
IsInputKey method |
IsInputKey method IsInputKeyCore method QueryInputKey event |
Determines whether the specified key is a regular input key or a special key that requires preprocessing. |
|
SetControlValue method |
SetControlValue method SetControlValueCore method SettingControlValue event |
Assigns the value of the cell to the control |
For a complete list of the public and protected members available in the CellEditorManager class, refer to the Public members and Protected members topics.