{"id":129,"date":"2012-10-11T19:49:01","date_gmt":"2012-10-11T18:49:01","guid":{"rendered":"http:\/\/tech.fabienletort.com\/?p=129"},"modified":"2012-10-11T19:49:01","modified_gmt":"2012-10-11T18:49:01","slug":"ajouter-du-texte-dans-une-datagridviewcheckboxcell","status":"publish","type":"post","link":"https:\/\/tech.fabienletort.com\/?p=129","title":{"rendered":"Ajouter du texte dans une DataGridViewCheckBoxCell"},"content":{"rendered":"

Tout d’abord expliquons pour j’ai ce besoin. Pour un projet (pro) une colonne de mon DataGrid affiche en information textuelle, une valeur num\u00e9rique modifiable. Oui mais voil\u00e0 sous certaines conditions, certaines lignes de cette colonne ne peuvent avoir que 0 ou 1 comme valeur num\u00e9rique. En m’abonnant \u00e0 l’\u00e9v\u00e8nement DataBindingComplete<\/a>, j’ai donc modifi\u00e9 \u00e0 la vol\u00e9e ces cellules en cellule avec une case \u00e0 cocher (DataGridViewCheckBoxCell<\/a>). Bien entendu, je trouvais cela un peu moins parlant. Une ligne avec une valeur num\u00e9rique pouvait \u00eatre suivie d’une case \u00e0 cocher dans la m\u00eame colonne. A la base, l’id\u00e9e de la case \u00e0 cocher, c’\u00e9tait surtout pour aider au changement de la valeur. Pourquoi donc \u00e9diter ce texte si on ne peut que mettre un 1 ou 0 ? Pour rendre plus claire cette colonne, j’ai donc eu l’id\u00e9e de faire appara\u00eetre ce 1 ou ce 0 \u00e0 c\u00f4t\u00e9 de la case \u00e0 cocher.<\/p>\n

Bien entendu cet objet n’existe pas de base dans le framework. Comme je sais qu’il ne faut pas r\u00e9inventer la roue, je suis parti sur le net \u00e0 la conqu\u00eate de la chose. Et j’ai trouv\u00e9 quelque chose, mais qui ne correspondait pas exactement \u00e0 mes besoins… forc\u00e9ment ! Mais cette source d’inspiration m’a \u00e9t\u00e9 forte utile.<\/p>\n

L’inspiration<\/h2>\n

Extending The DataGridViewCheckBoxCell To Include Text<\/a><\/p>\n

Dans cet article l’auteur veut faire la m\u00eame chose, mais pas pour le m\u00eame besoin. Au final, comme le montre sa capture finale,\u00a0 il semble vouloir avoir une liste de choix dans une ligne. Pour faire simple, le texte mis \u00e0 cot\u00e9 de la case \u00e0 cocher est un simple texte statique. Sa solution semble donc r\u00e9ellement utile que dans le cas d’une liste de choix.<\/p>\n

\"\"<\/a><\/p>\n

Je vais tout de m\u00eame me baser sur sa solution du moins en point de d\u00e9part, car au final, j’ai pas mal modifi\u00e9 (perfectionn\u00e9 ?) certains points.
\nDans la suite, mes commentaires seront donc beaucoup bas\u00e9 sur son exemple.<\/p>\n

Ma solution<\/h2>\n

Tout comme Murray, je vais donc avoir besoin de d\u00e9finir 2 classes : DataGridViewCheckBoxTextColumn<\/strong> et DataGridViewCheckBoxTextCell<\/strong>. En effet, pour avoir une solution g\u00e9n\u00e9rique, la d\u00e9finition de la colonne correspondante est \u00e0 faire. Ces 2 classes \u00e9tendront donc respectivement les classes DataGridViewCheckBoxColumn<\/em> et DataGridViewCheckBoxCell<\/em>.<\/p>\n

DataGridViewCheckBoxTextCell<\/h3>\n

Tout comme Muray, on peut commencer par d\u00e9finir cette classe. C’est tr\u00e8s simple, on modifie juste le template de la cellule par d\u00e9faut et le tour est jou\u00e9.<\/p>\n

using System;\r\nusing System.Windows.Forms;\r\n\r\nnamespace Kerlink.Windows.Forms\r\n{\r\n\u00a0\u00a0\u00a0 public class DataGridViewCheckBoxTextColumn : DataGridViewCheckBoxColumn\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 public DataGridViewCheckBoxTextColumn()\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 this.CellTemplate = new DataGridViewCheckBoxTextCell();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 }\r\n}<\/pre>\n
DataGridViewCheckTextCell<\/h3>\n
Voil\u00e0 le gros du travail. Contrairement \u00e0 Murray, je ne vais pas commencer par ajouter des propri\u00e9t\u00e9s \u00e0 cette classe. Tout comme lui, j’ai envie de faire quelque chose de g\u00e9n\u00e9rique, j\u00a0\u00bbajouterais donc des propri\u00e9t\u00e9s au fur et \u00e0 mesure que si cela est r\u00e9ellement n\u00e9cessaire. Je vais tenter d’utiliser au maximum ce qui est d\u00e9j\u00e0 d\u00e9finie dans mon objet de base, la classe DataGridViewCheckBoxCell<\/a>. Bref, ici je n’ajoute donc pas les propri\u00e9t\u00e9s Enabled, Text, Color et Font d\u00e9finie par Murray. Notre classe est donc d\u00e9j\u00e0 bien diff\u00e9rente dans sa d\u00e9finition de base :<\/p>\n
public class DataGridViewCheckAndTextCell : DataGridViewCheckBoxCell\r\n{\r\n    public DataGridViewCheckAndTextCell()\r\n    {}\r\n}<\/pre>\n
Passons donc directement \u00e0 la deuxi\u00e8me action propos\u00e9e par Murray : surcharger la m\u00e9thode DataGridViewCheckBoxCell.Paint()<\/a>. Nous allons donc en premier lieu appel\u00e9 la m\u00e9thode m\u00e8re (qui fait ce qu’elle aura \u00e0 faire, cela ne nous regarde pas) puis ajouter notre mixture locale. Voil\u00e0 la b\u00eate, qui est bien diff\u00e9rent de celle de Murray, plus courte et plus bas\u00e9e sur les propri\u00e9t\u00e9s existantes de la classe. De plus le placement du texte sera un peu plus propre (je trouve), c’est \u00e0 dire correctement aligner (verticalement) avec les autres cellules de texte, contrairement au r\u00e9sultat de la solution de Murray. Sans plus tarder, le code :<\/p>\n
protected override void Paint(System.Drawing.Graphics graphics, System.Drawing.Rectangle clipBounds, System.Drawing.Rectangle cellBounds, int rowIndex, DataGridViewElementStates elementState, object value, object formattedValue, string errorText, DataGridViewCellStyle cellStyle, DataGridViewAdvancedBorderStyle advancedBorderStyle, DataGridViewPaintParts paintParts)\r\n{\r\n    \/\/ Call the base method (which must draw the checkbox)\r\n    base.Paint(graphics, clipBounds, cellBounds, rowIndex, elementState, value, formattedValue, errorText, cellStyle, advancedBorderStyle, paintParts);\r\n\r\n    \/\/ Get the actual content Area (area where the checkbox must be)\r\n    System.Drawing.Rectangle contentBounds = this.GetContentBounds(rowIndex);\r\n\r\n    \/\/ Get Area Where String Must be Added (at 2px on the right of the checkbox)\r\n    System.Drawing.Rectangle stringArea = new System.Drawing.Rectangle();\r\n    stringArea.X = cellBounds.X + contentBounds.Right + 2;\r\n    stringArea.Y = cellBounds.Y + contentBounds.Top;\r\n    stringArea.Height = contentBounds.Height;\r\n    stringArea.Width = cellBounds.Width - contentBounds.Right - 2 - 2;\r\n\r\n    \/\/ Convert DataGridViewContentAlignment to StringFormat\r\n    System.Drawing.StringFormat format = cellStyle.Alignment.ToStringFormat();\r\n\r\n    \/\/ Draw the cell value inside the computed area\r\n    graphics.DrawString(this.Value.ToString(), cellStyle.Font, new System.Drawing.SolidBrush(cellStyle.ForeColor), stringArea, format);\r\n}<\/pre>\n
Ce qu’on fait est donc tr\u00e8s simple. Contrairement \u00e0 Murray, pas besoin de redessiner la checkbox. On a pas de notion de checkbox Enabled: ici, ce n’est pas une liste de choix. On va donc directement dessiner notre texte. On va donc passer tout sa partie de v\u00e9rification des propri\u00e9t\u00e9s et d’initialisation de variable. On commence directement \u00e0 d\u00e9finir notre espace o\u00f9 le texte doit \u00eatre dessiner, et non pas un point de d\u00e9part comme Muray. La d\u00e9finition d’une zone nous aidera pour l’alignement du texte dans cette derni\u00e8re.
\nOn r\u00e9cup\u00e8re donc la zone occup\u00e9e par le contenu actuel : contentBounds via l’appel \u00e0 GetContentBounds<\/a>. On peut alors d\u00e9finir notre rectangle qui se situera \u00e0 2 pixel \u00e0 droite du contenu actuel, de m\u00eame hauteur que le contenu actuel, et de longueur maximum, c’est \u00e0 dire ce qui reste de disponible dans la cellule en gardant une marge de 2 pixels sur sa droite.<\/p>\n
A ce stade, afin de dessiner le texte, il nous manque certains param\u00e8tre par rapport \u00e0 Murray : le texte, la police et sa couleur. Comme pr\u00e9cis\u00e9 plus haut, je vais utiliser les param\u00e8tres d\u00e9j\u00e0 d\u00e9finies dans la classe ! Il suffit de les trouver… Ainsi, pour le texte, on utilisera donc la valeur actuelle associ\u00e9 \u00e0 notre DataGridViewCheckBox. En effet dans mon cas, cette valeur est soit le chiffre 1 ou 0. Pour la police, rien ne sert d’ajouter une propri\u00e9t\u00e9, le param\u00e8tre cellSyle (de type DataGridViewCellStyle<\/a>) de la m\u00e9thode Paint contient d\u00e9j\u00e0 cette information. En effet, toute DataGridViewCell<\/a> a une telle propri\u00e9t\u00e9. De m\u00eame pour la couleur.<\/p>\n
Pour finir, par rapport \u00e0 Murray, on dessine notre texte dans une surface. Cela nous permet donc d’aligner horizontalement et verticalement ce texte dans cette surface. La m\u00e9thode DrawString<\/a> utilise le type StringFormat<\/a> pour se faire. Une propri\u00e9t\u00e9 d’alignement existe d\u00e9j\u00e0 dans notre style de cellule, mais elle est de type DataGridViewContentAlignement. Une petite m\u00e9thode d’extension (ou une m\u00e9thode statique si vous \u00eates en .net2) et le tour est jou\u00e9.<\/p>\n
On est donc en mesure de dessiner notre texte via l’appel \u00e0 DrawString de l’objet graphics.<\/p>\n
Pour information, ci joint le code du convertisseur de type :<\/p>\n
public static class DataGridViewContentAlignmentHelper\r\n{\r\n    public static System.Drawing.StringFormat ToStringFormat(this DataGridViewContentAlignment alignement)\r\n    {\r\n        System.Drawing.StringFormat format = new System.Drawing.StringFormat();\r\n\r\n        \/\/ Set the Vertical Alignement (could transform enum in string and test value ?)\r\n        switch (alignement)\r\n        {\r\n            case DataGridViewContentAlignment.BottomCenter:\r\n            case DataGridViewContentAlignment.BottomLeft:\r\n            case DataGridViewContentAlignment.BottomRight:\r\n                format.LineAlignment = System.Drawing.StringAlignment.Far;\r\n                break;\r\n\r\n            case DataGridViewContentAlignment.MiddleCenter:\r\n            case DataGridViewContentAlignment.MiddleLeft:\r\n            case DataGridViewContentAlignment.MiddleRight:\r\n            case DataGridViewContentAlignment.NotSet:\r\n                format.LineAlignment = System.Drawing.StringAlignment.Center;\r\n                break;\r\n\r\n            case DataGridViewContentAlignment.TopCenter:\r\n            case DataGridViewContentAlignment.TopLeft:\r\n            case DataGridViewContentAlignment.TopRight:\r\n                format.LineAlignment = System.Drawing.StringAlignment.Near;\r\n                break;\r\n        }\r\n\r\n        \/\/ Set the Horizontal Alignement (could transform enum in string and test value ?)\r\n        switch (alignement)\r\n        {\r\n            case DataGridViewContentAlignment.BottomCenter:\r\n            case DataGridViewContentAlignment.MiddleCenter:\r\n            case DataGridViewContentAlignment.TopCenter:\r\n                format.Alignment = System.Drawing.StringAlignment.Center;\r\n                break;\r\n\r\n            case DataGridViewContentAlignment.BottomLeft:\r\n            case DataGridViewContentAlignment.MiddleLeft:\r\n            case DataGridViewContentAlignment.TopLeft:\r\n                format.Alignment = System.Drawing.StringAlignment.Near;\r\n                break;\r\n\r\n            case DataGridViewContentAlignment.BottomRight:\r\n            case DataGridViewContentAlignment.MiddleRight:\r\n            case DataGridViewContentAlignment.NotSet:\r\n            case DataGridViewContentAlignment.TopRight:\r\n                format.Alignment = System.Drawing.StringAlignment.Far;\r\n                break;\r\n        }\r\n\r\n        return format;\r\n    }\r\n}<\/pre>\n
1er essai<\/h3>\n
Contrairement \u00e0 Murray on a pas fini. Certes la colonne est disponible depuis le designer. Certes on voit la magie apparaitre. Mais comme on pouvait s’y attendre, il manque tout le c\u00f4t\u00e9 dynamique. On a beau cocher ou d\u00e9cocher, pas de changement du texte associ\u00e9.<\/p>\n
La premi\u00e8re question \u00e0 se poser, c’est comment fait donc une DataGridViewCheckBoxCell<\/em> pour changer sa valeur quand celle-ci n’est pas un simple boolean ?<\/p>\n
On cherche, et la r\u00e9ponse est \u00e0 port\u00e9 de main ou plut\u00f4t \u00e0 port\u00e9e de 2 propri\u00e9t\u00e9s :<\/p>\n