ObjectDCL Banner

DwgPreview_SetHighLight Method

Description

This method draws a rectangle around the inside of the border as indication that the control has been selected or indicated for some purpose.

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.
Color
Color identifying the color of the highlight rectangle.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found or does not support this function.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_DwgPreview_SetHighLight 
		MyControlReference [as Reference]
		Color [as Color])

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

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

Applies For

DwgPreview.

Example

CopyCode imageCopy Code
; Set the highlight color
(Odcl_DwgPreview_SetHighLight MyProject_MyForm_MyControl 3888823)

See Also

DwgPreview_RemoveHighLight