Platforms to show: All Mac Windows Linux Cross-Platform
Back to DesktopWKWebViewControlMBS control.
DesktopWKWebViewControlMBS.BoundsChanged
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DesktopWKWebViewControlMBS.Closing
| Type | Topic | Version |
| event | WebKit2 | 21.5 |
The control is about to close.
In older Xojo versions, this event is named Close.
DesktopWKWebViewControlMBS.ConstructContextualMenu(base as DesktopMenuItem, x as Integer, y as Integer) As Boolean
| Type | Topic | Version |
| event | WebKit2 | 22.1 |
DesktopWKWebViewControlMBS.ContextualMenuItemSelected(selectedItem As DesktopMenuItem) As Boolean
| Type | Topic | Version |
| event | WebKit2 | 21.5 |
This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.
DesktopWKWebViewControlMBS.CreateWebView(URL as String, request as NSURLRequestMBS) as Variant
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If needed we can add configuration, windowFeatures and navigationAction parameters in future version.
Return a web viewer control or nil.
The web view returned must be created with the specified configuration. WebKit will load the request in the returned web view.
If you do not implement this method or return nil, the web view will cancel the navigation.
DesktopWKWebViewControlMBS.EstimatedProgressChanged(estimatedProgress as double, oldEstimatedProgress as double)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This event may be called often, so don't do much here!
DesktopWKWebViewControlMBS.FocusLost
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The control lost focus.
In older Xojo versions, this event is named LostFocus.
This only fires if the control itself lost focus and not a sub control.
DesktopWKWebViewControlMBS.FocusReceived
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The control itself got focus.
In older Xojo versions, this event is named GotFocus.
This only fires if the control itself got focus and not a sub control.
DesktopWKWebViewControlMBS.FrameChanged
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This event notifies you, that the control changed it's bounding frame, which is position and/or size.
DesktopWKWebViewControlMBS.JavaScriptEvaluated(JavaScript as String, Result as Variant, Error as NSErrorMBS, Tag as String)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Error is only set with 64-bit, not with 32-bit.
Tag is passed from EvaluateJavaScript call.
Result is converted from JavaScript data types to Xojo datatypes, usually variants, dictionaries or array of variants.
DesktopWKWebViewControlMBS.MenuBarSelected
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.
DesktopWKWebViewControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control.
Return True if you are going to handle the MouseDown. In such a case:
- The Action event, if any, will not execute and the state of the object will not change.
- You will receive the MouseDrag and MouseUp events.
DesktopWKWebViewControlMBS.MouseDrag(x as Integer, y as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Mouse location is local to the control passed in to x, y.
As this event is fired continuously (hundreds of time per second), it is your responsibility to determine if the mouse has really moved.
DesktopWKWebViewControlMBS.MouseUp(x as Integer, y as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Use the x and y parameters to determine if the mouse button was released within the control's boundaries.
DesktopWKWebViewControlMBS.navigationActionDidBecomeDownload(navigationAction as WKNavigationActionMBS, download as WKDownloadMBS)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 22.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
navigationAction: Descriptive information about the navigation response that turned into a download.
download: An object that represents the download of a web resource.
Implement this method to begin tracking download progress.
DesktopWKWebViewControlMBS.navigationResponseDidBecomeDownload(navigationResponse as WKNavigationResponseMBS, download as WKDownloadMBS)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 22.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
navigationResponse: Descriptive information about the navigation response that turned into a download.
download: An object that represents the download of a web resource.
Implement this method to begin tracking download progress.
DesktopWKWebViewControlMBS.Opening
| Type | Topic | Version |
| event | WebKit2 | 21.5 |
The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.
DesktopWKWebViewControlMBS.pauseAllMediaPlaybackCompleted
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 24.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DesktopWKWebViewControlMBS.requestMediaPlaybackStateCompleted(state as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 24.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
State: A value that indicates whether the media in the web view is playing, paused, or suspended. If there’s no media in the web view to play, this method provides MediaPlaybackStateNone.
DesktopWKWebViewControlMBS.runJavaScriptAlertPanel(initiatedByFrame as WKFrameInfoMBS, message as String)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
message: The message to display.
If you do not implement this method, the web view will behave as if the user selected the OK button.
DesktopWKWebViewControlMBS.runJavaScriptConfirmPanel(initiatedByFrame as WKFrameInfoMBS, message as String) as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
message: The message to display.
Return true if the user chose OK, false if the user chose Cancel.
If you do not implement this method, the web view will behave as if the user selected the Cancel button.
DesktopWKWebViewControlMBS.runJavaScriptTextInputPanel(initiatedByFrame as WKFrameInfoMBS, prompt as String, defaultText as String) as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
message: The message to display.
defaultText: The initial text to display in the text entry field.
Return the entered text if the user chose OK, otherwise "".
If you do not implement this method, the web view will behave as if the user selected the Cancel button.
DesktopWKWebViewControlMBS.runOpenPanelWithParameters(initiatedByFrame as WKFrameInfoMBS, allowsMultipleSelection as Boolean, allowsDirectories as Boolean)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 22.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Please call runOpenPanelWithParametersCompleted method later with result. Pass the selected URLs if the user chose "OK", otherwise nil.
You can use sheet window for the file picker and later call the runOpenPanelWithParametersCompleted method or call it right in the event if you do it synchronously.
If this method is not implemented, the web view behaves as if the user selected the Cancel button.
Not available on iOS. Implemented for macOS 64-bit applications.
DesktopWKWebViewControlMBS.ScaleFactorChanged(NewFactor as Double)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Please invalidate any cached bitmaps or other relevant state.
DesktopWKWebViewControlMBS.takeSnapshotCompleted(image as NSImageMBS, error as NSErrorMBS, tag as string)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If snapshot creation failed, error is set.
DesktopWKWebViewControlMBS.TitleChanged(Title as String, oldTitle as string)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
DesktopWKWebViewControlMBS.WebContentProcessDidTerminate
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 22.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Web views use a separate process to render and manage web content. WebKit calls this method when the process for the specified web view terminates for any reason.
DesktopWKWebViewControlMBS.willShowContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| event | WebKit2 | MBS Mac64bit Plugin | 21.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Your chance to modify the menu before it is shown, e.g. to add menu entries.
The items on this page are in the following plugins: MBS Mac64bit Plugin.