PostStringWebMessage

Description

Sends the web message in a simple string (rather than a JSON string) to the top-level document in WebBrowser asynchronously. In the top-level document of WebBrowser, the message can be subscribed or unsubscribed through the following JavaScript:

window.chrome.webview.addEventListener('message', handler)
window.chrome.webview.removeEventListener('message', handler)

This behaves in exactly the same manner as PostJsonWebMessage, but the data property of the event arg of the message is a string with the same value sent by this function PostStringWebMessage. Use this instead of PostJsonWebMessage if you want to communicate using simple strings rather than JSON objects.

Applies to

WebBrowser control

Syntax

controlname.PostStringWebMessage(sring webmessage)

Argument

Description

controlname

The name of the WebBrowser control.

webmessage

The message (in simple string format) to be sent to the top-level document, for example:

"{'a': 'b'}"
"1.2"
"example"

Return value

Integer.

Returns values as follows. If any argument's value is null, the method returns null.

  • 1 -- Success

  • -1 -- Failed to execute the line.

  • -2 -- Failed to initialize the control and obtain the WebBrowser object. The WebView2 is invalid.

  • -4 -- The target path does not exist.

  • -5 -- The URI is invalid.

  • -6 -- The specified download task does not exist.

  • -8 -- The setting item does not exist.

  • -9 -- The path is invalid or does not exist.

  • -11 -- Unknown error.

  • -12 -- Invalid event name.

  • -14 -- Invalid argument.

  • -15 -- Failed to create screenshot file.

  • -16 -- There is a print job in progress, which cannot be closed.

  • -17 -- Could not find the corresponding item.

Examples

This example sends the specified string webMessage to the top-level document.

//window.chrome.webview.addEventListener('message', arg => {
//   window.chrome.webview.postMessage(JSON.stringify(arg.data));
//        });
Integer li_return

li_return = wb_1.PostStringWebMessage('testStr')

See also

OpenDefaultDownloadDialog

PostJsonWebMessage