Syncfusion.Grid.Windows
Properties  Methods 


Syncfusion.Windows.Forms.Grid Namespace : GridCellRendererBase Class

GridCellRendererBase Class Members

The following tables list the members exposed by GridCellRendererBase.

Public Constructors
 NameDescription
Public ConstructorInitializes a new instance of the GridCellRendererBase class for the given GridControlBase and GridCellModelBase  
Top
Public Properties
 NameDescription
Public PropertyGets or sets a value indicating whether a CellClick event should always be raised. If this property is false, it depends on GridStyleInfo.Clickable if GridControlBase.CellClick is raised.  
Public Property Gets or sets the column id of the current cell.  
Public Property Gets a reference to the associated control. If no control is associated with the cell type, NULL will be returned.  
Public Property Gets or sets the active text that is displayed for the current cell, e.g. TextBox.Text.  
Public Property Gets or sets the cell value for the current cell.  
Public Property Gets a reference to GridCurrentCell implementation of the GridControlBase this cell renderer is associated with.  
Public Property Gets the current view style for the current cell.  
Public Property Gets or sets the drop-down button.  
Public Property Gets the container where you can insert child controls to be displayed as drop-down part for your cell.  
Public Property Gets or sets a helper object for drop-down cell functionality.  
Public PropertyGets or sets the IGridDropDownCellImp that provides drop-down logic for this renderer.  
Public PropertyGets or sets a value indicating whether your control needs to be refreshed when it becomes the current cell in the grid.  
Public Property Gets a reference to the parent grid.  
Public Property Gets a value indicating whether ControlText for the current cell has been set.  
Public Property Gets a value indicating whether the cell value for the current cell has been changed.  
Public Property Gets a value indicating whether the cell renderer has the focus (is in-place edit mode).  
Public PropertyGets a value indicating whether OnBeginEdit was called.  
Public Property Gets a value indicating whether this cell type serves as current cell or if the current cell is at the specified row and column id.  
Public Property Gets a value indicating whether ControlText setter was called. True when ControlText setter was called.  
Public Property Gets a value indicating whether the ControlValue setter was called. True if ControlValue setter was called.  
Public PropertyGets a value indicating whether SetControlValue method was called. True when SetControlValue method was called.  
Public Property Gets a value indicating whether object has been disposed.  
Public PropertyGets a value indicating whether object is executing Dispose method call. Returns true if object is executing Dispose method call.  
Public Property Gets or sets a reference to the GridCellModelBase that this cell renderer is associated with.  
Public Property Gets or sets the row id of the current cell.  
Public Property Gets a reference to the style object associated with the current cell.  
Public Property Gets or sets a value indicating whether the cell renderer supports being switched into edit mode. Default is true, only for GridStaticCellRenderer and GridHeaderCellRenderer it is false.  
Public Property Gets or sets a value indicating whether the cell renderer supports in-place editing with focus  
Top
Protected Properties
 NameDescription
Protected PropertyGets or sets a value indicating whether the mouse was over an image (see GridStyleInfo.ImageIndex) in static cell when the mouse was released.  
Protected Property Gets a value indicating whether is in initialize method. True while in initialize method.  
Protected Property Gets a value indicating whether the current cell is in a dropped-down state.  
Protected Property Gets a value indicating whether BeginEdit has been called.  
Protected Property Gets or sets the cached mouse position of the last MouseDown event.  
Protected Property Gets or sets the cached Environment.TickCount of the last MouseDown event.  
Protected Internal Property Gets the scale factor based on current DPI.  
Top
Public Methods
 NameDescription
Public Method Determines whether current cell can be copied to clipboard.  
Public Method Determines whether current cell can be cut to clipboard.  
Public Method Determines whether current cell can be pasted from clipboard.  
Public Method Will be called to indicate that the popup child was closed in the specified mode.  
Public Method Called when user initiates a clipboard copy and the grid has a current cell but no range is selected.  
Public Method Called when user initiates a clipboard cut and the grid has a current cell but no range is selected.  
Public Method Draw the contents of the specified cell.  
Public Method Draw the contents of the specified cell including cell background and optionally also the borders. Call this method if you want to draw a stand-alone cell and you want to ensure that also the background of the cell and also the borders are painted.  
Public Method Will be called to indicate that the popup child was closed.  
Public Method Occurs after the popup has been dropped-down and made visible.  
Public Method Occurs when the drop-down container is about to be shown.  
Public Method Ensures the container is valid and initialized.  
Public Method Searches the specified text and optionally moves the current cell to the cell if the text was found.  
Public MethodOverloaded.  Returns a rectangle with cell bounds for the specified cell. For covered cell, the total of all covered cells will be returned.  
Public Method For internal use.  
Public Method Get the cell client rectangle taking floated cells into consideration.  
Public MethodReturns the GridCellLayout for the specified cell using cell state information as specified in the style object and caches the layout information.  
Public MethodReturns ControlValue.  
Public MethodReturns ControlText.  
Public MethodReturns state information that lets you restore the current editing state (e.g. caret position or other cell-type specific information) at a later point with SetEditState.  
Public Method Returns a nested current cell if this cell type hosts a GridControl by itself (for example GridNestedTableControlCellRenderer with a GridGroupingControl overrides this method).  
Public Method Return the selected text in the current cell.  
Public Method If there is a control associated with the cell type (for in-place editing), override this method to hide the control.  
Public Method Determines whether this cell type serves as current cell or if the current cell is at the specified row and column id.  
Public Method Initializes the intrinsic state of the control for the current cell.  
Public Method Determines whether this cell type serves as current cell or if the current cell is at the specified row and column id.  
Public Method Determines if there is a control associated with the cell type (for in-place editing) and if it is visible.  
Public Method Returns whether the current cell is Read-only.  
Public Method Called to find out whether a specified control is part of the popup hierarchy.  
Public Method Called from OnVScroll, OnHScroll before grid is scrolled.  
Public Method Allows custom formatting of a cell by changing its style object.  
Public Method Called from GridCurrentCell.ScrollInView to determine if cell should be scrolled into view when GridCurrentCell.ScrollInView is called.  
Public Method Called when user initiates a clipboard paste and the grid has a current cell but no range is selected.  
Public MethodOverloaded.  Calculates the CellLayout for the specified cell using cell state information as specified in the style object.  
Public Method Lets you customize and redirect mouse wheel behavior to a cell renderer, e.g. if you have a drop-down displayed. Returns true if parent grid should not be scrolled; False if parent grid should scroll.  
Public Method Determines if this control contains focus. Override this method if you want to show drop-down windows and indicate the control has not lost focus when the drop-down is shown.  
Public MethodRaises a GridControlBase.CellCancelMode event and initiates a call to the virtual OnCancelMode method.  
Public MethodRaises a GridControlBase.CellClick event and initiates a call to the virtual OnClick method.  
Public MethodRaises a GridControlBase.CellDoubleClick event and initiates a call to the virtual OnDoubleClick method.  
Public Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController. Returns the cursor to be displayed at the given row or column.  
Public Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController. Checks if the mouse is over a cell button element and if the cell is click-able.  
Public MethodRaises a GridControlBase.CellMouseDown event and initiates a call to the virtual OnMouseDown method.  
Public MethodRaises a GridControlBase.CellMouseHover event and initiates a call to the virtual OnMouseHoverEnter method.  
Public Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when HitTest has indicated it wants to receive mouse events and the user has moved the mouse into the cell.  
Public MethodRaises a GridControlBase.CellMouseHoverLeave event and initiates a call to the virtual OnMouseHoverLeave method.  
Public MethodRaises a GridControlBase.CellMouseMove event and initiates a call to the virtual OnMouseMove method.  
Public MethodRaises a GridControlBase.CellMouseUp event and initiates a call to the virtual OnMouseUp method.  
Public MethodCalls protected virtual ProcessKeyEventArgs method.  
Public Method Replaces the selected text in the current cell.  
Public Method Searches the specified text and optionally moves the current cell to the cell if the text was found.  
Public Method Reset window coordinates (cell bounds) of the cell.  
Public Method Resets the ControlText to its original state.  
Public Method Resets the cell value of the current cell to its original state.  
Public MethodRestores previously retrieved editing state information from a GetEditState call.  
Public Method Determines if the cell at the specified row and column should be drawn in "editing" mode.  
Public Method Determines if the cell at the specified row and column should be drawn "focused".  
Public Method Called to determine whether the cell needs to be repainted when it becomes the active current cell.  
Public MethodReturns a string that represents the current object.  
Public MethodForces the ControlValue to reflect current control contents. Call this method if you want to know the value that will be saved in GridStyleInfo.CellValue if user would accept current cells contents.  
Public Method Called from OnValidate and checks whether the specified text is valid.  
Top
Protected Methods
 NameDescription
Protected MethodAdds a GridCellButton to the cell renderers list of cell buttons.  
Protected MethodHandles the DoubleClick event of the embedded control and raises the GridControlBase.CurrentCellControlDoubleClick event.  
Protected MethodHandles the GotFocus event of the embedded control and raises the GridControlBase.CurrentCellControlGotFocus event.  
Protected MethodHandles the LostFocus event of the embedded control and raises the GridControlBase.CurrentCellControlLostFocus event.  
Protected Method Handles the Control.MouseDown event of the attached cell control.  
Protected MethodCreates a GridDropDownContainer and associates it with the cell's parent grid.  
Protected MethodOverloaded.  Releases the all resources used by the component.  
Protected MethodChecks if the background for a cell needs drawing and optionally calls OnDrawCellBackground and also draws the frame for the cell as specified in the style object.  
Protected Method Draws the frame for the cells appearance (sunken or raised).  
Protected Method Returns a reference to the GridCellButton at the specified index.  
Protected Method Get the text of particular cell  
Protected Method Checks if this is a header cell that should indicate current cell position.  
Protected MethodInitializes ControlText based on the specified cell value.  
Protected Method Called to initialize contents of the drop-down container for the first time.  
Protected MethodChecks if the specified point is over an image (see GridStyleInfo.ImageIndex) .  
Protected Method Raises the GridCurrentCell.CellChanged event indicating the contents of the current cell have been changed (e.g. in response to a TextBox.Changed event).  
Protected Method Raises the GridCurrentCell.CellChanging event indicating the contents of the current cell are about to be changed by the user.  
Protected Method Raises the GridCurrentCell.ControlDoubleClick event indicating the cell has in-place editing mode and the user double-clicked inside the control associated with the current cell.  
Protected Method Raises the GridCurrentCell.ControlGotFocus event indicating the cell has switched to in-place editing and the control associated with the current cell has received the focus.  
Protected Method Raises the GridCurrentCell.ControlLostFocus event indicating the cell has switched to in-place editing and the control associated with the current cell has lost the focus.  
Protected MethodRaises the GridControlBase.OnCurrentCellShowedDropDown for the parent grid.  
Protected MethodRaises the GridControlBase.OnCurrentCellShowingDropDown for the parent grid.  
Protected Method This is called after the activating event and notifies that at this time the current cell has now become the active current cell.  
Protected Method This is called from GridCurrentCell.Activate after the activating event has been raised and allows interception of cell activation.  
Protected MethodCalled from GridCurrentCell.BeginEdit. Checks if cell renderer support in place editing. If in-place editing is supported, SetHasFocusControl is called which triggers OnHasFocusControlChanged and initiates repainting the cell. In your overridden OnDraw method, you should then check ShouldDrawFocused.  
Protected Method This method is called when the user clicks a cell button inside cell.  
Protected Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the mouse operation is canceled.  
Protected Method Called when the ViewLayout of the parent grid is changed, for example if grid is scrolled or row height is changed.  
Protected Method This is called from GridSelectCellsMouseController when the user clicked inside a cell.  
Protected Method This is called from GridCurrentCell.CloseDropDown.  
Protected Method Occurs when the current cell has in-place editing mode and the user double-clicked inside the control associated with the current cell.  
Protected Method Called from GridCurrentCell.Deactivate after GridCurrentCell.Deactivating event and before the current cell is deactivated.  
Protected Method Called from GridCurrentCell.Deactivated after the current cell is deactivated and before the GridCurrentCell.Deactivated event.  
Protected MethodOccurs before the text box contents are deleted when user presses key in cell.  
Protected Method This is called from GridSelectCellsMouseController when the user double-clicks inside a cell.  
Protected Method This method is called from the cell renderer's draw method to draw the contents of the client bounds for the cell, e.g. the text for a static cell.  
Protected Method Called to draw / erase the background for a cell.  
Protected Method Draws the cell button element at the specified row and column index.  
Protected MethodDraws a button using System.Windows.Forms.ControlPaint.DrawButton(System.Drawing.Graphics,System.Drawing.Rectangle,System.Windows.Forms.ButtonState); if XP Themes are enabled, button will be drawn themed.  
Protected Method Occurs when the grid completes editing mode for the active current cell.  
Protected MethodCalled from GridCurrentCell.EndEdit. If render had focus, SetHasFocusControl is called which triggers OnHasFocusControlChanged and initiates repainting the cell. In your overridden OnDraw method, you should then check ShouldDrawFocused which will return False.  
Protected Method Override this method if you want to change the cursor for this cell.  
Protected Method Called when the parent grid of this cell renderer gets the focus.  
Protected Method Override this method if your cell renderer supports in-place editing and you want to do any custom initialization at this point before cell gets redrawn.  
Protected Method This method is called to determine whether the cell renderer wants to receive mouse events for the give cell at the given coordinates.  
Protected Method This method gets called from the cell renderer's initialize method. Override this method if you need to any initialization for the current cell.  
Protected Method Raises the event when user pressed key down (similar to Control.OnKeyDown).  
Protected Method Raises the event when user pressed key (similar to Control.OnKeyPress).  
Protected Method Raises the event when user released key (similar to Control.OnKeyUp).  
Protected Method This method is called from PerformLayout to calculate the client rectangle given the inner rectangle of a cell and any boundaries of cell buttons.  
Protected Method Override this method if you need to know when reference to cell model is changed. This method is called after the reference to cell model has been changed.  
Protected Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has pressed a mouse button.  
Protected Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user is moving the mouse over the cell.  
Protected Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has moved the mouse into the cell.  
Protected Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user is moving the mouse out of the cell.  
Protected Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has pressed a mouse button and is moving the mouse pointer.  
Protected Method This is called from GridClickCellsMouseController or GridSelectCellsMouseController when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has pressed a mouse button and is releasing the button.  
Protected Method Highlights the current cell by inverting the cells border or drawing a thick border.  
Protected Method Determines whether the cell buttons shall be drawn for the specific row and column index.  
Protected Method This is called from GridCurrentCell.RejectChanges. Any drop-downs have been closed at this time.  
Protected Method This method is called from GridCurrentCell.ConfirmChanges when the current cell was marked as modified. Any drop-downs have been closed at this time. It saves changes for the current cell.  
Protected Method Called right after ControlText was set.  
Protected Method This is called from GridCurrentCell.ShowDropDown after BeginEdit has been called.  
Protected Method Occurs before the current cell switches into editing mode.  
Protected Method This method is called from GridCurrentCell.Validate after GridCurrentCell.Validating event has been fired. The default version checks if the active text fits any criteria as specified in the style object: It can be parsed into a cell value and meets GridCellValidateValueInfo criteria.  
Protected Method This method is called from GridCurrentCell.Validate after the current cell contents were successfully validated and before GridCurrentCell.Validated event is. fired.  
Protected Method This is called from GridControlBase.ProcessKeyEventArgs and allows your customized cell renderer to process keyboard events before the GridControlBase gets the actual KeyDown / KeyUp event.  
Protected Method Removes a GridCellButton from the cell renderer's list of cell buttons.  
Protected Method Removes TextMargins from the specified client bounds.  
Protected Internal Method Sets a reference to the associated control.  
Protected Method Sets the cell value for the current cell and optionally initializes the ControlText based on the value.  
Protected Method Override this method if you are subscribing to events from a cell model. It is called before the reference to the cell model is reset or when dispose has been called.  
Protected Method Override this method if you are subscribing to events from a cell model. It is called after the reference to the cell model has been initialized.  
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded.  Iterates the index.
Public Extension MethodOverloaded.  Iterates the index.
Top
See Also