ObjectDCL Banner

Form_GetTitleBarText Method

Description

This method will retrieve the title bar text or configuration tab text.

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 string that specifies the text.
  • Nil if the dialog is not found.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

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

Applies For

ConfigTab, Dockable, FileDialog, Modal, Modeless.

Example

CopyCode imageCopy Code
; Get the dialog title bar text
(Setq rValue (Odcl_Form_GetTitleBarText MyProject_MyForm))

See Also

Form_GetHwnd, Form_GetRectangle, Form_SetTitleBarText