ObjectDCL Banner

Control_ShowToolTip Method

Description

This method will force the display of the tool tip of the control, using the current settings.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.
X
Integer specifying the X-axis coordinate where to display the tooltip, relative to the control.
Y
Integer specifying the Y-axis coordinate where to display the tooltip, relative to the control.
Coordinate
Point specifying the coordinate where to display the tooltip, relative to the control.

AutoLISP Syntax

The recommended convention is passing the control identifier directly, with an optional 2d point:

CopyCode imageCopy Code
(Odcl_Control_ShowToolTip 
		MyControlReference [as Reference]
		[Optional] Coordinate [as Point2D])

The X and Y coordinates are optional:

CopyCode imageCopy Code
(Odcl_Control_ShowToolTip 
		MyControlReference [as Reference]
		[Optional] X [as Integer] 
		[Optional] Y [as Integer])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_Control_ShowToolTip
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

The X and Y coordinates are optional:

CopyCode imageCopy Code
(Odcl_Control_ShowToolTip
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		X [as Integer]
		Y [as Integer])

It is also possible to pass a 2d point:

CopyCode imageCopy Code
(Odcl_Control_ShowToolTip
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Coordinate [as Point2D])

Applies For

ActiveX, AngleSlider, Animation, BlockList, BlockView, CheckBox, ComboBox, DwgList, DwgPreview, EditableGrid, Frame, GraphicButton, Grid (Hatch), HtmlControl, ImageCombo, Label, ListBox, ListView, MonthPicker, Option, OptionList, PictureBox, ProgressBar, Rectangle, ScrollBar, SliderBar, SlideView, SpinButton, Splitter, TabControl, TextBox, TextButton, TreeControl, UrlLink.

Example

CopyCode imageCopy Code
; Show the tooltip
(Odcl_Control_ShowToolTip MyProject_MyForm_MyControl)