TCnToolTip Class

Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.

Namespace: CNClrLib.Component.ToolTip
TComponent
  CNClrLib.Control.Base.TClrBaseComponent
    CNClrLib.Control.Base.TClrCustomToolTip
      CNClrLib.Component.ToolTip.TCnToolTip
type
 TCnToolTip = class(TClrCustomToolTip)
 end;

The TCnToolTip type exposes the following members.

Show:
 NameDescription
Create(TComponent)

Creates and initializes a TCnToolTip instance. (Overrides TClrCustomToolTip.Create(TComponent).)

Destroy

Frees the resources allocated with a TCnToolTip instance. (Overrides TClrBaseComponent.Destroy.)

Top
Show:
 NameDescription
Active

Gets or sets a value indicating whether the ToolTip is currently active.

AutomaticDelay

Gets or sets the automatic delay for the ToolTip.

AutoPopDelay

Gets or sets the period of time the ToolTip remains visible if the pointer is stationary on a control with specified ToolTip text.

BackColor

Gets or sets the background color for the ToolTip.

DefaultClrObject

Get the common language runtime object interface for this component. (Inherited from TClrBaseComponent.)

Duration

Gets or sets time in milliseconds to display the ToolTip. (Inherited from TClrCustomToolTip.)

ForeColor

Gets or sets the foreground color for the ToolTip.

InitialDelay

Gets or sets the time that passes before the ToolTip appears.

IsBalloon

Gets or sets a value indicating whether the ToolTip should use a balloon window.

OwnerDraw

Gets or sets a value indicating whether the ToolTip is drawn by the operating system or by code that you provide.

ReshowDelay

Gets or sets the length of time that must transpire before subsequent ToolTip windows appear as the pointer moves from one control to another.

ShowAlways

Gets or sets a value indicating whether a ToolTip window is displayed, even when its parent control is not active.

StripAmpersands

Gets or sets a value that determines how ampersand (&) characters are treated.

ToolTipIcon

Gets or sets a value that defines the type of icon to be displayed alongside the ToolTip text.

ToolTipTitle

Gets or sets a title for the ToolTip window.

UseAnimation

Gets or sets a value determining whether an animation effect should be used when displaying the ToolTip.

UseFading

Gets or sets a value determining whether a fade effect should be used when displaying the ToolTip.

Top
Show:
 NameDescription
CanExtend(Olevariant)

Returns true if the ToolTip can offer an extender property to the specified target component.

Dispose

Releases the resources used by the Component. (Inherited from TClrBaseComponent.)

DoGetDefaultClrObject

Represents method DoGetDefaultClrObject. (Inherited from TClrBaseComponent.)

DoGetDotNetBaseComponent

Represents method DoGetDotNetBaseComponent. (Overrides TClrBaseComponent.DoGetDotNetBaseComponent.)

DoOnBackColorChanged(TObject)

Represents method DoOnBackColorChanged(TObject).

DoOnForeColorChanged(TObject)

Represents method DoOnForeColorChanged(TObject).

GetClrObject

Represents method GetClrObject. (Inherited from TClrBaseComponent.)

GetToolTip(TClrCustomControl)

Retrieves the ToolTip text associated with the specified control. (Overrides TClrCustomToolTip.GetToolTip(TClrCustomControl).)

Hide(TClrCustomControl)

Hides the specified ToolTip window. (Overrides TClrCustomToolTip.Hide(TClrCustomControl).)

RegisterEventCallBack(ClrWString,Pointer)

Add an event to the instance using the specified event name and function pointer which is the event handler. The RegisterEventCallBack method does not directly add the event handler to the event. A hooking mechanism is used such that if the event is fired, the hook event is also fired which in turn calls the function pointer. (Inherited from TClrBaseComponent.)

RegisterEventSource

Register the Delphi object which will raise the .Net event handler. (Inherited from TClrBaseComponent.)

RemoveAll

Removes all ToolTip text currently associated with the ToolTip component.

SetToolTip(TClrCustomControl,String)

Associates ToolTip text with the specified control. (Overrides TClrCustomToolTip.SetToolTip(TClrCustomControl,String).)

Show(String,TClrCustomControl)

Overloaded. Sets the ToolTip text associated with the specified control, and displays the ToolTip modally. (Overrides TClrCustomToolTip.Show(String,TClrCustomControl).)

Show(String,TClrCustomControl,Integer)

Overloaded. Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration. (Overrides TClrCustomToolTip.Show(String,TClrCustomControl,Integer).)

Show(String,TClrCustomControl,Integer,Integer)

Overloaded. Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position. (Overrides TClrCustomToolTip.Show(String,TClrCustomControl,Integer,Integer).)

Show(String,TClrCustomControl,Integer,Integer,Integer)

Overloaded. Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position. (Overrides TClrCustomToolTip.Show(String,TClrCustomControl,Integer,Integer,Integer).)

Show(String,TClrCustomControl,_Point)

Overloaded. Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position. (Overrides TClrCustomToolTip.Show(String,TClrCustomControl,_Point).)

Show(String,TClrCustomControl,_Point,Integer)

Overloaded. Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position. (Overrides TClrCustomToolTip.Show(String,TClrCustomControl,_Point,Integer).)

UnRegisterEventCallBack(ClrWString,Pointer)

Remove an event from the instance using the specified event name and function pointer which is the event handler. (Inherited from TClrBaseComponent.)

UnRegisterEventSource

Unregister the Delphi object which raised the .Net event handler. (Inherited from TClrBaseComponent.)

Top
Show:
 NameDescription
OnDraw

Occurs when the ToolTip is drawn and the OwnerDraw property is set to true and the IsBalloon property is false.

OnPopup

Occurs before a ToolTip is initially displayed. This is the default event for the TCnToolTip class.

Top

See C:\Users\Public\Documents\CrystalNet Technologies\.Net VCL for Delphi Demo Folder after installation for examples of how to use this component.