ObjectDCL Banner

Html_UpdateHtmlCode Method

Description

This method will update the entire Html document currently loaded.

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.
NewHtmlCode
String identifying the code snippet to use as a replacement.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Html_UpdateHtmlCode 
		MyControlReference [as Reference]
		NewHtmlCode [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_Html_UpdateHtmlCode
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		NewHtmlCode [as String])

Remarks

Please note that an Html document must have already been loaded to use this method successfully.

Applies For

HtmlControl.

Example

CopyCode imageCopy Code
; Put a whole new document
(Odcl_Html_UpdateHtmlCode MyProject_MyForm_MyControl "<html><head></head><body>Hello the world!</body></html>")

See Also

Html_ReplaceText