ObjectDCL Banner

OptionList_SetTttTitleLine Method

Description

This method turns on or off a line separating the title and the main text 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.
Line
Boolean identifying whether to display a line for the option's tooltip. Pass T to show and Nil to hide.

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_SetTttTitleLine 
		MyControlReference [as Reference]
		nIndex [as Integer]
		Line [as Boolean])

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_SetTttTitleLine
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
		Line [as Boolean])

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Show the line
(Odcl_OptionList_SetTttTitleLine MyProject_MyForm_MyControl 0 T)

See Also

OptionList_SetTttAvi, OptionList_SetTttMain, OptionList_SetTttPicture, OptionList_SetTttTitle, OptionList_SetTttTitleColor