ObjectDCL Banner

DwgPreview_GetDwgName Method

Description

This method will return the name of the drawing file that is currently being displayed.

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 specifying the file name of the drawing.
  • 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_DwgPreview_GetDwgName 
		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_DwgPreview_GetDwgName
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

DwgPreview.

Example

CopyCode imageCopy Code
; Get the drawing name
(setq rValue (Odcl_DwgPreview_GetDwgName MyProject_MyForm_MyControl))

See Also

DwgPreview_Clear, DwgPreview_LoadDwg