---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
` event is called and this is where you will put your code to handle the drop.
Canvas.Open:
``` xojo
Me.AcceptPictureDrop
```
Canvas.DropObject:
``` xojo
If obj.PictureAvailable Then
Me.Backdrop = obj.Picture
End If
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.AcceptRawDataDrop
**AcceptRawDataDrop**(Type As `String`)
Permits data (of the Type specified) to be dropped on the control.
The following specfies a generic file type defined in the File Type Sets editor.
``` xojo
Me.AcceptRawDataDrop("????")
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.AcceptTextDrop
**AcceptTextDrop**
Permits text to be dropped on the control.
This line in the Open event of a control that can accept dragged text.
``` xojo
Me.AcceptTextDrop
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Cancel
**Cancel**
Cancels any current operations.
``` xojo
Me.Cancel
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Close
**Close**
Closes a control.
Closing a control permanently removes the control from memory, making it impossible to access. You can close both non-indexed controls and indexed controls. When you close an indexed control, the indexes for the remaining controls will shift downward so that the indexes start with zero and are consecutive.
The following code closes the control. When this is executed from a visible control, the control disappears from the window.
``` xojo
Me.Close
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.DrawInto
**DrawInto**(g As `Graphics`, x As `Integer`, y As `Integer`)
Draws the contents of the RectControl into the specified `Graphics` context. The parameters *x* and *y* are the coordinates of the top, left corner.
This method does not work with HTMLViewer and `OpenGLSurface`.
This example draws the current control into the Graphics of a Picture and then displays it as the Backdrop of a Canvas:
``` xojo
Var p As New Picture(Me.Width, Me.Height)
Me.DrawInto(p.Graphics, 0, 0)
Canvas1.Backdrop = p
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.ExecuteJavaScript
**ExecuteJavaScript**(js As `String`)
Asynchronously executes the passed JavaScript in the context of the currently loaded page.
Attempting to execute JavaScript before the page finishes loading (or if no page is loaded) is undefined and is unlikely to work.
In order to call JavaScript on Windows using the Native renderer, a document must already be loaded into the HTMLViewer. If no document is loaded, an `HTMLViewerException` is raised.
This code will populate the search field on the wikipedia page (assuming it was previously loaded):
``` xojo
Var jsSrc As String
jsSrc = "document.forms[0].elements['search'].value=""xojo"";"
HTMLViewer1.ExecuteJavaScript(jsSrc)
```
This code writes text to the HTML document:
``` xojo
Var this As String
this = "document.writeln(""hello"");"
HTMLViewer1.ExecuteJavaScript(this)
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.ExecuteJavaScriptSync
**ExecuteJavaScriptSync**(js As `String`) As `Variant`
Synchronously executes the passed JavaScript in the context of the currently loaded page and returns the result. Only strings and numbers may be returned.
Attempting to execute JavaScript before the page finishes loading (or if no page is loaded) is undefined and is unlikely to work.
In order to call JavaScript on Windows using the Native renderer, a document must already be loaded into the HTMLViewer. If no document is loaded, an `HTMLViewerException` is raised.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.GoBack
**GoBack**
Navigates to the prior page.
On a back button Action event handler, you can write:
``` xojo
HTMLViewer1.GoBack
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.GoForward
**GoForward**
Navigates to the next page.
On a forward button Action event handler, you can write:
``` xojo
HTMLViewer1.GoForward
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Invalidate
**Invalidate**(\[EraseBackground As `Boolean`\])
Similar to RefreshRect, but causes the specified region of the RectControl to be marked dirty and to be redrawn when the window contents need to be redrawn. The region to be redrawn is specified by the *X*, *Y*, *Width*, and *Height* parameters. This form of Invalidate was formerly called InvalidateRect.
The following code refreshes the control. EraseBackground defaults to `True`.
``` xojo
Me.Invalidate(False)
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.LoadPage
**LoadPage**(Source As `String`, RelativeTo As `FolderItem`)
Loads the the supplied *File* into the HTMLViewer. *File* must be an actual file and not a folder.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.LoadPage
**LoadPage**(File As `FolderItem`)
Loads the the supplied *File* into the HTMLViewer. *File* must be an actual file and not a folder.
Any links will be resolved relative to the passed *RelativeTo* `FolderItem`.
On Windows, temporary files are created beside the passed *RelativeTo* FolderItem. If the temporary files cannot be created, then an exception error may be thrown. This can happen, for example, if you are trying to write to a read-only volume or you don't have write permissions.
In this example, the raw HTML is in a `TextArea`:
``` xojo
Var f As FolderItem = FolderItem.TemporaryFile
HTMLViewer1.LoadPage(TextArea1.Text, f)
```
This example loads an HTML file from disk. The file type has been added using the File Types Set Editor:
``` xojo
Var f As FolderItem
f = FolderItem.ShowOpenFileDialog("text/html")
If f <> Nil Then
HTMLViewer1.LoadPage(f)
End If
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.LoadURL
**LoadURL**(URL As `String`)
Loads the passed HTTP URL. Any protocol other than HTTP may or may not work as that is dependent on operating system behavior.
On macOS, you need to ensure the URL is prefixed with "" or "" in order for it to load.
This example loads a URL entered by the user in a `TextField`:
``` xojo
Var url As String = URLField.Value
If Left(url, 7) <> "http://" Then url = "http://" + url
HtmlViewer1.LoadURL(url)
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Print
**Print**(showPrintDialog As `Boolean` = `True`)
Prints the contents of the HTMLViewer. On Linux, this requires Webkit 1.1.5 or newer.
This example prints the current page.
``` xojo
HTMLViewer1.Print
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Refresh
**Refresh**(eraseBackground As `Boolean`)
Repaints the portion specified of the contents of the control immediately.
Calling this frequently can cause the code executing to slow down. It is often preferable to call `RectControl` instead.
Refresh the entire area:
``` xojo
Me.Refresh(False)
```
Refresh a portion of the area:
``` xojo
Me.Refresh(100, 150, 200, 300)
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.SetFocus
**SetFocus**
If applicable, sets the focus to the RectControl. KeyDown events are directed to the control.
If the control cannot get the focus on the platform on which the application is running, SetFocus does nothing. The SetFocus method of the `Window` class or the `ClearFocus` method can be used to remove the focus from the control that currently has the focus, leaving no control with the focus.
On the Mac you need Full Keyboard Access turned on in System Preferences (Keyboard-\>Shortcuts) in order to manually set focus to non-text controls.
The following example sets the focus to TextField1. If another control has the focus when this line is executed, then the user sees that TextField1 gets the focus.
``` xojo
TextField1.SetFocus
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.ZoomTextIn
**ZoomTextIn**
Augments the size of the text used to display the HTML page content. You can use ZoomTextIn several times.
The reverse action is achieved with the `ZoomTextOut` method.
This example is the Pressed event of a `SegmentedButton`:
``` xojo
If segmentIndex = 0 Then
HtmlViewer1.ZoomTextIn
ElseIf segmentIndex = 1 Then
HtmlViewer1.ZoomTextOut
End If
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.ZoomTextOut
**ZoomTextOut**
Reduces the size of the text used to display the HTML page content. You can use ZoomTextOut several times.
The reverse action is achieved with the `ZoomTextIn` method.
This example is the Action event of a `SegmentedButton`:
``` xojo
If itemIndex = 0 Then
HtmlViewer1.ZoomTextIn
ElseIf itemIndex = 1 Then
HtmlViewer1.ZoomTextOut
End If
```
## Event descriptions
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.CancelLoad
**CancelLoad**(URL As `String`) As `Boolean`
Returns a `Boolean`. Return `True` to cancel loading the page.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Close
**Close**
The control is about to close.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.DocumentBegin
**DocumentBegin**(URL As `String`)
Fires when the HTML page is starting to load.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.DocumentComplete
**DocumentComplete**(URL As `String`)
Called when the HTML page is finished loading.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.DocumentProgressChanged
**DocumentProgressChanged**(URL As `String`, PercentageComplete As `Integer`)
Fires when the progress has been updated. If *percentageComplete* is -1, the percentage cannot be determined.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Error
**Error**(ErrorNumber As `Integer`, ErrorMessage As `String`)
Fires when an error occurs.
The errors you receive are the standard HTTP status codes: \* [HTTP Status Codes](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes)
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.JavaScriptRequest
**JavaScriptRequest**(method As `String`, parameters() As `Variant`) As String
Called when a JavaScript executed via `ExecuteJavaScript` or `ExecuteJavaScriptSync` calls ExecuteInXojo or ExecuteInXojoSync.
A JavaScript executed via `ExecuteJavaScript` or `ExecuteJavaScriptSync` can call **executeInXojo()** or **executeInXojoSync()** to pass data back to the HTMLViewer via this event. Both can be passed any number of parameters though the first parameter must be a string. For all subsequent parameters, only strings and numbers are supported. The executeInXojo() method is asynchronous and thus will not receive a value returned by this event. The executeInXojoSync() method is synchronous and thus should be called as a function as it will receive the value returned by this event.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.KeyDown
**KeyDown**(Key As `String`) As `Boolean`
The user has pressed the *Key* passed while the `control` has the focus.
How KeyDown works depends on the type of control.
**TextField and TextArea** Returning `True` means the key is intercepted, preventing the key from actually reaching the control at all. This would be useful if you want to override the behavior of the tab key for example. Returning `False` means the key reaches the control.
**All Other Controls** Returning `True` prevents the KeyDown event on the parent control (usually the window) from executing. Returning `False` results in the execution of the KeyDown event of the parent control.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.KeyUp
**KeyUp**(Key As `String`)
Fires when the passed *Key* is released in the RectControl that has the focus.
It is not guaranteed to be the same key that received the KeyDown event.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.NewWindow
**NewWindow**(url As String\) As HTMLViewer
Called when a new browser window is requested.
Returns a new instance of an HTMLViewer to load the page in that viewer or `Return` `Nil` when you do not want to allow the window to open.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.Open
**Open**
The control is about to be displayed. Use this event to initialize a control.
The Open event is called after the Constructor.
Be warned that initializing control property values using the Constructor instead of the Open event may result in those property values being overwritten by what is set in the Inspector. For best results, use the Open event for control initialization rather than the control Constructor.
If the control is supposed to handle drag and drop, you need to tell it which type of item it needs to be able to handle. The following example informs the control that pictures and files can be dropped on it. The type of the file it needs to support is specified via the File Types Editor.
``` xojo
Sub Open()
Me.AcceptPictureDrop
Me.AcceptFileDrop("JPEG")
End Sub
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.SecurityChanged
**SecurityChanged**(IsSecure As `Boolean`)
Fires when the document's security has changed. For example, entering a secure web site will cause this event to fire.
This event is only called on Microsoft Windows when using the Native renderer.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.StatusChanged
**StatusChanged**(NewStatus As `String`)
Fires when the Status text has changed for the window.
Due to changes made to the CEF3 library (Chromium Embedded Framework) this event is not called on Windows when Renderer = WebKit.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
HTMLViewer.TitleChanged
**TitleChanged**(NewTitle As `String`)
Fires when the Title of the Web page has been determined or has changed.
The renderer, which varies by OS, determines the maximum number of characters that are returned in *NewTitle*. You should test this in your projects to determine a maximum number of characters, keeping in mind that this could change at any time due to the underlying renderer and operating system.
## Notes
On macOS, the HTMLViewer supports getting and setting a custom user agent string and increasing or decreasing the font size.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
### Exchanging data with javascript
A JavaScript executed via `ExecuteJavaScript` or `ExecuteJavaScriptSync` can call executeInXojo() or executeInXojoSync() to pass data back to the HTMLViewer via the `JavaScriptRequest` event. Both can be passed any number of parameters though the first parameter must be a string. For all subsequent parameters, only strings and numbers are supported. The executeInXojo() method is asynchronous and thus will not receive a value returned by the `JavaScriptRequest` event. The executeInXojoSync() method is synchronous and thus should be called as a function as it will receive the value returned by the `JavaScriptRequest` event.
On Windows you need to use the WebKit rendering engine for executeInXojo() or executeInXojoSync() to work.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
### App transport security
Starting with MacOS 10.11 and Xojo 2018r4, your apps have to use secure "https" connections or you will get this error: "The resource could not be loaded because the App Transport Security policy requires the use of a secure connection". You can work around this by providing a plist with your app to indicate what non-secure URLs you are using. For more information: \* `Using Non-Secure URLs on macOS and iOS`
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
### Webkit on windows
You can use WebKit on Windows by setting the `Renderer` property to WebKit (1). Using WebKit on Windows adds the entire Chromium Embedded Framework 3 (CEF3) engine to your app, increasing its size by about 100MB.
To make plugins available to WebKit on Windows, create a folder called WebKitPlugins within your Libs folder in your application folder and place the plugins you need there.
When using WebKit on Windows, HTMLViewer.Handle returns a pointer to the cef_browser_t struct.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
### Windows ie version
On Windows, the Native Renderer is probably using an older version of the Internet Explorer renderer. This may result in web pages that do not display or work as you expect. You can tell Windows to use a newer version of the IE rendering engine with a Registry setting. This is how you can change it using Xojo:
``` xojo
#If TargetWindows
' This code handles both 64 and 32-bit builds
Var reg As New RegistryItem("HKEY_CURRENT_USER\SOFTWARE\Microsoft")
reg = reg.AddFolder("Internet Explorer")
reg = reg.AddFolder("Main")
reg = reg.AddFolder("FeatureControl")
reg = reg.AddFolder("FEATURE_BROWSER_EMULATION")
' Source MS documentation: https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/general-info/ee330730(v=vs.85)
reg.Value(App.ExecutableFile.Name) = CType(11000 , Int32)
#EndIf
```
Another issue to keep in mind is if Internet Explorer 11 has the option "Display intranet sites in Compatibility View" selected in the "Compatibility View Settings" pane, then IE will most likely still render using IE7. If you control the source to the content you want to display, you can include this in the \ section of the HTML document: \\\
And also use HTML5 DOCTYPE at the start of the document: \\\
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
### Windows performance
On Windows, the Native Renderer [might not use the GPU by default](https://msdn.microsoft.com/en-us/library/ee330731(v=vs.85).aspx), which may result in slower rendering speeds depending on what you are displaying. You can enable it via the Registry:
``` xojo
Var reg As New RegistryItem("HKEY_CURRENT_USER\SOFTWARE\Microsoft")
reg = reg.AddFolder("Internet Explorer")
reg = reg.AddFolder("Main")
reg = reg.AddFolder("FeatureControl")
reg = reg.AddFolder("FEATURE_GPU_RENDERING")
reg.Value(App.ExecutableFile.Name) = 1
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
### Linux support
If it is available, the Linux HTMLViewer uses WebKit (libwebkitgtk version 3).
Refer to the `System Requirements for current release` section for commands that you can use to install libwebkitgtk v3 on various Linux distributions.
On Linux, HTMLViewer.Handle returns the GtkScrolledWindow that hosts the WebKitWebView control (please refer to the [WebKitGTK site](http://webkitgtk.org) for information on how to use this system control).
## Sample code
To implement a simple web browser, create a window with a large HTML Viewer control. Set its LockLeft, LockTop, LockRight, and LockBottom properties so that it resizes as the user resizes the window. Use a `TextField` as the URL entry area and a `PushButton` as the browser's Go button. That is, the user clicks Go to display the URL entered into the `TextField`.
In this example, the HTMLViewer is named “HTML”. The following code is in the Action event of the `PushButton`:
``` xojo
HTML.LoadURL(TextField.Value)
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
You can use a `ProgressBar` to indicate that the web page is loading. In the HTMLViewer's DocumentBegin event, initialize and show the `ProgressBar` with the code:
``` xojo
ProgressBar1.Value = 0
ProgressBar1.Visible = True
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
In the DocumentProgressChanged event, increment the value of the `ProgressBar`. This event handler is passed the value of PercentageComplete (0 to 100).
``` xojo
If percentageComplete = -1 Then ' if it cannot be determined
ProgressBar1.Maximum = 0 ' display indeterminate progress
Else
ProgressBar1.Maximum = 100
End if
ProgressBar1.Value = percentageComplete
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
In the DocumentComplete event handler, hide the ProgressBar with the line:
``` xojo
ProgressBar1.Visible = False
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
When the title of the web page has been received, you can display it in the window's Title bar using the HTMLViewer's TitleChanged event. It is passed the new title in the `String` parameter newTitle. Update the window title with the line:
``` xojo
Title = newTitle
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Use a second `TextField` to display the status of the load process. In the HTMLViewer's StatusChanged event handler, set the value of this `TextField`. This event handler is passed the current status in the `String` parameter, NewStatus. Display this string with the following line in the StatusChanged event:
``` xojo
TextField1.Text3 = NewStatus
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
If a new browser window is supposed to open, you need to insert some code to handle this event. For example, the user clicks a link that is supposed to display the new page in another window. Use the NewWindow event handler to create the window. The following code assumes that the browser is contained in a window called MainWindow.
``` xojo
Var w As New MainWindow
Title = "New Window" //Title property of new window
w.Show
Return w.HTML
```
## Compatibility
All project types on all supported operating systems.
## See also
`RectControl` parent class; `URLConnection` and `URLConnection` classes