ObjectDCL Banner

Html_GetLocationName Method

Description

This method retrieves the name of the HtmlControl's currently selected location.

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 name.
  • Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Html_GetLocationName 
		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_Html_GetLocationName
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

HtmlControl.

Example

CopyCode imageCopy Code
; Determine the browsing location's name
(Setq rValue (Odcl_Html_GetLocationName MyProject_MyForm_MyControl))

See Also

Html_GetLocationURL.