Classes Class XbpHTMLViewer2() :beforeNavigate()

Method XbpHTMLViewer2():beforeNavigate() Foundation

A navigation is about to begin.

Syntax 
:beforeNavigate( <cURL> ) --> lCancel
Parameters
<cURL>
A character string identifying the document to which the object is about to navigate to. See :navigate() for further information.
Return

A logical value that specifies whether the navigation is cancelled. If .T. (true) is returned, navigation is cancelled and the new document is not loaded.

Description

The xbeHTML_BeforeNavigate notification is generated when the XbpHTMLViewer2 object is about to navigate to a new HTML page or document. The method :beforeNavigate() returns a logical value that specifies whether navigation is allowed to begin. To prevent navigation from occurring, the application must return the value .T. (true).

Note: The xbeHTML_BeforeNavigate notification is a synchronous event. It is sent directly to the application via the XbpHTMLViewer2 object's :handleEvent() method. The xbeHTML_BeforeNavigate event code normally is not returned by the function AppEvent().

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.