ObjectDCL Banner

Form_GetControlArea Method

Description

This method returns a list indicating the width and height of the dialog box's client area.  This would be the area of the dialog box excluding the title bar and border of the dialog box.

Parameters

MyDialogReference
Reference to the dialog.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.

Return Values

Returns the following according to the situation:

  • A list that specifies the width and height dimensions, all integers.
  • Nil if the control is not found.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Form_GetControlArea 
		MyDialogReference [as Reference])

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

CopyCode imageCopy Code
(Odcl_Form_GetControlArea
		ProjectFile [as String]
		DialogName [as String])

Applies For

Dockable, FileDialog, Modal, Modeless.

Example

CopyCode imageCopy Code
; Get the area dimension for controls (client area in Microsoft Win32 API)
(Setq rValue (Odcl_Form_GetControlArea MyProject_MyForm))

See Also

Form_GetHwnd, Form_GetRectangle