GH_TooltipDisplayEventArgs

EventArgsReferences
public sealed class GH_TooltipDisplayEventArgs : EventArgs
Event arguments used in the Tooltip Component.

Properties

Control

#
public Control Control { get; }
Gets the control for whom the tooltip is about to be displayed.

Description

#
public string Description { get; set; }
Gets or sets the description of the tooltip. This field is optional.

Diagram

#
public Bitmap Diagram { get; set; }
Gets or sets the image that is displayed in the details section of the tooltip. This field is optional, but when it is defined, the Description property is ignored.

Icon

#
public Bitmap Icon { get; set; }
Gets or sets the icon that is displayed in the upper left hand corner of the tooltip. This field is optional.

Point

#
public Point Point { get; }
Gets the point in control coordinates for the tooltip locus.

Region

#
public Rectangle Region { get; set; }
Gets or sets the active region (in control coordinates) for this tooltip. Once a tooltip is shown inside the region, the tooltip will 'stick' to the mouse for as long as the mouse remains within this region. By default the region is set to Rectangle.Empty, which indicates that region tracking is not used for this tooltip.

Text

#
public string Text { get; set; }
Gets or sets the text of the tooltip. If you do not set the Text property, you must set the Title property or the tooltip will not be shown.

Title

#
public string Title { get; set; }
Gets or sets the title of the tooltip. If you do not set the Title property, you must set the Text property or the tooltip will not be shown.

Valid

#
public bool Valid { get; }
Gets whether there is currently enough data to display a tooltip.