Class SchemaItemCellRenderer

Provides methods used to render the schema item cell with visual styles.

Inheritance
System.Object
NonFinalizeDisposable
GridCellRendererBase
GridStaticCellRenderer
GridHeaderCellRenderer
SchemaItemCellRenderer
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 SchemaItemCellRenderer : GridHeaderCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable

Constructors

SchemaItemCellRenderer(GridControlBase, GridCellModelBase)

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

Declaration
public SchemaItemCellRenderer(GridControlBase gridControl, GridCellModelBase cellModel)
Parameters
Type Name Description
GridControlBase gridControl

The grid control that holds the top left cell.
GridCellModelBase cellModel

The data or model part of a cell type.

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

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

The column index of the current cell..
System.Int32 button

The button that is clicked.
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)

Draws the cell button element at the specified row and column index.

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

The GridCellButton to be drawn.
System.Drawing.Graphics g

The System.Drawing.Graphics context of the canvas.
System.Int32 rowIndex

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

The column index of the current cell..
System.Boolean isActive

True, if this is the active current cell; otherwise, false.
GridStyleInfo style

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

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

Draws the text of the header cell after its background has been drawn. This method is called from OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo) method.

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

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

Specifies the text rectangle. It is the cell rectangle without buttons, borders, or text margins.
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

OnGetCursor(Int32, Int32)

Changes the cursor for the schema item cell.

Declaration
protected override Cursor OnGetCursor(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..
Returns
Type Description
System.Windows.Forms.Cursor

The System.Windows.Forms.Cursor to be displayed.
Overrides

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

Calculates the client rectangle given the inner rectangle of a cell and any boundaries of cell buttons. This method is called from PerformLayout method.

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 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.
System.Drawing.Rectangle innerBounds

The System.Drawing.Rectangle that contains the inner bounds of the cell.
System.Drawing.Rectangle[] buttonsBounds

An array of System.Drawing.Rectangle that contains the bounds for each cell button element.
Returns
Type Description
System.Drawing.Rectangle

A System.Drawing.Rectangle with the bounds.
Overrides

OnMouseHover(Int32, Int32, MouseEventArgs)

Raises the System.Windows.Forms.Control.MouseHover event.

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

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

The column index of the current cell..
System.Windows.Forms.MouseEventArgs e

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

OnMouseHoverLeave(Int32, Int32, EventArgs)

Raises the OnMouseHoverLeave(Int32, Int32, EventArgs) event.

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

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

The column index of the current cell..
System.EventArgs e

A 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

A GridPrepareViewStyleInfoEventArgs that 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