6.1-roHtmlWidgetEvent

ON THIS PAGE


If an roMessagePort is attached to an roHtmlWidget, it will receive roHtmlWidgetEvent objects when something happens to the parent roHtmlWidget instance. 

ifUserData

SetUserData(user_data As Object)

Sets the user data that will be returned when events are raised.

GetUserData() As Object

Returns the user data that has previously been set via SetUserData(). It will return Invalid if no data has been set.

ifHTMLWidgetEvent

GetData() As Object

Returns an associative array of key/value pairs. The reason key identifies the cause of the event:

  • load-started: The HTML widget has started loading a page.
  • load-finished: The HTML widget completed loading a page.
  • load-error: The HTML widget has failed to load a page. Use the uri key to identify the failing resource and the message key to retrieve some explanatory text.