Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
DataGridViewCellToolTipTextNeededEventHandler Delegate
Collapse the table of content
Expand the table of content

DataGridViewCellToolTipTextNeededEventHandler Delegate

Represents the method that will handle the CellToolTipTextNeeded event of a DataGridView.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

type DataGridViewCellToolTipTextNeededEventHandler = 
    delegate of  
        sender:Object * 
        e:DataGridViewCellToolTipTextNeededEventArgs -> unit

Parameters

sender
Type: System.Object

The source of the event.

e
Type: System.Windows.Forms.DataGridViewCellToolTipTextNeededEventArgs

A DataGridViewCellToolTipTextNeededEventArgs that contains the event data.

The CellToolTipTextNeeded event occurs only when the DataGridView control DataSource property is set or its VirtualMode property is true.

When you handle the CellToolTipTextNeeded event, the ToolTip text you specify in the handler is shown whenever the mouse pointer is over a cell and the control ShowCellToolTips property value is true. The CellToolTipTextNeeded event is useful when you want to display ToolTips determined by the current state or value of a cell.

The CellToolTipTextNeeded event also occurs whenever the value of the DataGridViewCell.ToolTipText property is retrieved, either programmatically or when the mouse pointer enters a cell.

You can use the DataGridViewCellEventArgs.ColumnIndex and RowIndex properties to determine the state or value of a cell, and use this information to set the ToolTipText property. This property is initialized with the value of the cell ToolTipText property, which the event value overrides.

Handle the CellToolTipTextNeeded event when working with large amounts of data to avoid the performance penalties of setting the cell ToolTipText value for multiple cells. For more information, see Best Practices for Scaling the Windows Forms DataGridView Control.

For more information about handling events, see Consuming Events.

When you create a DataGridViewCellToolTipTextNeededEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Events and Delegates.

The following code example uses ToolTips to display additional information about cell contents in the ReportsTo column.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft