From Xojo Documentation
|You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!|
Supported PlatformsProject Types: Desktop Platforms: macOS, Windows, Linux
Renders HTML and provides basic navigation features.
On macOS, the HTMLViewer supports getting and setting a custom user agent string and increasing or decreasing the font size.
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:
Webkit on Windows
To make plugins available to the DesktopHTMLViewer on Windows, create a folder called WebKitPlugins within your Libs folder in your application folder and place the plugins you need there.
The Handle property returns a pointer to the cef_browser_t struct.
If it is available, the Linux HTMLViewer uses WebKit (libwebkitgtk version 3).
Refer to the Resources:System_Requirements#64-bit Configuration for Running 32-bit_Apps 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 for information on how to use this system control).
Accessing the Raw HTML From the Displayed Page
Implementing a Simple Web Browser
Create a window with a large DesktopHTMLViewer control. Set its LockLeft, LockTop, LockRight, and LockBottom properties so that it resizes as the user resizes the window. Use a DesktopTextField as the URL entry area and a DesktopButton as the browser's Go button. That is, the user clicks Go to display the URL entered into the DesktopTextField.
In this example, the HTMLViewer is named “HTML”. The following code is in the Pressed event of the DesktopButton:
ProgressBar1.Visible = True
In the DocumentProgressChanged event, increment the value of the DesktopProgressBar. This event handler is passed the value of PercentageComplete (0 to 100).
ProgressBar1.Maximum = 0 // display indeterminate progress
ProgressBar1.Maximum = 100
ProgressBar1.Value = percentageComplete
In the DocumentComplete event handler, hide the ProgressBar with the line:
When the title of the web page has been received, you can display it in the window's Title bar using the DesktopHTMLViewer's TitleChanged event. It is passed the new title in the String parameter newTitle. Update the window title with the line:
Use a second DesktopTextField to display the status of the load process. In the HTMLViewer's StatusChanged event handler, set the value of this DesktopTextField. This event handler is passed the current status in the String parameter, NewStatus. Display this string with the following line in the StatusChanged event:
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.