Skip to main content
A newer version of this page is available. .

LayoutView.CustomDrawCardFieldCaption Event

Enables card field captions to be custom painted.

Namespace: DevExpress.XtraGrid.Views.Layout

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

[DXCategory("CustomDraw")]
public event RowCellCustomDrawEventHandler CustomDrawCardFieldCaption

Event Data

The CustomDrawCardFieldCaption event's data class is RowCellCustomDrawEventArgs. The following properties provide information specific to this event:

Property Description
Appearance Gets the painted element’s appearance settings. Inherited from CustomDrawEventArgs.
Bounds Returns a value specifying limits for the drawing area. Inherited from CustomDrawEventArgs.
Cache Provides methods to paint on drawing surfaces in GDI+ and DirectX modes. See DirectX hardware acceleration to learn more. Inherited from CustomDrawEventArgs.
Cell Provides information on the painted cell.
CellValue Gets the painted value or display text (depending on the event).
Column Gets the column whose element is being painted.
DisplayText Gets or sets the painted element’s display text.
Graphics A GDI+ drawing surface. Use the CustomDrawEventArgs.Cache property instead if you enable the DirectX hardware acceleration. Inherited from CustomDrawEventArgs.
Handled Gets or sets a value specifying whether an event was handled and that the default element painting is therefore not required. Inherited from CustomDrawEventArgs.
RowHandle Gets the handle of a painted element’s row.

The event data class exposes the following methods:

Method Description
DefaultDraw() Performs default painting of an element. Inherited from CustomDrawEventArgs.

Remarks

The CustomDrawCardFieldCaption event fires each time a card field caption needs to be repainted. The event enables you to paint such elements manually, or to modify your element’s settings before it is painted in the default manner. See the Custom Painting Basics and Custom Painting Scenarios topics for information on using custom draw events.

Important

Never change cell values or modify the control’s layout on this event, or any other event designed to tune the control’s appearance. Any action that causes a layout update can cause the control to malfunction.

See Also