ObjectDCL Banner

FileDlg_GetFileTitle Method

Description

This method retrieves the currently selected file(s)' title.

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.

Return Values

Returns the following according to the situation:

  • String indicating the file's title.
  • 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_FileDlg_GetFileTitle 
		MyControlReference [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_FileDlg_GetFileTitle
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
	)

Applies For

CustomFileDlg.

Example

CopyCode imageCopy Code
; Get the selected file title
(setq rValue (Odcl_FileDlg_GetFileTitle MyProject_MyForm_MyControl))