CardView.CustomDrawCardFieldCaption Event
Enables you to custom paint card field captions.
Namespace: DevExpress.XtraGrid.Views.Card
Assembly: DevExpress.XtraGrid.v18.1.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.
Note
The CustomDrawCardFieldCaption event is not raised if you handle the CardView.CustomDrawCardField event and set its CustomDrawEventArgs.Handled parameter to true.
Note
The control’s events designed to change the appearance or rendering of control elements must not be used to update cell values or to modify the control’s layout. Any inappropriate operation which causes a layout update, may break the normal control behavior.
Example
The example shows how to use the CardView.CustomDrawCardFieldCaption event to custom paint card field captions. Field captions are drawn differently for focused and non-focused fields.
private void cardView1_CustomDrawCardFieldCaption(object sender, Views.Base.RowCellCustomDrawEventArgs e) {
CardView cv = sender as CardView;
bool isFocusedFieldAndCard = false;
if (cv.FocusedColumn != null)
isFocusedFieldAndCard = e.Column.AbsoluteIndex == cv.FocusedColumn.AbsoluteIndex &&
e.RowHandle == cv.FocusedRowHandle;
//The brush to draw the background of card field captions
Brush backBrush;
Color color1 = Color.FromArgb(240, 240, 240);
Color color2 = Color.FromArgb(166, 166, 166);
if (isFocusedFieldAndCard)
backBrush = e.Cache.GetGradientBrush(e.Bounds, color1, color2, LinearGradientMode.Horizontal);
else
backBrush = e.Cache.GetGradientBrush(e.Bounds, color2, color1, LinearGradientMode.Horizontal);
e.Cache.FillRectangle(backBrush, e.Bounds);
e.Appearance.DrawString(e.Cache, e.DisplayText, e.Bounds);
//Prevent default painting
e.Handled = true;
}