ObjectDCL Banner

OptionList_SetTttTitle Method

Description

This method sets the title 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.
sTitleText
String identifying the title 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_SetTttTitle 
		MyControlReference [as Reference]
		nIndex [as Integer]
		sTitleText [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_SetTttTitle
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
		sTitleText [as String])

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Set the title
(Odcl_OptionList_SetTttTitle MyProject_MyForm_MyControl 0 "Spain")

See Also

OptionList_SetTttAvi, OptionList_SetTttMain, OptionList_SetTttPicture, OptionList_SetTttTitleColor, OptionList_SetTttTitleLine