GrapeCity MultiRow Windows Forms Documentation
CellToolTipTextNeeded Event


Occurs when a cell's tooltip is shown.
Syntax
<SRDescriptionAttribute("Occurs when a cell's ToolTip text is needed. ")>
<SRCategoryAttribute("Behavior")>
Public Event CellToolTipTextNeeded As EventHandler(Of CellToolTipTextNeededEventArgs)
Dim instance As GcMultiRow
Dim handler As EventHandler(Of CellToolTipTextNeededEventArgs)
 
AddHandler instance.CellToolTipTextNeeded, handler
[SRDescription("Occurs when a cell's ToolTip text is needed. ")]
[SRCategory("Behavior")]
public event EventHandler<CellToolTipTextNeededEventArgs> CellToolTipTextNeeded
Event Data

The event handler receives an argument of type CellToolTipTextNeededEventArgs containing data related to this event. The following CellToolTipTextNeededEventArgs properties provide information specific to this event.

PropertyDescription
CellIndexGets the cell index in its parent Section. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
CellNameGets the cell name. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
RowIndexGets the index of the owner Row that the event occurs for. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
ScopeGets the area of the cell that the event occurs for. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
SectionIndexGets the index of the owner Section that the event occurs for. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
ToolTipTextGets or sets the cell ToolTip text.  
Remarks

This event only can be fired when the VirtualMode property is true or the DataSource property is not a null reference (Nothing in Visual Basic).

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.

You can use the CellToolTipTextNeededEventArgs's properties to determine the state or value of a cell, and use this information to change or modify the CellToolTipTextNeededEventArgs.ToolTipText property. This property is initialized with the value of the cell CellToolTipTextNeededEventArgs.ToolTipText property, which the event value overrides.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

GcMultiRow Class
GcMultiRow Members

 

 


Copyright © GrapeCity, inc. All rights reserved.