ObjectDCL Banner

Form_SetTitleBarText Method

Description

This method will change the title bar text of the indicated dialog box.

Parameters

MyFormReference
Reference to the form.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
NewText
String identifying the text to apply.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the form is not found or the form does not support the operation.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Form_SetTitleBarText 
		MyFormReference [as Reference]
		NewText [as String])

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_SetTitleBarText
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		NewText [as String])

Remarks

Does not work for the ConfigTab.

Applies For

Dockable, FileDialog, Modal, Modeless.

Example

CopyCode imageCopy Code
; Enable the dialog
(Odcl_Form_SetTitleBarText MyProject_MyForm "New title")

See Also

Form_GetTitleBarText