menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridRichControlEditCellRenderer - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridRichControlEditCellRenderer

    Implements the renderer part of a generic control cell.

    Inheritance
    System.Object
    NonFinalizeDisposable
    GridCellRendererBase
    GridStaticCellRenderer
    GridRichControlEditCellRenderer
    Implements
    IQueryFocusInside
    IGridDropDownCell
    IPopupParent
    IPopupItem
    System.IDisposable
    Inherited Members
    GridCellRendererBase.AddButton(GridCellButton)
    GridCellRendererBase.AlwaysRaiseCellClick
    GridCellRendererBase.CanPaste()
    GridCellRendererBase.ChildClosing(IPopupChild, PopupCloseType)
    GridCellRendererBase.ClickOverImage
    GridCellRendererBase.ColIndex
    GridCellRendererBase.Control
    GridCellRendererBase.ControlDoubleClick(Object, EventArgs)
    GridCellRendererBase.ControlGotFocus(Object, EventArgs)
    GridCellRendererBase.ControlMouseDown(Object, MouseEventArgs)
    GridCellRendererBase.ControlText
    GridCellRendererBase.ControlValue
    GridCellRendererBase.Copy()
    GridCellRendererBase.CreateDropDownContainer()
    GridCellRendererBase.CurrentCell
    GridCellRendererBase.CurrentStyle
    GridCellRendererBase.Cut()
    GridCellRendererBase.Dispose()
    GridCellRendererBase.Dispose(Boolean)
    GridCellRendererBase.Draw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
    GridCellRendererBase.DrawBackground(Graphics, Rectangle, GridStyleInfo, Boolean)
    GridCellRendererBase.DrawSingleCell(Graphics, Rectangle, Int32, Int32, GridStyleInfo, Boolean)
    GridCellRendererBase.DropDownButton
    GridCellRendererBase.DropDownContainer
    GridCellRendererBase.DropDownContainerCloseDropDown(Object, PopupClosedEventArgs)
    GridCellRendererBase.DropDownContainerShowedDropDown(Object, EventArgs)
    GridCellRendererBase.DropDownContainerShowingDropDown(Object, CancelEventArgs)
    GridCellRendererBase.DropDownImp
    GridCellRendererBase.DropDownPart
    GridCellRendererBase.EnsureDropDownContainer()
    GridCellRendererBase.FindText(String, Int32, Int32, GridFindTextOptions, Boolean)
    GridCellRendererBase.ForceRefreshOnActivateCell
    GridCellRendererBase.GetButton(Int32)
    GridCellRendererBase.GetCellBoundsCore(Int32, Int32)
    GridCellRendererBase.GetCellBoundsCore(Int32, Int32, Boolean)
    GridCellRendererBase.GetCellBoundsCoreInt(Int32, Int32, Boolean)
    GridCellRendererBase.GetCellClientRectangle(Int32, Int32, GridStyleInfo, Boolean)
    GridCellRendererBase.GetCellLayout(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.GetCellText(GridStyleInfo, GridFindTextOptions)
    GridCellRendererBase.GetCellValue()
    GridCellRendererBase.GetDisplayText()
    GridCellRendererBase.GetEditState()
    GridCellRendererBase.GetMarkHeaderState(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.GetNestedCurrentCell()
    GridCellRendererBase.GetSelectedText(String)
    GridCellRendererBase.Grid
    GridCellRendererBase.HasControlText
    GridCellRendererBase.HasControlValue
    GridCellRendererBase.HasFocusControl
    GridCellRendererBase.InBeginEdit
    GridCellRendererBase.InInitialize
    GridCellRendererBase.Initalized
    GridCellRendererBase.InitalizedAt(Int32, Int32)
    GridCellRendererBase.Initialize(Int32, Int32)
    GridCellRendererBase.InitializeControlText(Object)
    GridCellRendererBase.InitializedAt(Int32, Int32)
    GridCellRendererBase.InitializeDropDownContainer()
    GridCellRendererBase.InSetControlText
    GridCellRendererBase.InSetControlValue
    GridCellRendererBase.InSetSetControlValue
    GridCellRendererBase.IPopupItem.GetPopupParentControl()
    GridCellRendererBase.IPopupParent.GetBorderOverlapCue(PopupRelativeAlignment)
    GridCellRendererBase.IPopupParent.GetLocationForPopupAlignment(PopupRelativeAlignment, PopupRelativeAlignment)
    GridCellRendererBase.IPopupParent.IsRightToLeft
    GridCellRendererBase.IsControlVisible()
    GridCellRendererBase.IsDisposed
    GridCellRendererBase.IsDisposing
    GridCellRendererBase.IsDroppedDown
    GridCellRendererBase.IsEditing
    GridCellRendererBase.IsReadOnly()
    GridCellRendererBase.IsRelatedControl(Control, Boolean)
    GridCellRendererBase.Model
    GridCellRendererBase.MouseDownPoint
    GridCellRendererBase.MouseDownTick
    GridCellRendererBase.NotifyCurrentCellChanged()
    GridCellRendererBase.NotifyCurrentCellChanging()
    GridCellRendererBase.NotifyCurrentCellControlDoubleClick(Control)
    GridCellRendererBase.NotifyCurrentCellControlGotFocus(Control)
    GridCellRendererBase.NotifyCurrentCellControlLostFocus(Control)
    GridCellRendererBase.NotifyShowedDropDown()
    GridCellRendererBase.NotifyShowingDropDown(Size)
    GridCellRendererBase.OnBeginEdit()
    GridCellRendererBase.OnCancelMode(Int32, Int32)
    GridCellRendererBase.OnCloseDropDown(PopupCloseType)
    GridCellRendererBase.OnControlDoubleClick(Control)
    GridCellRendererBase.OnDeactivating()
    GridCellRendererBase.OnDeactived(Int32, Int32)
    GridCellRendererBase.OnDeleting()
    GridCellRendererBase.OnDoubleClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnDrawCellBackground(GridDrawCellBackgroundEventArgs)
    GridCellRendererBase.OnDrawCellButton(GridCellButton, Graphics, Int32, Int32, Boolean, GridStyleInfo)
    GridCellRendererBase.OnDrawCellButtonBackground(GridCellButton, Graphics, Rectangle, ButtonState, GridStyleInfo)
    GridCellRendererBase.OnEndEdit()
    GridCellRendererBase.OnGetCursor(Int32, Int32)
    GridCellRendererBase.OnGridGotFocus(EventArgs)
    GridCellRendererBase.OnHitTest(Int32, Int32, MouseEventArgs, IMouseController)
    GridCellRendererBase.OnKeyDown(KeyEventArgs)
    GridCellRendererBase.OnKeyPress(KeyPressEventArgs)
    GridCellRendererBase.OnKeyUp(KeyEventArgs)
    GridCellRendererBase.OnLayout(Int32, Int32, GridStyleInfo, Rectangle, Rectangle[])
    GridCellRendererBase.OnModelChanged(EventArgs)
    GridCellRendererBase.OnMouseDown(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnMouseHover(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnMouseHoverEnter(Int32, Int32)
    GridCellRendererBase.OnMouseHoverLeave(Int32, Int32, EventArgs)
    GridCellRendererBase.OnMouseMove(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnMouseUp(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnNotifyMsg(Message)
    GridCellRendererBase.OnOutlineCurrentCell(Graphics, Rectangle)
    GridCellRendererBase.OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)
    GridCellRendererBase.OnQueryShowButtons(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.OnRejectChanges()
    GridCellRendererBase.OnSaveChanges()
    GridCellRendererBase.OnSetControlText(String)
    GridCellRendererBase.OnShowDropDown()
    GridCellRendererBase.OnStartEditing()
    GridCellRendererBase.OnValidate()
    GridCellRendererBase.OnValidated()
    GridCellRendererBase.Paste()
    GridCellRendererBase.PerformLayout(Int32, Int32)
    GridCellRendererBase.PerformLayout(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.PerformLayout(Int32, Int32, GridStyleInfo, Rectangle)
    GridCellRendererBase.ProcessKeyEventArgs(Message)
    GridCellRendererBase.ProcessMouseWheel(MouseEventArgs)
    GridCellRendererBase.QueryFocusInside()
    GridCellRendererBase.RaiseCancelMode(Int32, Int32)
    GridCellRendererBase.RaiseClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseDoubleClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseGetCursor(Int32, Int32)
    GridCellRendererBase.RaiseHitTest(Int32, Int32, MouseEventArgs, IMouseController)
    GridCellRendererBase.RaiseMouseDown(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseMouseHover(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseMouseHoverEnter(Int32, Int32)
    GridCellRendererBase.RaiseMouseHoverLeave(Int32, Int32, EventArgs)
    GridCellRendererBase.RaiseMouseMove(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseMouseUp(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseProcessKeyEventArgs(Message)
    GridCellRendererBase.RemoveButton(GridCellButton)
    GridCellRendererBase.ReplaceSel(String)
    GridCellRendererBase.ReplaceText(String, String, Int32, Int32, GridFindTextOptions, Boolean)
    GridCellRendererBase.ResetCellLayout()
    GridCellRendererBase.ResetControlText()
    GridCellRendererBase.ResetControlValue()
    GridCellRendererBase.RowIndex
    GridCellRendererBase.ScaleFactor
    GridCellRendererBase.SetControl(Control)
    GridCellRendererBase.SetControlValue(Object, Boolean)
    GridCellRendererBase.SetEditState(Object)
    GridCellRendererBase.ShouldDrawEditing(Int32, Int32)
    GridCellRendererBase.ShouldDrawFocused(Int32, Int32)
    GridCellRendererBase.StyleInfo
    GridCellRendererBase.SupportsEditing
    GridCellRendererBase.SupportsFocusControl
    GridCellRendererBase.ToString()
    GridCellRendererBase.UnwireModel(GridCellModelBase)
    GridCellRendererBase.UpdateControlValue()
    GridCellRendererBase.ValidateString(String)
    GridCellRendererBase.WireModel(GridCellModelBase)
    GridStaticCellRenderer.CanCopy()
    GridStaticCellRenderer.CanCut()
    GridStaticCellRenderer.DrawImage(Graphics, ImageList, Int32, Rectangle)
    GridStaticCellRenderer.DrawImage(Graphics, ImageList, Int32, Rectangle, Boolean)
    GridStaticCellRenderer.DrawImage(Graphics, ImageList, Int32, Rectangle, Rectangle, Boolean)
    GridStaticCellRenderer.DrawRotatedString(Graphics, String, Font, Brush, RectangleF, StringFormat, Single, GridStyleInfo)
    GridStaticCellRenderer.DrawText(Graphics, String, Font, Rectangle, GridStyleInfo, Color)
    GridStaticCellRenderer.DrawText(Graphics, String, Font, Rectangle, GridStyleInfo, Color, Boolean)
    GridStaticCellRenderer.DrawText(Graphics, String, Font, Rectangle, GridStyleInfo, Color, Boolean, Boolean)
    GridStaticCellRenderer.GetRotatedTextBound(String, Font, StringFormat, Single, Single)
    GridStaticCellRenderer.IsPointOverImage(Int32, Int32, Point)
    GridStaticCellRenderer.RemoveMargins(Rectangle, GridStyleInfo)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public class GridRichControlEditCellRenderer : GridStaticCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable
    Remarks

    Use the Control property to associate any windows forms control with this cell type.

    Be careful when sharing this cell type among several cells. In most cases, it will cause problems and you should assign a different control to each cell's Control

    GridRichControlEditCellRenderer is derived from GridStaticCellRenderer. It adds support for embedding any custom .NET control inside a cell. But if you want to draw the content of the cell yourself, deriving from GridStaticCellRenderers and overriding its OnDraw method should be enough.

    See the SliderCells, WebBrowserCells, and PictureBoxCells for samples of this cell type.

    The following table lists some characteristics about the Control cell type:

    ItemDescription
    CellTypeControl
    RendererGridRichControlEditCellRenderer
    ModelGridRichControlEditCellModel
    XP Themes SupportNA
    InteractiveDepends on embedded control
    ControlSystem.Windows.Forms.Control
    Floating SupportNo
    Base TypeGridStaticCellRenderer

    The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class:

    PropertyNameDescription
    BaseStyle (System.String)The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
    Borders (GridBordersInfo)Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
    CellAppearance (GridCellAppearance)Specifies if cell edges shall be drawn raised, sunken, or flat (default). (Default: GridCellAppearance.Flat)
    CellTipText (System.String)ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
    CellType (System.String)Control (Default: Text Box)
    CellValue (System.Object)This property holds the cell value. Although the cell value is typically a string, it can also be any other primitive type such as int, byte, enum, or any custom type that is derived from System.Object. (Default: String.Empty)
    CellValueType (System.Type)Specifies the preferred System.Type for cell values. When you assign a value to the GridStyleInfo object, the value will be converted to this type. If the value cannot be converted, Error will contain error information. (Default: NULL)
    Control (System.Windows.Forms.Control)A custom control you can associate with a cell. (Default: NULL)
    Enabled (System.Boolean)Specifies if the cell can be activated as current cell or if the cell should be skipped when moving the current cell. (Default: True)
    Error (System.String)Holds error information if a value could not be converted to the System.Type specified with CellValueType. (Default: String.Empty)
    Interior (BrushInfo) Lets you specify a solid backColor, gradient, or pattern style with both back and foreColor for a cells background. (Default: SystemColors.Window)
    ReadOnly (System.Boolean)Specifies if cell contents can be modified by the user. You can programatically change Read-only cells by setting DiscardReadOnly to True. (Default: False)

    Constructors

    GridRichControlEditCellRenderer(GridControlBase, GridCellModelBase)

    Initializes a new GridRichControlEditCellRenderer object for the given GridControlBase and GridCellModelBase.

    Declaration
    public GridRichControlEditCellRenderer(GridControlBase grid, GridCellModelBase cellModel)
    Parameters
    Type Name Description
    GridControlBase grid

    The GridControlBase that display this cell renderer.

    GridCellModelBase cellModel

    The GridCellModelBase that holds data for this cell renderer that should be shared among views.

    Remarks

    References to GridControlBase and GridCellModelBase will be saved.

    Properties

    PassedControl

    Gets or sets the value of control to the passedControl.

    Declaration
    public Control PassedControl { get; set; }
    Property Value
    Type
    System.Windows.Forms.Control

    Methods

    ControlLostFocus(Object, EventArgs)

    Used to change the behavior of the ControlLostFocus event

    Declaration
    protected override void ControlLostFocus(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    Represents the root of the hierarchy

    System.EventArgs e

    provides the value to use for events

    Overrides
    GridCellRendererBase.ControlLostFocus(Object, EventArgs)

    DrawCellAppearance(Graphics, Rectangle, GridStyleInfo)

    Used to change the behavior of the DrawCellAppearance event

    Declaration
    protected override void DrawCellAppearance(Graphics g, Rectangle rect, GridStyleInfo style)
    Parameters
    Type Name Description
    System.Drawing.Graphics g

    Represents the GDI+ surfaces

    System.Drawing.Rectangle rect

    Represents the location and size of the rectangle

    GridStyleInfo style

    Used to store all the information of the cell

    Overrides
    GridCellRendererBase.DrawCellAppearance(Graphics, Rectangle, GridStyleInfo)

    FixControlParent(Control)

    Parents the control to the grid instance and ensures correct settings for Systems.Windows.Forms.Control.CausesValidation, Systems.Windows.Forms.Control.Anchor, and Systems.Windows.Forms.Control.Dock.

    Declaration
    protected void FixControlParent(Control control)
    Parameters
    Type Name Description
    System.Windows.Forms.Control control

    The control that is shown in this cell.

    Hide()

    Hides the control.

    Declaration
    public override void Hide()
    Overrides
    GridCellRendererBase.Hide()

    OnActivated()

    Used to change the behavior of the OnActivated event

    Declaration
    protected override void OnActivated()
    Overrides
    GridCellRendererBase.OnActivated()

    OnActivating(Int32, Int32)

    This is called from GridCurrentCell.Activate after the activating event has been raised and allows interception of cell activation.

    Declaration
    protected override bool OnActivating(int rowIndex, int colIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    Returns
    Type Description
    System.Boolean

    True is cell can be activated; False otherwise.

    Overrides
    GridCellRendererBase.OnActivating(Int32, Int32)

    OnButtonClicked(Int32, Int32, Int32)

    Used to change the behavior of the OnButtonClicked event

    Declaration
    protected override void OnButtonClicked(int rowIndex, int colIndex, int button)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    used to get the row value of the cell

    System.Int32 colIndex

    used to get the column value of the cell

    System.Int32 button

    used to get the button value

    Overrides
    GridCellRendererBase.OnButtonClicked(Int32, Int32, Int32)

    OnCellLayoutChanged()

    Used to change the behavior of the CellLayout event

    Declaration
    protected override void OnCellLayoutChanged()
    Overrides
    GridCellRendererBase.OnCellLayoutChanged()

    OnClick(Int32, Int32, MouseEventArgs)

    This is called from GridSelectCellsMouseController when the user clicked inside a cell.

    Declaration
    protected override void OnClick(int rowIndex, int colIndex, MouseEventArgs e)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    System.Windows.Forms.MouseEventArgs e

    A System.Windows.Forms.MouseEventArgs with data about the mouse event.

    Overrides
    GridCellRendererBase.OnClick(Int32, Int32, MouseEventArgs)

    OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)

    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.

    Declaration
    protected override void OnDraw(Graphics g, Rectangle clientRectangle, int rowIndex, int colIndex, GridStyleInfo style)
    Parameters
    Type Name Description
    System.Drawing.Graphics g

    Points to the device context.

    System.Drawing.Rectangle clientRectangle

    Specifies the client rectangle. It is the cell rectangle without buttons and borders.

    System.Int32 rowIndex

    Specifies the row id.

    System.Int32 colIndex

    Specifies the column id.

    GridStyleInfo style

    A reference to the style object of the cell.

    Overrides
    GridStaticCellRenderer.OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
    Remarks

    When drawing cells, it is necessary to determine if the specified cell (with rowIndex and colIndex) is the current cell and if it is active.

    If your control is associated with a control and supports in-place editing and the specified cell is the current cell, you should position the control. Take a look at the GridTextBoxCellRenderer implementation of this method for an example.

    Otherwise, you can simply draw the cell.

    OnEditingComplete()

    Used to change the behavior of the OnEditingComplete event

    Declaration
    protected override void OnEditingComplete()
    Overrides
    GridCellRendererBase.OnEditingComplete()

    OnHasFocusControlChanged()

    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.

    Declaration
    protected override void OnHasFocusControlChanged()
    Overrides
    GridCellRendererBase.OnHasFocusControlChanged()
    Remarks

    The default behavior of this virtual method is to force a redraw of the current cell. A cell can then initialize an edit control and set focus in the OnDraw method call.

    OnInitialize(Int32, Int32)

    This method gets called from the cell renderer's initialize method. Override this method if you need to any initialization for the current cell.

    Declaration
    protected override void OnInitialize(int rowIndex, int colIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    Overrides
    GridCellRendererBase.OnInitialize(Int32, Int32)

    OnScrollInView(GridScrollCurrentCellReason)

    Used to change the behavior of the scroll into view

    Declaration
    public override bool OnScrollInView(GridScrollCurrentCellReason reason)
    Parameters
    Type Name Description
    GridScrollCurrentCellReason reason

    The GridScrollCurrentCellReason provides the value to use for events

    Returns
    Type
    System.Boolean
    Overrides
    GridCellRendererBase.OnScrollInView(GridScrollCurrentCellReason)

    PanelCancel(Object, EventArgs)

    Event handler for the Cancel event of the GridRichTextEntryPanel.

    Declaration
    protected virtual void PanelCancel(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.EventArgs e

    The System.EventArgsthat contains event data.

    PanelSave(Object, EventArgs)

    Event handler for the Save event of the GridRichTextEntryPanel.

    Declaration
    protected virtual void PanelSave(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.EventArgs e

    The System.EventArgsthat contains event data.

    ShouldRefreshCurrentCell()

    Used to change the behavior of the ShouldRefreshCurrentCell event

    Declaration
    public override bool ShouldRefreshCurrentCell()
    Returns
    Type
    System.Boolean
    Overrides
    GridCellRendererBase.ShouldRefreshCurrentCell()

    Implements

    IQueryFocusInside
    IGridDropDownCell
    IPopupParent
    IPopupItem
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved