CoreWebView2EnvironmentOptions Class

  • Article

Options used to create WebView2 Environment. Default values will use your defaulted Edge WebView2 Runtime binaries and user data folder.

Summary

Members Description
AdditionalBrowserArguments Gets or sets the additional browser arguments to change the behavior of the WebView.
AllowSingleSignOnUsingOSPrimaryAccount Determines whether to enable single sign on with Azure Active Directory (AAD) resources inside WebView using the logged in Windows account and single sign on (SSO) with web sites using Microsoft account associated with the login in Windows account.
ExclusiveUserDataFolderAccess Determines whether other processes can create CoreWebView2Controller from CoreWebView2Environment created with the same user data folder and therefore sharing the same WebView browser process instance.
IsCustomCrashReportingEnabled When IsCustomCrashReportingEnabled is set to true, Windows won't send crash data to Microsoft endpoint.
Language Gets or sets the default display language for WebView.
TargetCompatibleBrowserVersion Gets or sets the version of the WebView2 Runtime binaries required to be compatible with your app.
CoreWebView2EnvironmentOptions

Properties

AdditionalBrowserArguments

string AdditionalBrowserArguments

Gets or sets the additional browser arguments to change the behavior of the WebView. The arguments are passed to the browser process as part of the command. For more information about using command-line switches with Chromium browser processes, navigate to Run Chromium with Flags. The value appended to a switch is appended to the browser process, for example, in --edge-webview-switches=xxx the value is xxx. If you specify a switch that is important to WebView functionality, it is ignored, for example, --user-data-dir. Specific features are disabled internally and blocked from being enabled. If a switch is specified multiple times, only the last instance is used.

A merge of the different values of the same switch is not attempted, except for disabled and enabled features. The features specified by --enable-features and --disable-features will be merged with simple logic:

  • The features are the union of the specified features and built-in features. If a feature is disabled, it is removed from the enabled features list. If you specify command-line switches and sets this property, the --edge-webview-switches value takes precedence and is processed last. If a switch fails to parse, the switch is ignored. The default state for the operation is to run the browser process with no extra flags. Please note that calling this API twice will replace the previous value rather than appending to it. If there are multiple switches, there should be a space in between them. The one exception is if multiple features are being enabled/disabled for a single switch, in which case the features should be comma-separated. Ex. "--disable-features=feature1,feature2 --some-other-switch --do-something"

AllowSingleSignOnUsingOSPrimaryAccount

bool AllowSingleSignOnUsingOSPrimaryAccount

Determines whether to enable single sign on with Azure Active Directory (AAD) resources inside WebView using the logged in Windows account and single sign on (SSO) with web sites using Microsoft account associated with the login in Windows account. The default value is false. Universal Windows Platform apps must also declare enterpriseCloudSSO restricted capability for the single sign on (SSO) to work.

ExclusiveUserDataFolderAccess

bool ExclusiveUserDataFolderAccess

Determines whether other processes can create CoreWebView2Controller from CoreWebView2Environment created with the same user data folder and therefore sharing the same WebView browser process instance. The default value is false.

IsCustomCrashReportingEnabled

bool IsCustomCrashReportingEnabled

When IsCustomCrashReportingEnabled is set to true, Windows won't send crash data to Microsoft endpoint. The default value is false. In this case, WebView will respect OS consent.

Language

string Language

Gets or sets the default display language for WebView. It applies to browser UIs such as context menu and dialogs. It also applies to the accept-languages HTTP header that WebView sends to websites. It is in the format of language[-country] where language is the 2-letter code from ISO 639 and country is the 2-letter code from ISO 3166.

TargetCompatibleBrowserVersion

string TargetCompatibleBrowserVersion

Gets or sets the version of the WebView2 Runtime binaries required to be compatible with your app. This defaults to the WebView2 Runtime version that corresponds with the version of the SDK the app is using. The format of this value is the same as the format of the CoreWebView2Environment.BrowserVersionString property and other BrowserVersion values. Only the version part of the BrowserVersion value is respected. The channel suffix, if it exists, is ignored. The version of the WebView2 Runtime binaries actually used may be different from the specified TargetCompatibleBrowserVersion. The binaries are only guaranteed to be compatible. Verify the actual version on the CoreWebView2Environment.BrowserVersionString property.

Constructors

CoreWebView2EnvironmentOptions

CoreWebView2EnvironmentOptions()

Referenced by