'Declaration Public Event OwnerDrawOutlineButton As EventHandler(Of OwnerDrawOutlineButtonEventArgs)
public event EventHandler<OwnerDrawOutlineButtonEventArgs> OwnerDrawOutlineButton
Event Data
The event handler receives an argument of type OwnerDrawOutlineButtonEventArgs containing data related to this event. The following OwnerDrawOutlineButtonEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Bounds | Get the rectangle where the outline button will be painted (in client coordinates). |
| Col | Get column index of the cell which contains the outline button being painted. |
| Graphics | Gets the Graphics object used to draw the outline button. Use this object to draw custom elements in the outline button. |
| Handled | Gets or sets whether the event has finished drawing the outline button. |
| Image | Gets or sets the image that will be displayed in the cell. |
| Level | Get the level of the tree which will be collapsed by clicking on the outline button. |
| Row | Get the row index of the cell which contains the outline button being painted. |
| Style | Sets or sets the CellStyle object used to paint the outline button. |
| Text | Gets or sets the text that will be displayed in the outline button. |
Remarks
The OnOwnerDrawOutlineButton event only fires when the DrawMode property is set to DrawModeEnum.OwnerDraw.
You can use this event to customize the appearance of tree outline button in the grid. The event allows three main types of customization:
- Change the value of the Text and Image parameters to modify the values displayed by the grid. You can use this type of customization to replace level strings with + or - symbols, for example.
- Change the Style property to display the outline button using a different style than the one selected by the grid by default.
- Use the Graphics and Bounds parameters and draw the tree outline button yourself. When drawing outline buttons this way, you may call the OwnerDrawOutlineButtonEventArgs.DrawOutlineButton member to force the grid to draw specific parts of the outline button, while your code draws other parts. For example, you could paint a custom background and then call DrawCell to have the grid paint the outline button border and contents.
See Also