ObjectDCL Banner

OptionList_SetEnabled Method

Description

This method will enable or disable an option.

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 to enable or disable.
Enabled
Boolean identifying the desired state of the option. T to enable. Nil to disable.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_OptionList_SetEnabled 
		MyControlReference [as Reference]
		nIndex [as Integer]
		Enabled [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_SetEnabled
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
		Enabled [as Boolean])

Applies For

OptionList.

Example

CopyCode imageCopy Code
; Disable the second option
(Odcl_OptionList_SetEnabled MyProject_MyForm_MyControl 1 Nil)