ObjectDCL Banner

Form_IsFloating Method

Description

This method will return whether the dockable form is anchored to AutoCAD® main window or not.

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:

  • T is floating/undocked.
  • Nil if the dialog is not found, does not support this function or is docked.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Form_IsFloating 
		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_IsFloating
		ProjectFile [as String]
		DialogName [as String])

Applies For

Dockable.

Example

CopyCode imageCopy Code
; Get the window handle (HWND)
(Setq rValue (Odcl_Form_IsFloating MyProject_MyForm))