interface ICoreWebView2ExperimentalControllerOptions2

Article
08/26/2024

Note

This reference is no longer being maintained. For the latest API reference, see WebView2 API Reference.

Note

This an experimental API that is shipped with our prerelease SDK. See WebView2 release notes.

interface ICoreWebView2ExperimentalControllerOptions2
  : public IUnknown

Controller option used to allow user input pass through the browser and make them received in the host app process.

Summary

Members	Descriptions
get_AllowHostInputProcessing	Gets the `AllowHostInputProcessing` property.
put_AllowHostInputProcessing	`AllowHostInputProcessing` property is to enable/disable input passing through the app before being delivered to the WebView2.

Applies to

Product	Introduced
WebView2 Win32	N/A
WebView2 Win32 Prerelease	1.0.2415

Members

get_AllowHostInputProcessing

Gets the AllowHostInputProcessing property.

public HRESULT get_AllowHostInputProcessing(BOOL * value)

put_AllowHostInputProcessing

AllowHostInputProcessing property is to enable/disable input passing through the app before being delivered to the WebView2.

public HRESULT put_AllowHostInputProcessing(BOOL value)

This property is only applicable to controllers created with CoreWebView2Environment.CreateCoreWebView2ControllerAsync and not composition controllers created with CoreWebView2Environment.CreateCoreWebView2CompositionControllerAsync. By default the value is FALSE. Setting this property has no effect when using visual hosting.

    if (m_creationModeId == IDM_CREATION_MODE_HOST_INPUT_PROCESSING)
    {
        wil::com_ptr<ICoreWebView2ExperimentalControllerOptions2>
            webView2ExperimentalControllerOptions2;
        if (SUCCEEDED(
                options->QueryInterface(IID_PPV_ARGS(&webView2ExperimentalControllerOptions2))))
        {
            CHECK_FAILURE(
                webView2ExperimentalControllerOptions2->put_AllowHostInputProcessing(TRUE));
        }
    }

Share via