Class PivotRowHeaderCellRenderer

Implements the CellRenderer for the PivotRowHeaderCellModel.

Inheritance
System.Object
NonFinalizeDisposable
GridCellRendererBase
GridStaticCellRenderer
GridHeaderCellRenderer
PivotRowHeaderCellRenderer
Inherited Members
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.PivotAnalysis
Assembly: Syncfusion.PivotAnalysis.Windows.dll
Syntax
public class PivotRowHeaderCellRenderer : GridHeaderCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable

Constructors

PivotRowHeaderCellRenderer(GridControlBase, GridCellModelBase)

Initializes a new instance of PivotRowHeaderCellRenderer class with the specified GridControlBase and GridCellModelBase.

Declaration
public PivotRowHeaderCellRenderer(GridControlBase gridControlBase, GridCellModelBase cellModel)
Parameters
Type Name Description
GridControlBase gridControlBase

The instance of GridControlBase class.
GridCellModelBase cellModel

The instance of GridCellModelBase class.

Methods

OnButtonClicked(Int32, Int32, Int32)

Called when the user clicks on a button inside the cell.

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

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
System.Int32 button

Clicked button.
Overrides

OnClick(Int32, Int32, MouseEventArgs)

Overridden to suppress the click event.

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

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

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

Draws the contents of the client bounds for the cell, e.g. the text for a static cell.

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

Points to the device context.
System.Drawing.Rectangle clientRectangle

Specifies the client rectangle without buttons and borders.
System.Int32 rowIndex

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
GridStyleInfo style

The GridStyleInfo object that holds the style information for the cell.
Overrides

OnDrawCellButton(GridCellButton, Graphics, Int32, Int32, Boolean, GridStyleInfo)

Overridden to draw the button for this cell.

Declaration
protected override void OnDrawCellButton(GridCellButton button, Graphics g, int rowIndex, int colIndex, bool bActive, GridStyleInfo style)
Parameters
Type Name Description
GridCellButton button

Instance of the grid cell button to be drawn.
System.Drawing.Graphics g

Graphics associated with this control.
System.Int32 rowIndex

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
System.Boolean bActive

Boolean value.
GridStyleInfo style

Style information of this cell.
Overrides

OnDrawDisplayText(Graphics, Rectangle, Int32, Int32, GridStyleInfo)

Overridden to draw the cell text.

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

Graphics associated with this control.
System.Drawing.Rectangle textRectangle

Text rectangle of this cell.
System.Int32 rowIndex

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
GridStyleInfo style

Style information associated with this cell.
Overrides

OnGetCursor(Int32, Int32)

Overridden to change the cursor for this PivotRowHeaderCell.

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

Row index of the cell.
System.Int32 colIndex

Column index of the cell.
Returns
Type Description
System.Windows.Forms.Cursor

Returns the cursor.
Overrides

OnLayout(Int32, Int32, GridStyleInfo, Rectangle, Rectangle[])

Overridden to prepare the layout appearance of the cell.

Declaration
protected override Rectangle OnLayout(int rowIndex, int colIndex, GridStyleInfo style, Rectangle innerBounds, Rectangle[] buttonsBounds)
Parameters
Type Name Description
System.Int32 rowIndex

RowIndex of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
GridStyleInfo style

Style information of the cell.
System.Drawing.Rectangle innerBounds

Inner text rectangle area.
System.Drawing.Rectangle[] buttonsBounds

Button bounds for the associated button in control.
Returns
Type Description
System.Drawing.Rectangle

The inner bounds of the cell.
Overrides

OnMouseDown(Int32, Int32, MouseEventArgs)

Overridden to invalidate the mouse-down cell-range.

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

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseHover(Int32, Int32, MouseEventArgs)

Overridden to invalidate the cell when mouse hovered over the cell.

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

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnMouseHoverLeave(Int32, Int32, EventArgs)

Overridden to invalidate get the hovered range of cells in grid.

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

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
System.EventArgs e

The System.EventArgs that contains the event data.
Overrides

OnMouseUp(Int32, Int32, MouseEventArgs)

Overridden to invalidate the clicked header cell-range.

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

Row index of this cell in grid.
System.Int32 colIndex

Column index of this cell in grid.
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)

Raises the PrepareViewStyleInfo event.

Declaration
public override void OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs e)
Parameters
Type Name Description
GridPrepareViewStyleInfoEventArgs e

The GridPrepareViewStyleInfoEventArgs contains the event data.
Overrides

OnPushButtonClick(Int32, Int32)

Raises PushButtonClick event when the user presses the push button.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.

Implements

System.IDisposable