Class GridPushButtonCellRenderer
Implements the renderer part of a push button cell.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridPushButtonCellRenderer : GridCellRendererBase, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposableRemarks
The push button cell is XP Themes enabled. It will be drawn themed if ThemesEnabled is true.
A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridPushButtonCellModel if several views display the same GridModel.
The following table lists some characteristics about the PushButton cell type.
| Item | Description |
|---|---|
| CellType | PushButton |
| Renderer | GridPushButtonCellRenderer |
| Model | GridPushButtonCellModel |
| XP Themes Support | Yes |
| Cell Button | GridCellButton |
| Interactive | Click Only |
| Floating Support | No |
| Base Type | GridCellRendererBase |
The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class.
| PropertyName | Description |
|---|---|
| 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) | PushButton. (Default: TextBox) |
| Clickable (System.Boolean) | Specifies if the button can be clicked with the mouse. See Enabled how to disable activating the cell as current cell. (Default: true) |
| Description (System.String) | Gets or sets the text that is shown in the button. (Default: String.Empty) |
| Enabled (System.Boolean) | Specifies if the cell can be activated as current cell or if cell should be skipped when moving the current cell. When disabled, the button will be drawn grayed out. (Default: true) |
| Font (GridFontInfo) | The font for drawing text. (Default: GridFontInfo.Default) |
| HotkeyPrefix (System.Drawing.Text.HotkeyPrefix) | Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show) |
| Interior (BrushInfo) | The PushButton usually fills the whole cell area. Therefore the background is only visible if you programatically force the button to be smaller. (Default: SystemColors.Window) |
| Themed (System.Boolean) | Specifies if cell should be drawn using Windows XP themes when ThemesEnabled has been set. (Default: true) |
| Trimming (System.Drawing.StringTrimming) | Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character) |
| WrapText (System.Boolean) | Specifies if text should be wrapped when it does not fit into a single line. (Default: true) |
Constructors
GridPushButtonCellRenderer(GridControlBase, GridCellModelBase)
Initializes a new GridPushButtonCellRenderer object for the given GridControlBase and GridCellModelBase.
Declaration
public GridPushButtonCellRenderer(GridControlBase grid, GridCellModelBase cellModel)Parameters
| Type | Name | Description |
|---|---|---|
| GridControlBase | grid | The GridControlBase that displays 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.
GridPushButtonCellRenderer(GridControlBase, GridCellModelBase, GridCellButton)
Initializes a new GridPushButtonCellRenderer object for the given GridControlBase and GridCellModelBase.
Declaration
protected GridPushButtonCellRenderer(GridControlBase grid, GridCellModelBase cellModel, GridCellButton button)Parameters
| Type | Name | Description |
|---|---|---|
| GridControlBase | grid | The GridControlBase that displays this cell renderer. |
| GridCellModelBase | cellModel | The GridCellModelBase that holds data for this cell renderer that should be shared among views. |
| GridCellButton | button | The button to be drawn in the cell. |
Remarks
References to GridControlBase, and GridCellModelBase will be saved.
Fields
pushButton
Pushbutton fills the whole cell's client area with GridCellButton. This button can be customized.
Declaration
protected GridCellButton pushButtonField Value
| Type |
|---|
| GridCellButton |
Methods
OnButtonClicked(Int32, Int32, Int32)
Raises the OnButtonClicked(Int32, Int32, Int32)event.
Declaration
protected override void OnButtonClicked(int rowIndex, int colIndex, int button)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | |
| System.Int32 | colIndex | |
| System.Int32 | button |
Overrides
OnKeyDown(KeyEventArgs)
Raises the event when user pressed key down.
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.KeyEventArgs | e | An System.Windows.Forms.KeyEventArgs that contains event data. |
Overrides
OnKeyUp(KeyEventArgs)
Raises the event when user released key.
Declaration
protected override void OnKeyUp(KeyEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.KeyEventArgs | e | An System.Windows.Forms.KeyEventArgs that contains event data. |
Overrides
OnLayout(Int32, Int32, GridStyleInfo, Rectangle, Rectangle[])
This method is called from PerformLayout to calculate the client rectangle given the inner rectangle of a cell and any boundaries of cell buttons.
Declaration
protected override Rectangle OnLayout(int rowIndex, int colIndex, GridStyleInfo style, Rectangle innerBounds, Rectangle[] buttonsBounds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| GridStyleInfo | style | The GridStyleInfo object that holds cell information. |
| System.Drawing.Rectangle | innerBounds | The System.Drawing.Rectangle with the inner bounds of a cell. |
| System.Drawing.Rectangle[] | buttonsBounds | An array of System.Drawing.Rectangle with bounds for each cell button element. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Rectangle | A System.Drawing.Rectangle with the bounds. |
Overrides
OnOutlineCurrentCell(Graphics, Rectangle)
Declaration
protected override void OnOutlineCurrentCell(Graphics g, Rectangle r)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | |
| System.Drawing.Rectangle | r |
Overrides
OnPushButtonClick(Int32, Int32)
Raises PushButtonClick event when the user presses the PushButton.
Declaration
protected virtual void OnPushButtonClick(int rowIndex, int colIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | Specifies the row id. |
| System.Int32 | colIndex | Specifies the column id. |
OnQueryShowButtons(Int32, Int32, GridStyleInfo)
Determines whether the cell buttons shall be drawn for the specific row and column index.
Declaration
protected override bool OnQueryShowButtons(int rowIndex, int colIndex, GridStyleInfo style)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
| GridStyleInfo | style | The GridStyleInfo object that holds cell information. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Returns Boolean value to indicate the cell buttons shall be drawn for the specific row and column index. Returns true. |