menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridTextBoxCellRenderer - API Reference

    Show / Hide Table of Contents

    Class GridTextBoxCellRenderer

    Represents the class that used for drawing the text box cell.

    Inheritance
    System.Object
    GridCellRendererBase
    GridVirtualizingCellRendererBase<System.Windows.Forms.TextBox>
    GridTextBoxCellRenderer
    GridUnboundCellRenderer
    GridUnboundRowCellRenderer
    Implements
    IGridCellRenderer<TableControl>
    System.IDisposable
    Inherited Members
    GridVirtualizingCellRendererBase<TextBox>.InitializeEditElement(DataColumnBase, RowColumnIndex, TextBox)
    GridVirtualizingCellRendererBase<TextBox>.BeginEdit(DataColumnBase, RowColumnIndex)
    GridVirtualizingCellRendererBase<TextBox>.EndEdit(DataColumnBase, RowColumnIndex)
    GridVirtualizingCellRendererBase<TextBox>.OnCreateEditUIElement()
    GridVirtualizingCellRendererBase<TextBox>.OnEnteredEditMode(TextBox)
    GridVirtualizingCellRendererBase<TextBox>.OnEditingComplete(DataColumnBase, TextBox)
    GridCellRendererBase.SetCurrentCellState(RowColumnIndex, Control, Boolean, Boolean)
    GridCellRendererBase.ResetCurrentCellState()
    GridCellRendererBase.SetFocus(Boolean)
    GridCellRendererBase.UnloadUIElement()
    GridCellRendererBase.Dispose()
    GridCellRendererBase.Render(Graphics, Rectangle, String, CellStyleInfo, DataColumnBase, RowColumnIndex)
    GridCellRendererBase.MouseHover(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseDown(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.MouseDoubleClick(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.UpdateEditElement(DataColumnBase, Control, Rectangle)
    GridCellRendererBase.DrawErrorIcon(Graphics, Rectangle, Bitmap, RowColumnIndex)
    GridCellRendererBase.KeyDown(DataColumnBase, RowColumnIndex, KeyEventArgs)
    GridCellRendererBase.KeyPress(DataColumnBase, RowColumnIndex, KeyPressEventArgs)
    GridCellRendererBase.KeyUp(DataColumnBase, RowColumnIndex, KeyEventArgs)
    GridCellRendererBase.IGridCellRenderer<TableControl>.OnDrawCurrentCell(Graphics, SfDataGrid, RowColumnIndex)
    GridCellRendererBase.CanValidate()
    GridCellRendererBase.GetCellValue()
    GridCellRendererBase.SetFocus(Control, Boolean)
    GridCellRendererBase.OnUpdateEditElement(DataColumnBase, Control, Rectangle)
    GridCellRendererBase.OnDrawCurrentCell(Graphics, SfDataGrid, RowColumnIndex)
    GridCellRendererBase.Dispose(Boolean)
    GridCellRendererBase.OnDrawErrorIcon(Graphics, Rectangle, Bitmap, RowColumnIndex)
    GridCellRendererBase.OnMouseHover(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.OnMouseMove(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.OnMouseHoverLeave(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.OnMouseUp(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.OnMouseDown(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.OnMouseDoubleClick(DataColumnBase, RowColumnIndex, MouseEventArgs)
    GridCellRendererBase.ShowValidationErrorToolTip(SfToolTip, DataColumnBase, RowColumnIndex, Point)
    GridCellRendererBase.UpdateCurrentCellState(Control, Boolean)
    GridCellRendererBase.TableControl
    GridCellRendererBase.IsEditable
    GridCellRendererBase.IsFocusable
    GridCellRendererBase.HasCurrentCellState
    GridCellRendererBase.CurrentCellIndex
    GridCellRendererBase.CurrentCellRendererElement
    GridCellRendererBase.IsInEditing
    GridCellRendererBase.IsFocused
    GridCellRendererBase.IsHovered
    GridCellRendererBase.IsPressed
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.WinForms.DataGrid.Renderers
    Assembly: Syncfusion.SfDataGrid.WinForms.dll
    Syntax
    public class GridTextBoxCellRenderer : GridVirtualizingCellRendererBase<TextBox>, IGridCellRenderer<TableControl>, IDisposable

    Constructors

    GridTextBoxCellRenderer()

    Initializes a new instance of the GridTextBoxCellRenderer class.

    Declaration
    public GridTextBoxCellRenderer()

    Methods

    GetControlValue()

    Overridden to get the control value.

    Declaration
    public override object GetControlValue()
    Returns
    Type Description
    System.Object

    Returns the control value.

    Overrides
    GridCellRendererBase.GetControlValue()

    GetEditorUIElementBounds()

    Overridden to get the proper editor element bounds.

    Declaration
    protected override Rectangle GetEditorUIElementBounds()
    Returns
    Type Description
    System.Drawing.Rectangle

    Returns the editor element bounds.

    Overrides
    GridCellRendererBase.GetEditorUIElementBounds()

    OnInitializeEditElement(DataColumnBase, RowColumnIndex, TextBox)

    Overridden to initialize the text box as editor control of the cell.

    Declaration
    protected override void OnInitializeEditElement(DataColumnBase column, RowColumnIndex rowColumnIndex, TextBox uiElement)
    Parameters
    Type Name Description
    DataColumnBase column

    The DataColumnBase of the current cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the current cell.

    System.Windows.Forms.TextBox uiElement

    The text box of the current cell.

    Overrides
    Syncfusion.WinForms.DataGrid.Renderers.GridVirtualizingCellRendererBase<System.Windows.Forms.TextBox>.OnInitializeEditElement(Syncfusion.WinForms.DataGrid.DataColumnBase, Syncfusion.WinForms.GridCommon.ScrollAxis.RowColumnIndex, System.Windows.Forms.TextBox)

    OnKeyDown(DataColumnBase, RowColumnIndex, KeyEventArgs)

    Occurs when the key is pressed while the cell has focus.

    Declaration
    protected override void OnKeyDown(DataColumnBase dataColumn, RowColumnIndex rowColumnIndex, KeyEventArgs e)
    Parameters
    Type Name Description
    DataColumnBase dataColumn

    The DataColumnBase of the cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the cell.

    System.Windows.Forms.KeyEventArgs e

    The System.Windows.Forms.KeyEventArgs that contains the event data.

    Overrides
    GridCellRendererBase.OnKeyDown(DataColumnBase, RowColumnIndex, KeyEventArgs)

    OnKeyPress(DataColumnBase, RowColumnIndex, KeyPressEventArgs)

    Occurs when the key is pressed while the cell has focus.

    Declaration
    protected override void OnKeyPress(DataColumnBase dataColumn, RowColumnIndex rowColumnIndex, KeyPressEventArgs e)
    Parameters
    Type Name Description
    DataColumnBase dataColumn

    The DataColumnBase of the cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the cell.

    System.Windows.Forms.KeyPressEventArgs e

    The System.Windows.Forms.KeyEventArgs that contains the event data.

    Overrides
    GridCellRendererBase.OnKeyPress(DataColumnBase, RowColumnIndex, KeyPressEventArgs)

    OnKeyUp(DataColumnBase, RowColumnIndex, KeyEventArgs)

    Occurs when the key is released while the cell has focus.

    Declaration
    protected override void OnKeyUp(DataColumnBase dataColumn, RowColumnIndex rowColumnIndex, KeyEventArgs e)
    Parameters
    Type Name Description
    DataColumnBase dataColumn

    The DataColumnBase of the cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the cell.

    System.Windows.Forms.KeyEventArgs e

    The System.Windows.Forms.KeyEventArgs that contains the event data.

    Overrides
    GridCellRendererBase.OnKeyUp(DataColumnBase, RowColumnIndex, KeyEventArgs)

    OnRender(Graphics, Rectangle, String, CellStyleInfo, DataColumnBase, RowColumnIndex)

    Overridden to draw the text box cell.

    Declaration
    protected override void OnRender(Graphics paint, Rectangle cellRect, string cellValue, CellStyleInfo style, DataColumnBase column, RowColumnIndex rowColumnIndex)
    Parameters
    Type Name Description
    System.Drawing.Graphics paint

    The System.Drawing.Graphics that used to draw the cell.

    System.Drawing.Rectangle cellRect

    The bounds of the cell.

    System.String cellValue

    The value of the cell.

    CellStyleInfo style

    The CellStyleInfo of the cell.

    DataColumnBase column

    The DataColumnBase of the cell.

    RowColumnIndex rowColumnIndex

    The row and column index of the cell.

    Overrides
    GridCellRendererBase.OnRender(Graphics, Rectangle, String, CellStyleInfo, DataColumnBase, RowColumnIndex)

    OnUnwireEditUIElement(TextBox)

    Overridden to unwire the events of the TextBox.

    Declaration
    protected override void OnUnwireEditUIElement(TextBox uiElement)
    Parameters
    Type Name Description
    System.Windows.Forms.TextBox uiElement

    The TextBox control.

    Overrides
    Syncfusion.WinForms.DataGrid.Renderers.GridVirtualizingCellRendererBase<System.Windows.Forms.TextBox>.OnUnwireEditUIElement(System.Windows.Forms.TextBox)

    OnWireEditUIElement(TextBox)

    Overridden to wire the events of the TextBox.

    Declaration
    protected override void OnWireEditUIElement(TextBox uiElement)
    Parameters
    Type Name Description
    System.Windows.Forms.TextBox uiElement

    The TextBox control.

    Overrides
    Syncfusion.WinForms.DataGrid.Renderers.GridVirtualizingCellRendererBase<System.Windows.Forms.TextBox>.OnWireEditUIElement(System.Windows.Forms.TextBox)

    SetControlValue(Object)

    Overridden to set the control value.

    Declaration
    public override void SetControlValue(object value)
    Parameters
    Type Name Description
    System.Object value

    The control value.

    Overrides
    GridCellRendererBase.SetControlValue(Object)

    Implements

    IGridCellRenderer<T>
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved