BrowserType

BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation

using Microsoft.Playwright;
using System.Threading.Tasks;

class BrowserTypeExamples
{
    public static async Task Run()
    {
        using var playwright = await Playwright.CreateAsync();
        var chromium = playwright.Chromium;
        var browser = await chromium.LaunchAsync();
        var page = await browser.NewPageAsync();
        await page.GotoAsync("https://www.bing.com");
        // other actions
        await browser.CloseAsync();
    }
}

Methods

ConnectAsync

Added before v1.9

browserType.ConnectAsync

This method attaches Playwright to an existing browser instance created via BrowserType.launchServer in Node.js.

note

The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).

Usage

await BrowserType.ConnectAsync(wsEndpoint, options);

Arguments

wsEndpoint stringAdded in: v1.10#

A Playwright browser websocket endpoint to connect to. You obtain this endpoint via BrowserServer.wsEndpoint.
options BrowserTypeConnectOptions? (optional)
- ExposeNetwork string? (optional)Added in: v1.37#
  
  This option exposes network available on the connecting client to the browser being connected to. Consists of a list of rules separated by comma.
  
  Available rules
  1. Hostname pattern, for example: example.com, *.org:99, x.*.y.com, *foo.org.
  2. IP literal, for example: 127.0.0.1, 0.0.0.0:99, [::1], [0:0::1]:99.
  3. <loopback> that matches local loopback interfaces: localhost, *.localhost, 127.0.0.1, [::1].
  Some common examples
  1. "*" to expose all network.
  2. "<loopback>" to expose localhost network.
  3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" to expose test/staging deployments and localhost.
- Headers IDictionary?<string, string> (optional)Added in: v1.11#
  
  Additional HTTP headers to be sent with web socket connect request. Optional.
- SlowMo [float]? (optional)Added in: v1.10#
  
  Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.
- Timeout [float]? (optional)Added in: v1.10#
  
  Maximum time in milliseconds to wait for the connection to be established. Defaults to 0 (no timeout).

Returns

Browser #

ConnectOverCDPAsync

Added in: v1.9

browserType.ConnectOverCDPAsync

This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.

The default browser context is accessible via Browser.Contexts.

note

Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.

note

This connection is significantly lower fidelity than the Playwright protocol connection via BrowserType.ConnectAsync(). If you are experiencing issues or attempting to use advanced functionality, you probably want to use BrowserType.ConnectAsync().

Usage

var browser = await playwright.Chromium.ConnectOverCDPAsync("https://127.0.0.1:9222");
var defaultContext = browser.Contexts[0];
var page = defaultContext.Pages[0];

Arguments

endpointURL stringAdded in: v1.11#

A CDP websocket endpoint or http url to connect to. For example https://127.0.0.1:9222/ or ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4.
options BrowserTypeConnectOverCDPOptions? (optional)
- Headers IDictionary?<string, string> (optional)Added in: v1.11#
  
  Additional HTTP headers to be sent with connect request. Optional.
- SlowMo [float]? (optional)Added in: v1.11#
  
  Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.
- Timeout [float]? (optional)Added in: v1.11#
  
  Maximum time in milliseconds to wait for the connection to be established. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

Returns

Browser #

ExecutablePath

Added before v1.9

browserType.ExecutablePath

A path where Playwright expects to find a bundled browser executable.

Usage

BrowserType.ExecutablePath

Returns

string #

LaunchAsync

Added before v1.9

browserType.LaunchAsync

Returns the browser instance.

Usage

You can use IgnoreDefaultArgs to filter out --mute-audio from default arguments

var browser = await playwright.Chromium.LaunchAsync(new() {
    IgnoreDefaultArgs = new[] { "--mute-audio" }
});

Chromium-only Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use ExecutablePath option with extreme caution.

If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.

Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See this article for other differences between Chromium and Chrome. This article describes some differences for Linux users.

Arguments

options BrowserTypeLaunchOptions? (optional)
- Args IEnumerable?<string> (optional)#
  
  warning
  Use custom browser args at your own risk, as some of them may break Playwright functionality.
  
  Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
- Channel string? (optional)#
  
  Browser distribution channel.
  
  Use "chromium" to opt in to new headless mode.
  
  Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.
- ChromiumSandbox bool? (optional)#
  
  Enable Chromium sandboxing. Defaults to false.
- Devtools bool? (optional)#
  
  Deprecated
  Use debugging tools instead.
  
  Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option is true, the Headless option will be set false.
- DownloadsPath string? (optional)#
  
  If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
- Env IDictionary?<string, string> (optional)#
  
  Specify environment variables that will be visible to the browser. Defaults to process.env.
- ExecutablePath string? (optional)#
  
  Path to a browser executable to run instead of the bundled one. If ExecutablePath is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.
- FirefoxUserPrefs IDictionary?<string, [object]> (optional)#
  
  Firefox user preferences. Learn more about the Firefox user preferences at about:config.
- HandleSIGHUP bool? (optional)#
  
  Close the browser process on SIGHUP. Defaults to true.
- HandleSIGINT bool? (optional)#
  
  Close the browser process on Ctrl-C. Defaults to true.
- HandleSIGTERM bool? (optional)#
  
  Close the browser process on SIGTERM. Defaults to true.
- Headless bool? (optional)#
  
  Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true unless the Devtools option is true.
- IgnoreAllDefaultArgs bool? (optional)Added in: v1.9#
  
  If true, Playwright does not pass its own configurations args and only uses the ones from Args. Dangerous option; use with care. Defaults to false.
- IgnoreDefaultArgs IEnumerable?<string> (optional)#
  
  If true, Playwright does not pass its own configurations args and only uses the ones from Args. Dangerous option; use with care.
- Proxy Proxy? (optional)#
  - Server string
    
    Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
  - Bypass string? (optional)
    
    Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
  - Username string? (optional)
    
    Optional username to use if HTTP proxy requires authentication.
  - Password string? (optional)
    
    Optional password to use if HTTP proxy requires authentication.
  Network proxy settings.
- SlowMo [float]? (optional)#
  
  Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
- Timeout [float]? (optional)#
  
  Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
- TracesDir string? (optional)#
  
  If specified, traces are saved into this directory.

Returns

Browser #

LaunchPersistentContextAsync

Added before v1.9

browserType.LaunchPersistentContextAsync

Returns the persistent browser context instance.

Launches browser that uses persistent storage located at userDataDir and returns the only context. Closing this context will automatically close the browser.

Usage

await BrowserType.LaunchPersistentContextAsync(userDataDir, options);

Arguments

userDataDir string #

Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox. Note that Chromium's user data directory is the parent directory of the "Profile Path" seen at chrome://version. Pass an empty string to use a temporary directory instead.
options BrowserTypeLaunchPersistentContextOptions? (optional)
- AcceptDownloads bool? (optional)#
  
  Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
- Args IEnumerable?<string> (optional)#
  
  warning
  Use custom browser args at your own risk, as some of them may break Playwright functionality.
  
  Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
- BaseURL string? (optional)#
  
  When using Page.GotoAsync(), Page.RouteAsync(), Page.WaitForURLAsync(), Page.RunAndWaitForRequestAsync(), or Page.RunAndWaitForResponseAsync() it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples
  - baseURL: https://127.0.0.1:3000 and navigating to /bar.html results in https://127.0.0.1:3000/bar.html
  - baseURL: https://127.0.0.1:3000/foo/ and navigating to ./bar.html results in https://127.0.0.1:3000/foo/bar.html
  - baseURL: https://127.0.0.1:3000/foo (without trailing slash) and navigating to ./bar.html results in https://127.0.0.1:3000/bar.html
- BypassCSP bool? (optional)#
  
  Toggles bypassing page's Content-Security-Policy. Defaults to false.
- Channel string? (optional)#
  
  Browser distribution channel.
  
  Use "chromium" to opt in to new headless mode.
  
  Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.
- ChromiumSandbox bool? (optional)#
  
  Enable Chromium sandboxing. Defaults to false.
- ClientCertificates IEnumerable?<ClientCertificates> (optional)Added in: 1.46#
  - Origin string
    
    Exact origin that the certificate is valid for. Origin includes https protocol, a hostname and optionally a port.
  - CertPath string? (optional)
    
    Path to the file with the certificate in PEM format.
  - Cert byte[]? (optional)
    
    Direct value of the certificate in PEM format.
  - KeyPath string? (optional)
    
    Path to the file with the private key in PEM format.
  - Key byte[]? (optional)
    
    Direct value of the private key in PEM format.
  - PfxPath string? (optional)
    
    Path to the PFX or PKCS12 encoded private key and certificate chain.
  - Pfx byte[]? (optional)
    
    Direct value of the PFX or PKCS12 encoded private key and certificate chain.
  - Passphrase string? (optional)
    
    Passphrase for the private key (PEM or PFX).
  TLS Client Authentication allows the server to request a client certificate and verify it.
  
  Details
  
  An array of client certificates to be used. Each certificate object must have either both certPath and keyPath, a single pfxPath, or their corresponding direct value equivalents (cert and key, or pfx). Optionally, passphrase property should be provided if the certificate is encrypted. The origin property should be provided with an exact match to the request origin that the certificate is valid for.
  
  note
  When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.
- ColorScheme enum ColorScheme { Light, Dark, NoPreference, Null }? (optional)#
  
  Emulates prefers-colors-scheme media feature, supported values are 'light' and 'dark'. See Page.EmulateMediaAsync() for more details. Passing 'null' resets emulation to system defaults. Defaults to 'light'.
- Contrast enum Contrast { NoPreference, More, Null }? (optional)#
  
  Emulates 'prefers-contrast' media feature, supported values are 'no-preference', 'more'. See Page.EmulateMediaAsync() for more details. Passing 'null' resets emulation to system defaults. Defaults to 'no-preference'.
- DeviceScaleFactor [float]? (optional)#
  
  Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.
- Devtools bool? (optional)#
  
  Deprecated
  Use debugging tools instead.
  
  Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option is true, the Headless option will be set false.
- DownloadsPath string? (optional)#
  
  If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
- Env IDictionary?<string, string> (optional)#
  
  Specify environment variables that will be visible to the browser. Defaults to process.env.
- ExecutablePath string? (optional)#
  
  Path to a browser executable to run instead of the bundled one. If ExecutablePath is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.
- ExtraHTTPHeaders IDictionary?<string, string> (optional)#
  
  An object containing additional HTTP headers to be sent with every request. Defaults to none.
- FirefoxUserPrefs IDictionary?<string, [object]> (optional)Added in: v1.40#
  
  Firefox user preferences. Learn more about the Firefox user preferences at about:config.
- ForcedColors enum ForcedColors { Active, None, Null }? (optional)#
  
  Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See Page.EmulateMediaAsync() for more details. Passing 'null' resets emulation to system defaults. Defaults to 'none'.
- Geolocation Geolocation? (optional)#
  - Latitude [float]
    
    Latitude between -90 and 90.
  - Longitude [float]
    
    Longitude between -180 and 180.
  - Accuracy [float]? (optional)
    
    Non-negative accuracy value. Defaults to 0.
- HandleSIGHUP bool? (optional)#
  
  Close the browser process on SIGHUP. Defaults to true.
- HandleSIGINT bool? (optional)#
  
  Close the browser process on Ctrl-C. Defaults to true.
- HandleSIGTERM bool? (optional)#
  
  Close the browser process on SIGTERM. Defaults to true.
- HasTouch bool? (optional)#
  
  Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
- Headless bool? (optional)#
  
  Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true unless the Devtools option is true.
- HttpCredentials HttpCredentials? (optional)#
  - Username string
  - Password string
  - Origin string? (optional)
    
    Restrain sending http credentials on specific origin (scheme://host:port).
  - Send enum HttpCredentialsSend { Unauthorized, Always }? (optional)
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，并且不影响从浏览器发送的请求。'always' - Authorization 标头将随每个 API 请求一起发送基本身份验证凭据。 'unauthorized' - 凭据仅在收到带有 WWW-Authenticate 标头的 401（未授权）响应时发送。默认为 'unauthorized'。
  HTTP 身份验证的凭据。如果未指定来源，则用户名和密码将发送到任何服务器以响应未经授权的响应。
- IgnoreAllDefaultArgs bool? (optional)Added in: v1.9#
  
  如果为 true，Playwright 不会传递其自身的配置参数，而仅使用来自 Args 的参数。危险选项；请谨慎使用。默认为 false。
- IgnoreDefaultArgs IEnumerable?<string> (可选)#
  
  如果为 true，Playwright 不会传递其自身的配置参数，而仅使用来自 Args 的参数。危险选项；请谨慎使用。
- IgnoreHTTPSErrors bool? (可选)#
  
  是否在发送网络请求时忽略 HTTPS 错误。默认为 false。
- IsMobile bool? (可选)#
  
  是否考虑 meta viewport 标签并启用触摸事件。 isMobile 是设备的一部分，因此实际上不需要手动设置。默认为 false，并且 Firefox 不支持。了解更多关于移动设备模拟的信息。
- JavaScriptEnabled bool? (可选)#
  
  是否在此上下文中启用 JavaScript。默认为 true。了解更多关于禁用 JavaScript 的信息。
- Locale string? (可选)#
  
  指定用户区域设置，例如 en-GB、de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求标头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。
- Offline bool? (可选)#
  
  是否模拟网络离线状态。默认为 false。了解更多关于网络模拟的信息。
- Permissions IEnumerable?<string> (可选)#
  
  要授予此上下文中所有页面的权限列表。有关更多详细信息，请参阅 BrowserContext.GrantPermissionsAsync()。默认为无。
- Proxy Proxy? (可选)#
  - Server string
    
    Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
  - Bypass string? (optional)
    
    Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
  - Username string? (optional)
    
    Optional username to use if HTTP proxy requires authentication.
  - Password string? (optional)
    
    Optional password to use if HTTP proxy requires authentication.
  Network proxy settings.
- RecordHarContent enum HarContentPolicy { Omit, Embed, Attach }? (可选)#
  
  用于控制资源内容管理的可选设置。如果指定 omit，则不会持久保存内容。如果指定 attach，则资源将保存为单独的文件，并且所有这些文件都将与 HAR 文件一起存档。默认为 embed，它按照 HAR 规范将内容内联存储在 HAR 文件中。
- RecordHarMode enum HarMode { Full, Minimal }? (可选)#
  
  当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这省略了大小、计时、页面、cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时未使用。默认为 full。
- RecordHarOmitContent bool? (可选)#
  
  用于控制是否从 HAR 中省略请求内容的可选设置。默认为 false。
- RecordHarPath string? (可选)#
  
  为所有页面启用 HAR 记录，并将记录保存到文件系统上指定的 HAR 文件中。如果未指定，则不记录 HAR。确保调用 BrowserContext.CloseAsync() 以保存 HAR。
- RecordHarUrlFilter|RecordHarUrlFilterRegex string? | Regex? (可选)#
- RecordVideoDir string? (可选)#
  
  为所有页面启用视频录制，并将录制保存到指定目录。如果未指定，则不录制视频。确保调用 BrowserContext.CloseAsync() 以保存视频。
- RecordVideoSize RecordVideoSize? (可选)#
  - Width int
    
    视频帧宽度。
  - Height int
    
    视频帧高度。
  录制视频的尺寸。如果未指定，则尺寸将等于 viewport 缩小到适合 800x800。如果未显式配置 viewport，则视频尺寸默认为 800x450。如果需要，每个页面的实际图片将被缩小以适应指定的尺寸。
- ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (可选)#
  
  模拟 'prefers-reduced-motion' 媒体功能，支持的值为 'reduce'、'no-preference'。有关更多详细信息，请参阅 Page.EmulateMediaAsync()。传递 'null' 会将模拟重置为系统默认值。默认为 'no-preference'。
- ScreenSize ScreenSize? (可选)#
  - Width int
    
    页面宽度（像素）。
  - Height int
    
    页面高度（像素）。
  模拟通过 window.screen 在网页内可用的统一窗口屏幕尺寸。仅当设置了 ViewportSize 时才使用。
- ServiceWorkers enum ServiceWorkerPolicy { Allow, Block }? (可选)#
  
  是否允许站点注册 Service Worker。默认为 'allow'。
  - 'allow': 可以注册 Service Worker。
  - 'block': Playwright 将阻止所有 Service Worker 的注册。
- SlowMo [float]? (可选)#
  
  Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
- StrictSelectors bool? (可选)#
  
  如果设置为 true，则为此上下文启用严格选择器模式。在严格选择器模式下，当多个元素与选择器匹配时，对暗示单个目标 DOM 元素的选择器的所有操作都将抛出异常。此选项不影响任何 Locator API（Locator 始终是严格的）。默认为 false。请参阅 Locator 以了解有关严格模式的更多信息。
- Timeout [float]? (可选)#
  
  Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
- TimezoneId string? (可选)#
  
  更改上下文的时区。有关支持的时区 ID 列表，请参阅 ICU 的 metaZones.txt。默认为系统时区。
- TracesDir string? (可选)#
  
  If specified, traces are saved into this directory.
- UserAgent string? (可选)#
  
  在此上下文中使用的特定用户代理。
- ViewportSize ViewportSize? (可选)#
  - Width int
    
    页面宽度（像素）。
  - Height int
    
    页面高度（像素）。
  为每个页面模拟一致的视口。默认为 1280x720 视口。使用 ViewportSize.NoViewport 禁用一致的视口模拟。了解更多关于视口模拟的信息。
  
  note
  ViewportSize.NoViewport 值选择退出默认预设，使视口依赖于操作系统定义的主机窗口大小。这使得测试的执行具有不确定性。

Returns

BrowserContext #

名称

Added before v1.9

browserType.Name

返回浏览器名称。例如：'chromium'、'webkit' 或 'firefox'。

Usage

BrowserType.Name

Returns

string #

Methods​

ConnectAsync​

ConnectOverCDPAsync​

ExecutablePath​

LaunchAsync​

LaunchPersistentContextAsync​

名称​

Methods

ConnectAsync

ConnectOverCDPAsync

ExecutablePath

LaunchAsync

LaunchPersistentContextAsync

名称