Provides data and methods for Cell painting

Namespace: Dapfor.Net.Ui
Assembly: Dapfor.Net (in Dapfor.Net.dll) Version: 2.10.3.24917 (2.10.3.24917)

Syntax

C#
public sealed class PaintCellEventArgs : EventArgs
Visual Basic
Public NotInheritable Class PaintCellEventArgs
	Inherits EventArgs
Visual C++
public ref class PaintCellEventArgs sealed : public EventArgs
F#
[<SealedAttribute>]
type PaintCellEventArgs =  
    class
        inherit EventArgs
    end

Remarks

.Net Grid provides broad functionality of displaying various grid elements, such as cells, rows, headers and columns.

There two ways for grid customization:

Generally paint arguments contain the following information:

  • Full and clipped sizes of the painted element
  • Graphics object
  • Colors and parameters used for elemebt painting (they can be altered)
  • Methods for painting every single part of an element (for a Cell there are methods for painting background, text, selection, focus etc.)
  • Painting filter' PaintPart, which allows to skip a certain part of an element (partial painting)
  • PaintAll() method that paints all elements defined in the PaintPart filter
  • Handled property that forbids a grid to perform default painting

Note that the whole painting process is accumulated in paint arguments object and consists of the following: a grid creates PaintXXXEventArgs object, sets default parameters, fires Grid.PaintXXX event, and if Handled property is set to false, invokes PaintAll() method. This mechanism is used to paint all elements of the .Net Grid' cells, rows, columns, headers, hierarchy tree etc.

We have intentionally described the process of painting in details to show broad and rich abilities of grid customization. In other words, you may customize any parameters, some painted elements (cell, column) and even use Graphics object to manipulate the grid. Even better, this approach enables you to define a painting sequence. For example, you may perform some default actions and then finish drawing with the Graphics object, or do it vice versa!

The following example shows how customize painting in cell

 Copy imageCopy
public void InitializeGrid(Grid grid)
{
    //Subscribe for cell painting event
    grid.PaintCell += delegate(object sender, PaintCellEventArgs e)
    {
        using(Brush brush = new SolidBrush(Color.DeepPink))
        {
            //Prevent from text painting
            e.Parts &= e.Parts ^ PaintPart.Text;

            //Set a new background color
            e.Appearance.BackColor = Color.Yellow;

            //Do default painting without text drawing
            e.PaintAll();
            e.Handled = true;

            //Draw a custom text above already pained cell
            e.Graphics.DrawString("Custom string", SystemFonts.StatusFont, brush, e.Cell.VirtualBounds);
        }
    };
}

Inheritance Hierarchy

System..::..Object
  System..::..EventArgs
    Dapfor.Net.Ui..::..PaintCellEventArgs

See Also