Language

CoreWebView2DedicatedWorker Class

Definition

Represents a dedicated worker in WebView2 and provides methods and properties for interacting with it, such as getting the script URI, posting messages, managing events related to the creation of child workers, termination, etc.

public class CoreWebView2DedicatedWorker
type CoreWebView2DedicatedWorker = class
Public Class CoreWebView2DedicatedWorker
Inheritance
CoreWebView2DedicatedWorker

Properties

Name Description
ScriptUri

A string representing the Uri of the script that the worker is executing.

The scriptUri is a fully qualified URI, including the scheme, host, and path. In contrast, the script URL passed to the Worker constructor in the DOM can be relative. For more details on DOM API, see the DOM API documentation.

Refer to the Host Name Canonicalization for details on how normalization is performed. The same process applies to the script URL when a worker is created from DOM API. The scriptUri property reflects this normalization, ensuring that the URL is standardized. For example, HTTPS://EXAMPLE.COM/worker.js is canonicalized to https://example.com/worker.js; https://bücher.de/worker.js is canonicalized to https://xn--bcher-kva.de/worker.js.

Methods

Name Description
PostWebMessageAsJson(String)

Posts the specified webMessageAsJson to this worker.

PostWebMessageAsString(String)

Posts a message that is a simple string rather than a JSON string representation of a JavaScript object. This behaves in exactly the same manner as PostWebMessageAsJson(String), but the data property of the event arg of the self.chrome.webview message is a string with the same value as webMessageAsString. Use this instead of PostWebMessageAsJson(String) if you want to communicate using simple strings rather than JSON objects.

Events

Name Description
DedicatedWorkerCreated

Subscribe to this event that gets raised when a new dedicated worker is created from a dedicated worker.

A Dedicated Worker is a type of web worker that allows you to run Javascript code in the background without blocking the main thread, making them useful for tasks like heavy computations, data processing, and parallel execution. It is "dedicated" because it is linked to a single parent document and cannot be shared with other scripts.

This event is raised when a dedicated worker creates a dedicated worker using the new Worker("/worker.js") method. See the Worker for more information.

Destroying

Raised when the worker object is being destroyed.

A worker object is being destroyed when the worker script is terminated or when the CoreWebView2DedicatedWorker object is being destroyed.

If the worker has already been destroyed before the event handler is registered, the handler will never be called.

WebMessageReceived

WebMessageReceived is fired when the IsWebMessageEnabled setting is set to true and the worker runs self.chrome.webview.postMessage. The postMessage function is void postMessage(object) where object is any object supported by JSON conversion.

If the worker calls postMessage multiple times, the corresponding WebMessageReceived events are guaranteed to be fired in the same order.

Applies to