ObjectDCL Banner

OptionList_SetTttMain Method

Description

This method sets the main body of the tool tip window for an option button in the list.

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.
nIndex
Integer identifying the index of the option.
sMainText
String identifying the main text body to display for the option's tooltip.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found, is not visible or there is no such option.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_OptionList_SetTttMain 
		MyControlReference [as Reference]
		nIndex [as Integer]
		sMainText [as String])

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

CopyCode imageCopy Code
(Odcl_OptionList_SetTttMain
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
		sMainText [as String])

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Set the main body of the tooltip
(Odcl_OptionList_SetTttMain MyProject_MyForm_MyControl 0 "Travel to Spain")

See Also

OptionList_SetTttAvi, OptionList_SetTttPicture, OptionList_SetTttTitle, OptionList_SetTttTitleColor, OptionList_SetTttTitleLine