interface ICoreWebView2Settings6

Article
10/25/2021

Note

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

interface ICoreWebView2Settings6
  : public ICoreWebView2Settings5

A continuation of the ICoreWebView2Settings interface to manage swipe navigation.

Summary

Members	Descriptions
get_IsSwipeNavigationEnabled	The `IsSwipeNavigationEnabled` property enables or disables the ability of the end user to use swiping gesture on touch input enabled devices to navigate in WebView2.
put_IsSwipeNavigationEnabled	Set the `IsSwipeNavigationEnabled` property.

Applies to

Product	Introduced
WebView2 Win32	1.0.992.28
WebView2 Win32 Prerelease	1.0.1010

Members

get_IsSwipeNavigationEnabled

The IsSwipeNavigationEnabled property enables or disables the ability of the end user to use swiping gesture on touch input enabled devices to navigate in WebView2.

public HRESULT get_IsSwipeNavigationEnabled(BOOL * enabled)

It defaults to TRUE.

When this property is TRUE, then all configured navigation gestures are enabled:

Swiping left and right to navigate forward and backward is always configured.
Swiping down to refresh is off by default and not exposed via our API currently, it requires the "--pull-to-refresh" option to be included in the additional browser arguments to be configured. (See put_AdditionalBrowserArguments.)

When set to FALSE, the end user cannot swipe to navigate or pull to refresh. This API only affects the overscrolling navigation functionality and has no effect on the scrolling interaction used to explore the web content shown in WebView2.

Disabling/Enabling IsSwipeNavigationEnabled takes effect after the next navigation.

            CHECK_FEATURE_RETURN(m_settings6);
            BOOL swipeNavigationEnabled;
            CHECK_FAILURE(m_settings6->get_IsSwipeNavigationEnabled(&swipeNavigationEnabled));
            if (swipeNavigationEnabled)
            {
                CHECK_FAILURE(m_settings6->put_IsSwipeNavigationEnabled(FALSE));
                MessageBox(
                    nullptr, L"Swipe to navigate is disabled after the next navigation.",
                    L"Settings change", MB_OK);
            }
            else
            {
                CHECK_FAILURE(m_settings6->put_IsSwipeNavigationEnabled(TRUE));
                MessageBox(
                    nullptr, L"Swipe to navigate is enabled after the next navigation.",
                    L"Settings change", MB_OK);
            }

put_IsSwipeNavigationEnabled

Set the IsSwipeNavigationEnabled property.

public HRESULT put_IsSwipeNavigationEnabled(BOOL enabled)

Share via