Platforms to show: All Mac Windows Linux Cross-Platform

Back to WKWebViewControlMBS control.

Next items

WKWebViewControlMBS.BoundsChanged

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The event called when the bounds, but not the frame, changed.

WKWebViewControlMBS.Close

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 16.4 ✅ Yes ❌ No ❌ No ❌ No

The control is about to close.
In Xojo version 2021r3 and newer this event is named Closing.

WKWebViewControlMBS.Closing

Type Topic Version
event WebKit2 16.4

The control is about to close.
In older Xojo versions, this event is named Close.

WKWebViewControlMBS.ConstructContextualMenu(base as MenuItem, x as Integer, y as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.1 ✅ Yes ❌ No ❌ No ❌ No
This event is called when it is appropriate to display a contextual menu for the control.

WKWebViewControlMBS.ContextualMenuAction(hitItem as MenuItem) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
Called when a menuitem is choosen.

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.

WKWebViewControlMBS.CreateWebView(URL as String, request as NSURLRequestMBS) as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 20.0 ✅ Yes ❌ No ❌ No ❌ No
Creates a new web view.

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.

WKWebViewControlMBS.decidePolicyForNavigationAction(navigationAction as WKNavigationActionMBS, decisionHandler as WKPolicyForNavigationActionDecisionHandlerMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Decides whether to allow or cancel a navigation.

Please inspect navigationAction to find the information about what action happened.

You can show a dialog to ask user and once you know the decision call a method on decisionHandler object to report the decision.

If you want to open this in a new window/tab, please call decisionHandler.Cancel method here, take the URL and load it in the new WebView in the new window/tab.

Like the CancelClose event in Xojo, you can call decisionHandler.Cancel method to call it.

WKWebViewControlMBS.decidePolicyForNavigationResponse(navigationResponse as WKNavigationResponseMBS, decisionHandler as WKPolicyForNavigationResponseDecisionHandlerMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Decides whether to allow or cancel a navigation after its response is known.
Example
Sub decidePolicyForNavigationResponse(navigationResponse as WKNavigationResponseMBS, decisionHandler as WKPolicyForNavigationResponseDecisionHandlerMBS) Handles decidePolicyForNavigationResponse
Var MimeType as string = navigationResponse.response.MIMEType

if MimeType = "application/zip" or _
MimeType = "application/x-tar" or _
MimeType = "application/octet-stream" then
// we download archive files
decisionHandler.Download
else
// allow normal website to load
decisionHandler.Allow

end if
End Sub

navigationResponse: Descriptive information about the navigation response.

You can show a dialog to ask user and once you know the decision call a method on decisionHandler object to report the decision.

WKWebViewControlMBS.DidClose

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 20.0 ✅ Yes ❌ No ❌ No ❌ No
The webviewer closed.

Notifies your app that the DOM window object's close() method completed successfully.

Your app should remove the web view from the view hierarchy and update the UI as needed, such as by closing the containing browser tab or window.

WKWebViewControlMBS.didCloseContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 21.0 ✅ Yes ❌ No ❌ No ❌ No
Did close contextual menu.

Allows you to restart any animation you may have stopped in the willShowContextualMenu event.

WKWebViewControlMBS.didCommitNavigation(navigation as WKNavigationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.0 ✅ Yes ❌ No ❌ No ❌ No
Invoked when content starts arriving for the main frame.

Added navigation parameter with version 20.3.
Sets Navigation property.

WKWebViewControlMBS.didFailNavigation(navigation as WKNavigationMBS, Error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.0 ✅ Yes ❌ No ❌ No ❌ No
Invoked when an error occurs during a committed main frame navigation.

Added navigation parameter with version 20.3.
Sets Navigation property.

WKWebViewControlMBS.didFailProvisionalNavigation(navigation as WKNavigationMBS, Error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.0 ✅ Yes ❌ No ❌ No ❌ No
Invoked when an error occurs while starting to load data for the main frame.

Added navigation parameter with version 20.3.
Sets Navigation property.

WKWebViewControlMBS.didFinishNavigation(navigation as WKNavigationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.0 ✅ Yes ❌ No ❌ No ❌ No
Invoked when a main frame navigation completes.

Added navigation parameter with version 20.3.
Sets Navigation property.
Same as DocumentComplete in HTMLViewer.

WKWebViewControlMBS.DidReceiveAuthenticationChallenge(challenge as NSURLAuthenticationChallengeMBS, byref AuthChallengeDisposition as Integer, byref credentials as NSURLCredentialMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Asks the app to respond to an authentication challenge.

challenge: The authentication challenge.

AuthChallengeDisposition: The option to use to handle the challenge. For a list of options, see AuthChallenge* constants.
credential: The credential to use for authentication when the disposition parameter contains the value AuthChallengeUseCredential. Specify nil to continue without a credential.

If you don’t implement this method, the web view responds to the authentication challenge with the AuthChallengeRejectProtectionSpace disposition.

WKWebViewControlMBS.didReceiveScriptMessage(Body as Variant, name as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 18.0 ✅ Yes ❌ No ❌ No ❌ No
Invoked when a script message is received from a webpage.

body: The body of the message. Automatic translated from Javascript types.
name: The name of the message handler to which the message is sent.

WKWebViewControlMBS.didReceiveServerRedirectForProvisionalNavigation(navigation as WKNavigationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.0 ✅ Yes ❌ No ❌ No ❌ No
Invoked when a server redirect is received for the main frame.

Added navigation parameter with version 20.3.
Sets Navigation property.

WKWebViewControlMBS.didStartProvisionalNavigation(navigation as WKNavigationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.0 ✅ Yes ❌ No ❌ No ❌ No
Invoked when a main frame navigation starts.

Added navigation parameter with version 20.3.
Sets Navigation property.

WKWebViewControlMBS.downloadDecideDestinationUsingResponse(download as WKDownloadMBS, response as NSURLResponseMBS, suggestedFilename as String, byref destination as FolderItem)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Asks the app to provide a file destination where the system should write the download data.

download: The download that needs a file destination where the systems should write the download data.
response: A response from the server for an HTTP request, or a synthesized response for a blob download.
suggestedFilename: A string with a filename suggestion to use in creating the file destination.
destination: A file destination where the systems should write the download data.

Set destination to where to store the file. Or set to nil to cancel.

The suggested filename can come from the response or from the web content.
The destination file URL must meet the following requirements:

  • It’s a file that doesn’t exist.
  • It’s in a directory that exists.
  • It’s in a directory that WebKit can write to.

WKWebViewControlMBS.downloadDidFailWithError(download as WKDownloadMBS, error as NSErrorMBS, resumeData as MemoryBlock)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Tells your app that the download failed, with error information and data you can use to restart the download.

download: The download that failed.
error: An error describing what caused the download to fail.
resumeData: A data object you use to restart the download.

To restart a failed download, call resumeDownloadFromResumeData with resumeData.

WKWebViewControlMBS.downloadDidFinish(download as WKDownloadMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
This event tells you that the download finished.

download: The download that finished.

WKWebViewControlMBS.downloadDidReceiveAuthenticationChallenge(download as WKDownloadMBS, challenge as NSURLAuthenticationChallengeMBS, byref AuthChallengeDisposition as Integer, byref credentials as NSURLCredentialMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Asks the delegate to respond to an authentication challenge.

download: The download that received the authentication challenge.
challenge: The authentication challenge.

Determine how to respond to the authentication challenge in this method. Then set AuthChallengeDisposition to AuthChallenge* constants and pass the credentials to use.

If you don’t implement this method, the web view responds to the challenge with AuthChallengeRejectProtectionSpace.

WKWebViewControlMBS.downloadWillPerformHTTPRedirection(download as WKDownloadMBS, response as NSURLResponseMBS, request as NSURLRequestMBS, byref DownloadRedirectPolicy as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Asks the delegate to respond to the download’s redirect response.

download: The download that receives the redirect response.
response: The redirect response.
request: The new request the web view sends as a result of the redirect response.

Set DownloadRedirectPolicy to either DownloadRedirectPolicyAllow or DownloadRedirectPolicyCancel.

A download redirect policy that indicates whether to proceed with the redirect.

Determine whether to proceed with the redirect. Then invoke the decisionHandler closure, providing a download redirect policy that indicates whether to proceed with the redirect.

If you don’t implement this event, the web view proceeds with all redirects.

WKWebViewControlMBS.EnableMenuItems

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No

The event where you can enable menu items.
In Xojo version 2021r3 and newer this event is named MenuBarSelected.

WKWebViewControlMBS.EstimatedProgressChanged(estimatedProgress as double, oldEstimatedProgress as double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 19.0 ✅ Yes ❌ No ❌ No ❌ No
The estimated progress for loading the webpage changed.

This event may be called often, so don't do much here!

WKWebViewControlMBS.FocusLost

Type Topic Version
event WebKit2 17.1

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.

WKWebViewControlMBS.FocusReceived

Type Topic Version
event WebKit2 17.1

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.

WKWebViewControlMBS.FrameChanged

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The event called when the frame changed.

This event notifies you, that the control changed it's bounding frame, which is position and/or size.

WKWebViewControlMBS.GotFocus

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No

The control itself got focus.
In Xojo version 2021r3 and newer this event is named FocusReceived.

This only fires if the control itself got focus and not a sub control.

WKWebViewControlMBS.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 16.5 ✅ Yes ❌ No ❌ No ❌ No
JavaScript was evaluated.

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.

WKWebViewControlMBS.LostFocus

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No

The control lost focus.
In Xojo version 2021r3 and newer this event is named FocusLost.

This only fires if the control itself lost focus and not a sub control.

WKWebViewControlMBS.MenuBarSelected

Type Topic Version
event WebKit2 17.1

The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.

WKWebViewControlMBS.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 17.1 ✅ Yes ❌ No ❌ No ❌ No
The mouse button was pressed inside the control’s region at the location passed in to x, y.

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.
If you return False, the system handles the MouseDown so the above event handlers do not get called.

WKWebViewControlMBS.MouseDrag(x as Integer, y as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
This event fires continuously after the mouse button was pressed inside the Control.

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.

WKWebViewControlMBS.MouseUp(x as Integer, y as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The mouse button was released.

Use the x and y parameters to determine if the mouse button was released within the control's boundaries.

WKWebViewControlMBS.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
Tells the app that a navigation action became a download.
Example
Sub navigationActionDidBecomeDownload(navigationAction as WKNavigationActionMBS, download as WKDownloadMBS) Handles navigationActionDidBecomeDownload
System.DebugLog CurrentMethodName

// add download to your list of downloads you monitor
End Sub

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.

WKWebViewControlMBS.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
Tells the app that a navigation response became a download.
Example
Sub navigationResponseDidBecomeDownload(navigationResponse as WKNavigationResponseMBS, download as WKDownloadMBS) Handles navigationResponseDidBecomeDownload
System.DebugLog CurrentMethodName

// add download to your list of downloads you monitor
End Sub

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.

WKWebViewControlMBS.Open

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 16.4 ✅ Yes ❌ No ❌ No ❌ No

The control is about to was created and you can initialize it.
In Xojo version 2021r3 and newer this event is named Opening.

WKWebViewControlMBS.Opening

Type Topic Version
event WebKit2 16.4

The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.

WKWebViewControlMBS.runJavaScriptAlertPanel(initiatedByFrame as WKFrameInfoMBS, message as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ❌ No
Displays a JavaScript alert panel.

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.

WKWebViewControlMBS.runJavaScriptConfirmPanel(initiatedByFrame as WKFrameInfoMBS, message as String) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ❌ No
Displays a JavaScript confirm panel.

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.

WKWebViewControlMBS.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 16.5 ✅ Yes ❌ No ❌ No ❌ No
Displays a JavaScript text input panel.

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.

WKWebViewControlMBS.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
Displays a file upload panel.

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.

WKWebViewControlMBS.ScaleFactorChanged(NewFactor as Double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.

WKWebViewControlMBS.takeSnapshotCompleted(image as NSImageMBS, error as NSErrorMBS, tag as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 17.4 ✅ Yes ❌ No ❌ No ❌ No
Called when snapshot of website is completed.

If snapshot creation failed, error is set.

WKWebViewControlMBS.TitleChanged(Title as String, oldTitle as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 19.0 ✅ Yes ❌ No ❌ No ❌ No
The title of the webpage changed.

WKWebViewControlMBS.WebContentProcessDidTerminate

Type Topic Plugin Version macOS Windows Linux iOS Targets
event WebKit2 MBS Mac64bit Plugin 22.3 ✅ Yes ❌ No ❌ No ❌ No
Tells the app that the web view’s content process was terminated.

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.

Next items

The items on this page are in the following plugins: MBS Mac64bit Plugin.


The biggest plugin in space...