Class ToolTipForm
Form based class that provides the drawing surface for displaying a customized ToolTip with an icon. Used in the SmallIcon - FullItemSelect - ButtonView mode.
Inheritance
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class ToolTipForm : Form
Constructors
ToolTipForm(GroupView)
Initializes a new instance of the ToolTipForm class using the specified GroupView control.
Declaration
public ToolTipForm(GroupView ctrl)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupView | ctrl |
Properties
Visible
Gets or sets bool specifying whether form is visible.
Declaration
public bool Visible { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Methods
OnFormClosed(FormClosedEventArgs)
Handles cleanup operations when the ToolTipForm is closed.
Declaration
protected override void OnFormClosed(FormClosedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.FormClosedEventArgs | e | An System.EventArgs that contains the event data. |
OnMouseDown(MouseEventArgs)
Handles the MouseDown event for the ToolTipForm.
Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs that contains the event data. |
Remarks
This method hides the tooltip form when the mouse is clicked and simulates a mouse down event on the associated GroupView control. It also records the time, button, and location of the mouse click for tooltip interaction tracking.
OnMouseLeave(EventArgs)
Handles the MouseLeave event for the ToolTipForm.
Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | An System.EventArgs that contains the event data. |
OnMouseMove(MouseEventArgs)
Handles the MouseMove event for the ToolTipForm.
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs that contains the event data. |
OnMouseUp(MouseEventArgs)
Handles the MouseUp event for the ToolTipForm.
Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.MouseEventArgs | e | A System.Windows.Forms.MouseEventArgs that contains the event data. |
OnPaint(PaintEventArgs)
Handles the Paint event for the ToolTipForm.
Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.PaintEventArgs | e | A System.Windows.Forms.PaintEventArgs that contains the event data. |
SetVisibleCore(Boolean)
Sets the visibility of the ToolTipForm and performs necessary initialization and message handling.
Declaration
protected override void SetVisibleCore(bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value | A boolean value indicating whether the form should be visible. |
WndProc(ref Message)
Overrides the window procedure to handle specific Windows messages for the ToolTipForm.
Declaration
protected override void WndProc(ref Message m)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Message | m |