跳到主要内容

Page

Page 提供了与 Browser 中的单个标签页，或 Chromium 中的 扩展后台页面 进行交互的方法。一个 Browser 实例可能有多个 Page 实例。

此示例创建一个页面，导航到某个 URL，然后保存一张截图：

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

class PageExamples
{
    public static async Task Run()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Webkit.LaunchAsync();
        var page = await browser.NewPageAsync();
        await page.GotoAsync("https://www.theverge.com");
        await page.ScreenshotAsync(new() { Path = "theverge.png" });
    }
}

Page 类会触发各种事件（如下所述），可以使用 Node 的原生 EventEmitter 方法（如 on、once 或 removeListener）来处理这些事件。

此示例为单个页面的 load 事件记录一条消息：

page.Load += (_, _) => Console.WriteLine("Page loaded!");

要取消订阅事件，请使用 removeListener 方法：

void PageLoadHandler(object _, IPage p) {
    Console.WriteLine("Page loaded!");
};

page.Load += PageLoadHandler;
// 执行一些操作...
page.Load -= PageLoadHandler;

方法​

AddInitScriptAsync​

在 v1.9 之前添加 page.AddInitScriptAsync

添加一个脚本，该脚本会在以下场景之一中执行：

  • 每当页面导航时。
  • 每当子框架附加或导航时。在这种情况下，脚本会在新附加的框架上下文中执行。

该脚本会在文档创建后但在其任何脚本运行之前执行。这对于修改 JavaScript 环境很有用，例如设置 Math.random 的初始值。

用法​

在页面加载前重写 Math.random 的示例：

// preload.js
Math.random = () => 42;
await Page.AddInitScriptAsync(scriptPath: "./preload.js");
备注

通过 BrowserContext.AddInitScriptAsync() 和 Page.AddInitScriptAsync() 安装的多个脚本的执行顺序未定义。

参数​

  • script string | string#

    要在浏览器上下文中的所有页面中执行的脚本。

返回值​

AddLocatorHandlerAsync​

新增于：v1.42 page.AddLocatorHandlerAsync

在测试网页时，有时会出现意外的覆盖层，如 “注册” 对话框，这些覆盖层会阻止你想要自动化执行的操作，例如点击按钮。这些覆盖层的出现方式和时间并不总是一致，这使得在自动化测试中处理它们变得棘手。

此方法允许你设置一个特殊的函数（称为处理程序），当检测到覆盖层可见时，该函数将被激活。处理程序的任务是移除覆盖层，使你的测试能够继续进行，就像覆盖层不存在一样。

请注意以下几点：

  • 如果覆盖层的出现是可预测的，我们建议在测试中显式等待它，并将其作为正常测试流程的一部分予以消除，而不是使用 Page.AddLocatorHandlerAsync()。
  • Playwright 每次在执行或重试需要进行可操作性检查的操作之前，或者在执行自动等待断言检查之前，都会检查是否存在覆盖层。当覆盖层可见时，Playwright 会首先调用处理程序，然后继续执行操作/断言。请注意，只有在你执行操作/断言时才会调用处理程序 —— 如果覆盖层可见但你不执行任何操作，处理程序将不会被触发。
  • 执行处理程序后，Playwright 将确保触发处理程序的覆盖层不再可见。你可以使用 NoWaitAfter 选择不采用此行为。
  • 处理程序的执行时间计入执行该处理程序的操作/断言的超时时间。如果你的处理程序耗时过长，可能会导致超时。
  • 你可以注册多个处理程序。但是，一次只会运行一个处理程序。请确保一个处理程序中的操作不依赖于另一个处理程序。
注意

运行处理程序会在测试过程中改变页面状态。例如，它会更改当前聚焦的元素并移动鼠标。请确保处理程序运行后执行的操作是自包含的，并且不依赖于焦点和鼠标状态保持不变。

例如，假设有一个测试，先调用 Locator.FocusAsync()，然后调用 Keyboard.PressAsync()。如果你的处理程序在这两个操作之间点击了一个按钮，那么聚焦的元素很可能是错误的，按键操作将发生在意外的元素上。应改用 Locator.PressAsync() 来避免此问题。

另一个例子是一系列鼠标操作，先调用 Mouse.MoveAsync()，然后调用 Mouse.DownAsync()。同样，当处理程序在这两个操作之间运行时，鼠标按下时的鼠标位置将是错误的。最好使用像 Locator.ClickAsync() 这样自包含的操作，这些操作不依赖于处理程序未改变的状态。

用法​

以下是一个示例，当“订阅新闻通讯”对话框出现时将其关闭：

// 设置处理程序。
await page.AddLocatorHandlerAsync(page.GetByText("订阅新闻通讯"), async () => {
  await page.GetByRole(AriaRole.Button, new() { Name = "不用了，谢谢" }).ClickAsync();
});

// 像往常一样编写测试。
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "从这里开始" }).ClickAsync();

以下是一个示例，当“确认您的安全详细信息”页面出现时跳过该页面：

// 设置处理程序。
await page.AddLocatorHandlerAsync(page.GetByText("确认您的安全详细信息"), async () => {
  await page.GetByRole(AriaRole.Button, new() { Name = "稍后提醒我" }).ClickAsync();
});

// 像往常一样编写测试。
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "从这里开始" }).ClickAsync();

以下是一个在每次可操作性检查时使用自定义回调的示例。它使用始终可见的 <body> 定位器，因此在每次可操作性检查之前都会调用处理程序。指定 NoWaitAfter 很重要，因为处理程序不会隐藏 <body> 元素。

// 设置处理程序。
await page.AddLocatorHandlerAsync(page.Locator("body"), async () => {
  await page.EvaluateAsync("window.removeObstructionsForTestIfNeeded()");
}, new() { NoWaitAfter = true });

// 像往常一样编写测试。
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "从这里开始" }).ClickAsync();

处理程序将原始定位器作为参数。你还可以通过设置 Times，在调用一定次数后自动移除处理程序：

await page.AddLocatorHandlerAsync(page.GetByText("订阅新闻通讯"), async locator => {
  await locator.ClickAsync();
}, new() { Times = 1 });

参数​

  • locator Locator# 触发处理程序的定位器。
  • handler Func<Locator, Task># 当 locator 出现时应运行的函数。此函数应移除阻止诸如点击等操作的元素。
  • options PageAddLocatorHandlerOptions?（可选）
    • NoWaitAfter bool?（可选） 新增于：v1.44# 默认情况下，调用处理程序后，Playwright 将等待覆盖层隐藏，只有在此时，Playwright 才会继续执行触发处理程序的操作或断言。此选项允许不采用此行为，以便在处理程序运行后覆盖层可以保持可见。
    • Times int?（可选） 新增于：v1.44# 指定此处理程序应被调用的最大次数。默认无限制。

返回值​

AddScriptTagAsync​

在 v1.9 之前添加 page.AddScriptTagAsync

将带有所需 URL 或内容的 <script> 标签添加到页面中。当脚本的 onload 触发或脚本内容注入到框架中时，返回添加的标签。

用法

await Page.AddScriptTagAsync(options);

参数

  • options PageAddScriptTagOptions?（可选）

    • Content string?（可选）#

      要注入到框架中的原始 JavaScript 内容。

    • Path string?（可选）#

      要注入到框架中的 JavaScript 文件的路径。如果 path 是相对路径，则相对于当前工作目录进行解析。

    • Type string?（可选）#

      脚本类型。若要加载 JavaScript ES6 模块，请使用 module。更多详细信息，请参阅 script。

    • Url string?（可选）#

      要添加的脚本的 URL。

返回值

AddStyleTagAsync​

在 v1.9 之前添加 page.AddStyleTagAsync

向页面中添加一个带有指定 URL 的 <link rel="stylesheet"> 标签，或添加一个带有内容的 <style type="text/css"> 标签。当样式表的 onload 事件触发，或 CSS 内容注入到框架中时，返回添加的标签。

用法

await Page.AddStyleTagAsync(options);

参数

  • options PageAddStyleTagOptions?（可选）

    • Content string?（可选）#

      要注入到框架中的原始 CSS 内容。

    • Path string?（可选）#

      要注入到框架中的 CSS 文件路径。如果 path 是相对路径，则相对于当前工作目录进行解析。

    • Url string?（可选）#

      <link> 标签的 URL。

返回值

BringToFrontAsync​

在 v1.9 之前添加 page.BringToFrontAsync

将页面置于前端（激活标签页）。

用法

await Page.BringToFrontAsync();

返回值

CloseAsync​

在 v1.9 之前添加 page.CloseAsync

如果 RunBeforeUnload 为 false，则不会运行任何卸载处理程序，并等待页面关闭。如果 RunBeforeUnload 为 true，该方法将运行卸载处理程序，但 不会 等待页面关闭。

默认情况下，page.close() 不会 运行 beforeunload 处理程序。

备注

如果将 RunBeforeUnload 设为 true，可能会弹出 beforeunload 对话框，应通过 Page.Dialog 事件手动处理。

用法

await Page.CloseAsync(options);

参数

  • options PageCloseOptions?（可选）

    • Reason string?（可选）在 v1.40 中添加#

      报告给因页面关闭而中断的操作的原因。

    • RunBeforeUnload bool?（可选）#

      默认值为 false。是否运行 before unload 页面处理程序。

返回值

ContentAsync​

在 v1.9 之前添加 page.ContentAsync

获取页面的完整 HTML 内容，包括文档类型声明。

用法

await Page.ContentAsync();

返回值

Context​

在 v1.9 之前添加 page.Context

获取该页面所属的浏览器上下文。

用法

Page.Context

返回值

DragAndDropAsync​

添加于：v1.13 page.DragAndDropAsync

此方法将源元素拖到目标元素。它首先会移动到源元素，执行 mousedown 操作，然后移动到目标元素并执行 mouseup 操作。

用法

await Page.DragAndDropAsync("#source", "#target");
// 或者指定相对于元素左上角的精确位置：
await Page.DragAndDropAsync("#source", "#target", new()
{
    SourcePosition = new() { X = 34, Y = 7 },
    TargetPosition = new() { X = 10, Y = 20 },
});

参数

  • source string#

    用于搜索要拖动元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • target string#

    用于搜索要放置到的元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageDragAndDropOptions? （可选）

    • Force bool? （可选）#

      是否绕过可操作性检查。默认为 false。

    • NoWaitAfter bool? （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • SourcePosition SourcePosition? （可选） 新增于：v1.14#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角的此点，点击源元素。如果未指定，则使用元素的某个可见点。

    • Strict bool? （可选） 新增于：v1.14#

      为 true 时，此调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，调用将抛出异常。

    • TargetPosition TargetPosition? （可选） 新增于：v1.14#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角的此点，放置到目标元素。如果未指定，则使用元素的某个可见点。

    • Timeout [float]? （可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool? （可选）#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不执行操作很有用。

返回值

EmulateMediaAsync​

在 v1.9 之前添加 page.EmulateMediaAsync

此方法通过 media 参数更改 CSS 媒体类型，和 / 或使用 colorScheme 参数更改 'prefers-colors-scheme' 媒体功能。

用法

await page.EvaluateAsync("() => matchMedia('screen').matches");
// → true
await page.EvaluateAsync("() => matchMedia('print').matches");
// → false

await page.EmulateMediaAsync(new() { Media = Media.Print });
await page.EvaluateAsync("() => matchMedia('screen').matches");
// → false
await page.EvaluateAsync("() => matchMedia('print').matches");
// → true

await page.EmulateMediaAsync(new() { Media = Media.Screen });
await page.EvaluateAsync("() => matchMedia('screen').matches");
// → true
await page.EvaluateAsync("() => matchMedia('print').matches");
// → false
await page.EmulateMediaAsync(new() { ColorScheme = ColorScheme.Dark });
await page.EvaluateAsync("matchMedia('(prefers-color-scheme: dark)').matches");
// → true
await page.EvaluateAsync("matchMedia('(prefers-color-scheme: light)').matches");
// → false

参数

  • options PageEmulateMediaOptions?（可选）

    • ColorScheme enum ColorScheme { Light, Dark, NoPreference, Null }?（可选） 新增于：v1.9#

      模拟 prefers-colors-scheme 媒体特性，支持的值为 'light' 和 'dark'。传入 'Null' 可禁用颜色模式模拟。'no-preference' 已弃用。

    • Contrast enum Contrast { NoPreference, More, Null }?（可选） 新增于：v1.51#

    • ForcedColors enum ForcedColors { Active, None, Null }?（可选） 新增于：v1.15#

    • Media enum Media { Screen, Print, Null }?（可选） 新增于：v1.9#

      更改页面的 CSS 媒体类型。仅允许的值为 'Screen'、'Print' 和 'Null'。传入 'Null' 可禁用 CSS 媒体模拟。

    • ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }?（可选） 新增于：v1.12#

      模拟 'prefers-reduced-motion' 媒体特性，支持的值为 'reduce'、'no-preference'。传入 null 可禁用减少动画模拟。

返回值

EvaluateAsync​

在 v1.9 之前添加 page.EvaluateAsync

返回 expression 调用的值。

如果传递给 Page.EvaluateAsync() 的函数返回一个 Promise，则 Page.EvaluateAsync() 将等待该 Promise 解决并返回其值。

如果传递给 Page.EvaluateAsync() 的函数返回一个非 Serializable 值，则 Page.EvaluateAsync() 解析为 undefined。Playwright 还支持传输一些 JSON 无法序列化的其他值：-0、NaN、Infinity、-Infinity。

用法

向 expression 传递参数：

var result = await page.EvaluateAsync<int>("([x, y]) => Promise.resolve(x * y)", new[] { 7, 8 });
Console.WriteLine(result);

也可以传入字符串而不是函数：

Console.WriteLine(await page.EvaluateAsync<int>("1 + 2")); // 输出 "3"

ElementHandle 实例可以作为参数传递给 Page.EvaluateAsync()：

var bodyHandle = await page.EvaluateAsync("document.body");
var html = await page.EvaluateAsync<string>("([body, suffix]) => body.innerHTML + suffix", new object [] { bodyHandle, "hello" });
await bodyHandle.DisposeAsync();

参数

  • expression string#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument?（可选）#

    传递给 expression 的可选参数。

返回值

  • [object]#

EvaluateHandleAsync​

在 v1.9 之前添加 page.EvaluateHandleAsync

以 JSHandle 的形式返回 expression 调用的值。

Page.EvaluateAsync() 和 Page.EvaluateHandleAsync() 之间的唯一区别在于，Page.EvaluateHandleAsync() 返回 JSHandle。

如果传递给 Page.EvaluateHandleAsync() 的函数返回一个 Promise，则 Page.EvaluateHandleAsync() 将等待该 Promise 解决并返回其值。

用法​

// window 对象的句柄。
var aWindowHandle = await page.EvaluateHandleAsync("() => Promise.resolve(window)");

也可以传入字符串，而非函数：

var docHandle = await page.EvaluateHandleAsync("document"); // `document` 的句柄

JSHandle 实例可以作为参数传递给 Page.EvaluateHandleAsync()：

var handle = await page.EvaluateHandleAsync("() => document.body");
var resultHandle = await page.EvaluateHandleAsync("([body, suffix]) => body.innerHTML + suffix", new object[] { handle, "hello" });
Console.WriteLine(await resultHandle.JsonValueAsync<string>());
await resultHandle.DisposeAsync();

参数​

  • expression string#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为函数，则会自动调用该函数。

  • arg EvaluationArgument?（可选）#

    传递给 expression 的可选参数。

返回值​

ExposeBindingAsync​

在 v1.9 之前添加 page.ExposeBindingAsync

此方法会在该页面每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数会执行 callback 并返回一个 Promise，该 Promise 会解析为 callback 的返回值。如果 callback 返回一个 Promise，则会等待该 Promise 完成。

callback 函数的第一个参数包含有关调用者的信息：{ browserContext: BrowserContext, page: Page, frame: Frame }。

有关作用于上下文范围的版本，请参阅 BrowserContext.ExposeBindingAsync()。

备注

通过 Page.ExposeBindingAsync() 安装的函数在导航后仍然有效。

用法​

以下是一个将页面 URL 暴露给页面中所有框架的示例：

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

class PageExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Webkit.LaunchAsync(new()
        {
            Headless = false,
        });
        var page = await browser.NewPageAsync();

        await page.ExposeBindingAsync("pageUrl", (source) => source.Page.Url);
        await page.SetContentAsync("<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.pageURL();\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>");

        await page.ClickAsync("button");
    }
}

参数​

  • name string#

    window 对象上函数的名称。

  • callback Action<BindingSource, T, [TResult]>#

    将在 Playwright 上下文中调用的回调函数。

  • options PageExposeBindingOptions?（可选）

    • Handle bool?（可选）#

      已弃用

      此选项将来会被移除。

      是否将参数作为句柄传递，而不是按值传递。传递句柄时，仅支持一个参数。按值传递时，支持多个参数。

返回值

ExposeFunctionAsync​

在 v1.9 之前添加 page.ExposeFunctionAsync

此方法会在页面中每个框架的 window 对象上添加一个名为 name 的函数。调用该函数时，它会执行 callback 并返回一个 Promise，该 Promise 会解析为 callback 的返回值。

如果 callback 返回一个 Promise，则会等待该 Promise 完成。

有关上下文范围内的暴露函数，请参阅 BrowserContext.ExposeFunctionAsync()。

备注

通过 Page.ExposeFunctionAsync() 安装的函数在导航后仍然有效。

用法​

以下是向页面添加 sha256 函数的示例：

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

class PageExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Webkit.LaunchAsync(new()
        {
            Headless = false
        });
        var page = await browser.NewPageAsync();

        await page.ExposeFunctionAsync("sha256", (string input) =>
        {
            return Convert.ToBase64String(
                SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));
        });

        await page.SetContentAsync("<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>");

        await page.ClickAsync("button");
        Console.WriteLine(await page.TextContentAsync("div"));
    }
}

参数​

  • name string#

    window 对象上函数的名称。

  • callback Action<T, [TResult]>#

    将在 Playwright 上下文中调用的回调函数。

返回值​

Frame​

在 v1.9 之前添加 page.Frame

返回与指定条件匹配的框架。必须指定 name 或 url。

用法

var frame = page.Frame("frame-name");
var frame = page.FrameByUrl(".*domain.*");

参数

  • name string 添加于：v1.9#

    iframe 的 name 属性中指定的框架名称。

返回值

FrameByUrl​

添加于：v1.9 page.FrameByUrl

返回与 URL 匹配的框架。

用法

Page.FrameByUrl(url);

参数

  • url string | Regex | Func<string, bool>#

    一个通配符模式、正则表达式模式或接收框架 url 作为 URL 对象的谓词。

返回值

FrameLocator​

添加于：v1.17 page.FrameLocator

在处理 iframe 时，可以创建一个框架定位器，它将进入 iframe 并允许在该 iframe 中选择元素。

使用方法​

以下代码片段在 ID 为 my-frame 的 iframe 中定位文本为 "Submit" 的元素，例如 <iframe id="my-frame">：

var locator = page.FrameLocator("#my-iframe").GetByText("Submit");
await locator.ClickAsync();

参数​

  • selector string# 解析 DOM 元素时使用的选择器。

返回值​

Frames​

在 v1.9 之前添加page.Frames 附加到页面的所有框架的数组。

使用方法​

Page.Frames

返回值​

GetByAltText​

添加于：v1.27page.GetByAltText 允许通过元素的替代文本（alt text）定位元素。

使用方法​

例如，此方法将通过替代文本 "Playwright logo" 找到图像：

<img alt='Playwright logo'>
await page.GetByAltText("Playwright logo").ClickAsync();

参数

  • text string | Regex#

    用于定位元素的文本。

  • options PageGetByAltTextOptions?（可选）

    • Exact bool?（可选）#

      是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值

GetByLabel​

新增于：v1.27 page.GetByLabel

允许通过关联的 <label> 或 aria-labelledby 元素的文本，或通过 aria-label 属性来定位输入元素。

用法

例如，此方法将在以下 DOM 中通过标签“Username”和“Password”查找输入框：

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
await page.GetByLabel("Username").FillAsync("john");
await page.GetByLabel("Password").FillAsync("secret");

参数

  • text string | Regex#

    用于定位元素的文本。

  • options PageGetByLabelOptions?（可选）

    • Exact bool?（可选）#

      是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值

GetByPlaceholder​

新增于：v1.27 page.GetByPlaceholder

允许通过占位符文本定位输入元素。

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="name@example.com" />

你可以在通过占位符文本定位输入框后填充内容：

await page
    .GetByPlaceholder("name@example.com")
    .FillAsync("playwright@microsoft.com");

参数

  • text string | Regex#

    用于定位元素的文本。

  • options PageGetByPlaceholderOptions?（可选）

    • Exact bool?（可选）#

      是否查找完全匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，完全匹配仍会修剪空白字符。

返回值

GetByRole​

新增于：v1.27 page.GetByRole

允许通过元素的 ARIA 角色、ARIA 属性 和 可访问名称 来定位元素。

用法

考虑以下 DOM 结构。

<h3>注册</h3>
<label>
  <input type="checkbox" /> 订阅
</label>
<br/>
<button>提交</button>

你可以通过每个元素的隐式角色来定位它们：

await Expect(Page
    .GetByRole(AriaRole.Heading, new() { Name = "注册" }))
    .ToBeVisibleAsync();

await page
    .GetByRole(AriaRole.Checkbox, new() { Name = "订阅" })
    .CheckAsync();

await page
    .GetByRole(AriaRole.Button, new() {
        NameRegex = new Regex("提交", RegexOptions.IgnoreCase)
    })
    .ClickAsync();

参数

  • role enum AriaRole { Alert, Alertdialog, Application, Article, Banner, Blockquote, Button, Caption, Cell, Checkbox, Code, Columnheader, Combobox, Complementary, Contentinfo, Definition, Deletion, Dialog, Directory, Document, Emphasis, Feed, Figure, Form, Generic, Grid, Gridcell, Group, Heading, Img, Insertion, Link, List, Listbox, Listitem, Log, Main, Marquee, Math, Meter, Menu, Menubar, Menuitem, Menuitemcheckbox, Menuitemradio, Navigation, None, Note, Option, Paragraph, Presentation, Progressbar, Radio, Radiogroup, Region, Row, Rowgroup, Rowheader, Scrollbar, Search, Searchbox, Separator, Slider, Spinbutton, Status, Strong, Subscript, Superscript, Switch, Tab, Table, Tablist, Tabpanel, Term, Textbox, Time, Timer, Toolbar, Tooltip, Tree, Treegrid, Treeitem }#

    必需的 ARIA 角色。

  • options PageGetByRoleOptions?（可选）

    • Checked bool?（可选）#

      通常由 aria-checked 或原生 <input type=checkbox> 控件设置的属性。

      了解更多关于 aria-checked 的信息。

    • Disabled bool?（可选）#

      通常由 aria-disabled 或 disabled 设置的属性。

      备注

      与大多数其他属性不同，disabled 会通过 DOM 层次结构继承。了解更多关于 aria-disabled 的信息。

    • Exact bool?（可选） 添加于：v1.28#

      Name|NameRegex 是否完全匹配：区分大小写且匹配整个字符串。默认为 false。当 Name|NameRegex 是正则表达式时，此选项将被忽略。请注意，完全匹配仍会修剪空白字符。

    • Expanded bool?（可选）#

      通常由 aria-expanded 设置的属性。

      了解更多关于 aria-expanded 的信息。

    • IncludeHidden bool?（可选）#

      控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（如 ARIA 定义）会被角色选择器匹配。

      了解更多关于 aria-hidden 的信息。

    • Level int?（可选）#

      通常用于 heading、listitem、row、treeitem 角色的数字属性，对于 <h1>-<h6> 元素有默认值。

      了解更多关于 aria-level 的信息。

    • Name|NameRegex string? | Regex?（可选）#

      用于匹配 可访问名称 的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 Exact 来控制此行为。

      了解更多关于 可访问名称 的信息。

    • Pressed bool?（可选）#

      通常由 aria-pressed 设置的属性。

      了解更多关于 aria-pressed 的信息。

    • Selected bool?（可选）#

      通常由 aria-selected 设置的属性。

      了解更多关于 aria-selected 的信息。

返回值

详细信息

角色选择器不会替代可访问性审计和一致性测试，而是提供有关 ARIA 指南的早期反馈。

许多 HTML 元素都有一个隐式的定义角色，角色选择器可以识别该角色。你可以在此处找到所有支持的角色。ARIA 指南不建议通过将 role 和 / 或 aria-* 属性设置为默认值来重复隐式角色和属性。

GetByTestId​

新增于：v1.27 page.GetByTestId

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

<button data-testid="directions">Itinéraire</button>

你可以通过其测试 ID 定位该元素：

await page.GetByTestId("directions").ClickAsync();

参数

返回值

详细信息

默认情况下，data-testid 属性用作测试 ID。如有必要，可使用 Selectors.SetTestIdAttribute() 配置不同的测试 ID 属性。

GetByText​

新增于：v1.27 page.GetByText

允许定位包含给定文本的元素。

另请参阅 Locator.Filter()，它允许通过其他条件（如可访问角色）进行匹配，然后按文本内容进行筛选。

用法

考虑以下 DOM 结构：

<div>Hello <span>world</span></div>
<div>Hello</div>

你可以通过文本子字符串、精确字符串或正则表达式进行定位：

// 匹配 <span>
page.GetByText("world");

// 匹配第一个 <div>
page.GetByText("Hello world");

// 匹配第二个 <div>
page.GetByText("Hello", new() { Exact = true });

// 匹配两个 <div>
page.GetByText(new Regex("Hello"));

// 匹配第二个 <div>
page.GetByText(new Regex("^hello$", RegexOptions.IgnoreCase));

参数

  • text string | Regex#

    用于定位元素的文本。

  • options PageGetByTextOptions?（可选）

    • Exact bool?（可选）#

      是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会修剪空白字符。

返回值

详情​

即使是精确匹配，按文本匹配也总会对空白字符进行规范化处理。例如，将多个空格合并为一个，将换行符转换为空格，并忽略前导和尾随的空白字符。

类型为 button 和 submit 的输入元素是通过其 value 而不是文本内容进行匹配的。例如，按文本 "登录" 定位会匹配 <input type=button value="登录">。

GetByTitle​

添加于：v1.27 page.GetByTitle

允许通过元素的 title 属性定位元素。

用法​

考虑以下 DOM 结构。

<span title='问题数量'>25 个问题</span>

你可以在通过标题文本定位到问题数量后进行检查：

await Expect(Page.GetByTitle("问题数量")).toHaveText("25 个问题");

参数​

  • text string | Regex#

    用于定位元素的文本。

  • options PageGetByTitleOptions?（可选）

    • Exact bool?（可选）#

      是否查找精确匹配项：区分大小写且为全字符串匹配。默认为 false。通过正则表达式定位时将忽略此选项。请注意，精确匹配仍会去除空白字符。

返回值​

GoBackAsync​

在 v1.9 之前添加 page.GoBackAsync

返回主资源响应。如果存在多次重定向，导航将使用最后一次重定向的响应来解析。如果无法返回上一页，则返回 null。

导航到历史记录中的上一页。

用法

await Page.GoBackAsync(options);

参数

  • options PageGoBackOptions?（可选）

    • Timeout [float]?（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#

      何时视为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，视为操作完成。
      • 'load' - 当 load 事件触发时，视为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。请勿在测试中使用此方法，应依靠 Web 断言来评估准备情况。
      • 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

GoForwardAsync​

在 v1.9 之前添加 page.GoForwardAsync

返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。如果无法向前导航，则返回 null。

导航到历史记录中的下一页。

用法

await Page.GoForwardAsync(options);

参数

  • options PageGoForwardOptions?（可选）

    • Timeout [float]?（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#

      何时视为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，视为操作完成。
      • 'load' - 当 load 事件触发时，视为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。请勿在测试中使用此方法，应依赖 Web 断言来评估准备情况。
      • 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

GotoAsync​

在 v1.9 之前添加 page.GotoAsync

返回主资源响应。如果发生多次重定向，导航将使用第一个非重定向响应来解析。

在以下情况下，该方法将抛出错误：

  • 存在 SSL 错误（例如自签名证书的情况）。
  • 目标 URL 无效。
  • 导航期间超过了 Timeout。
  • 远程服务器无响应或无法访问。
  • 主资源加载失败。

当远程服务器返回任何有效的 HTTP 状态码时，该方法不会抛出错误，包括 404 “未找到” 和 500 “内部服务器错误”。此类响应的状态码可以通过调用 Response.Status 来获取。

备注

该方法要么抛出错误，要么返回主资源响应。唯一的例外是导航到 about:blank 或导航到具有不同哈希值的相同 URL，这种情况下将成功并返回 null。

备注

无头模式不支持导航到 PDF 文档。请参阅 上游问题。

用法

await Page.GotoAsync(url, options);

参数

  • url string#

    要导航到的页面 URL。该 URL 应包含协议，例如 https://。如果通过上下文选项提供了 BaseURL，并且传入的 URL 是一个路径，则会通过 new URL() 构造函数进行合并。

  • options PageGotoOptions?（可选）

    • Referer string?（可选）#

      Referer 标头值。如果提供了该值，它将优先于通过 Page.SetExtraHTTPHeadersAsync() 设置的 Referer 标头值。

    • Timeout [float]?（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#

      何时认为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作完成。不要在测试中使用此方法，应依赖 Web 断言来评估就绪状态。
      • 'commit' - 当接收到网络响应且文档开始加载时，认为操作完成。

返回值

IsClosed​

在 v1.9 之前添加 page.IsClosed

表示页面已关闭。

用法

Page.IsClosed

返回值

Locator​

添加于：v1.14 page.Locator

此方法返回一个元素定位器，可用于在此页面/框架上执行操作。定位器会在执行操作前立即解析为元素，因此对同一定位器执行的一系列操作实际上可能在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构发生了变化，就会出现这种情况。

详细了解定位器。

用法

Page.Locator(selector, options);

参数

  • selector string#

    解析 DOM 元素时使用的选择器。

  • options PageLocatorOptions?（可选）

    • Has Locator?（可选）#

      将方法的结果范围缩小到包含与该相对定位器匹配的元素。例如，有 text=Playwright 的 article 匹配 <article><div>Playwright</div></article>。

      内部定位器 必须相对于 外部定位器，并且从外部定位器匹配的位置开始查询，而不是从文档根开始。例如，在 <article><content><div>Playwright</div></content></article> 中可以找到有 div 的 content。但是，查找有 article div 的 content 会失败，因为内部定位器必须是相对的，并且不应使用 content 之外的任何元素。

      请注意，外部和内部定位器必须属于同一框架。内部定位器不能包含 FrameLocator。

    • HasNot Locator?（可选） 新增于：v1.33#

      匹配不包含与内部定位器匹配的元素的元素。内部定位器是相对于外部定位器进行查询的。例如，没有 div 的 article 匹配 <article><span>Playwright</span></article>。

      请注意，外部和内部定位器必须属于同一框架。内部定位器不能包含 FrameLocator。

    • HasNotText|HasNotTextRegex string? | Regex?（可选） 新增于：v1.33#

      匹配在内部某个位置（可能在子元素或后代元素中）不包含指定文本的元素。传入 string 时，匹配不区分大小写并搜索子字符串。

    • HasText|HasTextRegex string? | Regex?（可选）#

      匹配在内部某个位置（可能在子元素或后代元素中）包含指定文本的元素。传入 string 时，匹配不区分大小写并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

MainFrame​

在 v1.9 之前添加 page.MainFrame

页面的主框架。可以确保页面有一个在导航期间持续存在的主框架。

用法

Page.MainFrame

返回值

OpenerAsync​

在 v1.9 之前添加 page.OpenerAsync

返回弹出页面的打开者，其他页面返回 null。如果打开者已经关闭，则返回 null。

用法

await Page.OpenerAsync();

返回值

PauseAsync​

添加于：v1.9 page.PauseAsync

暂停脚本执行。Playwright 将停止执行脚本，并等待用户按下页面覆盖层中的“恢复”按钮，或在 DevTools 控制台中调用 playwright.resume()。

用户可以在暂停时检查选择器或执行手动步骤。恢复将从暂停的位置继续运行原始脚本。

备注

此方法要求 Playwright 以有头模式启动，Headless 选项为 false。

用法

await Page.PauseAsync();

返回值

PdfAsync​

在 v1.9 之前添加 page.PdfAsync

返回 PDF 缓冲区。

page.pdf() 使用 print CSS 媒体生成页面的 PDF。要使用 screen 媒体生成 PDF，请在调用 page.pdf() 之前调用 Page.EmulateMediaAsync()：

备注

默认情况下，page.pdf() 会生成经过颜色修改以适合打印的 PDF。使用 -webkit-print-color-adjust 属性可强制呈现精确的颜色。

用法

// 使用“screen”媒体类型生成 PDF
await page.EmulateMediaAsync(new() { Media = Media.Screen });
await page.PdfAsync(new() { Path = "page.pdf" });

Width、Height 和 Margin 选项接受带单位的值。无单位的值将被视为像素。

以下是一些示例：

  • page.pdf({width: 100}) - 将宽度设置为 100 像素进行打印
  • page.pdf({width: '100px'}) - 将宽度设置为 100 像素进行打印
  • page.pdf({width: '10cm'}) - 将宽度设置为 10 厘米进行打印。

所有可能的单位有：

  • px - 像素
  • in - 英寸
  • cm - 厘米
  • mm - 毫米

Format 选项有：

  • Letter：8.5 英寸 x 11 英寸
  • Legal：8.5 英寸 x 14 英寸
  • Tabloid：11 英寸 x 17 英寸
  • Ledger：17 英寸 x 11 英寸
  • A0：33.1 英寸 x 46.8 英寸
  • A1：23.4 英寸 x 33.1 英寸
  • A2：16.54 英寸 x 23.4 英寸
  • A3：11.7 英寸 x 16.54 英寸
  • A4：8.27 英寸 x 11.7 英寸
  • A5：5.83 英寸 x 8.27 英寸
  • A6：4.13 英寸 x 5.83 英寸

:::注意

HeaderTemplate 和 FooterTemplate 标记有以下限制：> 1. 模板内的脚本标签不会被求值。> 2. 模板内无法看到页面样式。 :::

参数

  • options PagePdfOptions?（可选）

    • DisplayHeaderFooter bool?（可选）#

      显示页眉和页脚。默认为 false。

    • FooterTemplate string?（可选）#

      打印页脚的 HTML 模板。格式应与 HeaderTemplate 相同。

    • Format string?（可选）#

      纸张格式。如果设置了此选项，则优先于 Width 或 Height 选项。默认为 “Letter”。

    • HeaderTemplate string?（可选）#

      打印页眉的 HTML 模板。应为有效的 HTML 标记，并使用以下类将打印值注入其中：

      • 'date' 格式化的打印日期
      • 'title' 文档标题
      • 'url' 文档位置
      • 'pageNumber' 当前页码
      • 'totalPages' 文档中的总页数

    • Height string?（可选）#

      纸张高度，接受带单位的值。

    • Landscape bool?（可选）#

      纸张方向。默认为 false。

    • Margin Margin?（可选）#

      • Top string?（可选）

        上边距，接受带单位的值。默认为 0。

      • Right string?（可选）

        右边距，接受带单位的值。默认为 0。

      • Bottom string?（可选）

        下边距，接受带单位的值。默认为 0。

      • Left string?（可选）

        左边距，接受带单位的值。默认为 0。

      纸张边距，默认为无。

    • Outline bool?（可选） 新增于：v1.42#

      是否将文档大纲嵌入到 PDF 中。默认为 false。

    • PageRanges string?（可选）#

      要打印的纸张范围，例如 “1-5, 8, 11-13”。默认为空字符串，表示打印所有页面。

    • Path string?（可选）#

      保存 PDF 的文件路径。如果 Path 是相对路径，则相对于当前工作目录进行解析。如果未提供路径，则不会将 PDF 保存到磁盘。

    • PreferCSSPageSize bool?（可选）#

      优先使用页面中声明的任何 CSS @page 尺寸，而不是 Width、Height 或 Format 选项中声明的尺寸。默认为 false，这将缩放内容以适应纸张大小。

    • PrintBackground bool?（可选）#

      打印背景图形。默认为 false。

    • Scale [float]?（可选）#

      网页渲染的缩放比例。默认为 1。缩放比例必须在 0.1 到 2 之间。

    • Tagged bool?（可选） 新增于：v1.42#

      是否生成带标记（可访问）的 PDF。默认为 false。

    • Width string?（可选）#

      纸张宽度，接受带单位的值。

返回值

  • byte[]#

ReloadAsync​

在 v1.9 之前添加 page.ReloadAsync

此方法重新加载当前页面，就像用户触发浏览器刷新一样。返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。

用法

await Page.ReloadAsync(options);

参数

  • options PageReloadOptions?（可选）

    • Timeout [float]?（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#

      何时视为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，视为操作完成。
      • 'load' - 当 load 事件触发时，视为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。不要在测试中使用此方法，应依靠 Web 断言来评估就绪状态。
      • 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

RemoveLocatorHandlerAsync​

新增于：v1.44 page.RemoveLocatorHandlerAsync

移除由 Page.AddLocatorHandlerAsync() 为特定定位器添加的所有定位器处理器。

用法

await Page.RemoveLocatorHandlerAsync(locator);

参数

返回值

RequestGCAsync​

新增于：v1.48 page.RequestGCAsync

请求页面执行垃圾回收。请注意，无法保证所有不可达对象都会被回收。

这对于帮助检测内存泄漏很有用。例如，如果你的页面有一个可能会泄漏的大对象 'suspect'，你可以使用 WeakRef 来检查它是否泄漏。

// 1. 在页面中，为“suspect”保存一个 WeakRef。
await Page.EvaluateAsync("globalThis.suspectWeakRef = new WeakRef(suspect)");
// 2. 请求垃圾回收。
await Page.RequestGCAsync();
// 3. 检查弱引用是否未解除对原始对象的引用。
Assert.True(await Page.EvaluateAsync("!globalThis.suspectWeakRef.deref()"));

用法

await Page.RequestGCAsync();

返回值

RouteAsync​

在 v1.9 之前添加 page.RouteAsync

路由功能允许修改页面发出的网络请求。

一旦启用路由，每个与 URL 模式匹配的请求都会暂停，除非继续、完成或中止该请求。

备注

如果响应是重定向，处理程序将仅针对第一个 URL 调用。

备注

Page.RouteAsync() 不会拦截由 Service Worker 拦截的请求。请参阅 此 问题。我们建议在使用请求拦截时，通过将 ServiceWorkers 设置为 'block' 来禁用 Service Worker。

备注

Page.RouteAsync() 不会拦截弹出页面的第一个请求。请改用 BrowserContext.RouteAsync()。

用法​

以下是一个简单的处理程序示例，它会中止所有图像请求：

var page = await browser.NewPageAsync();
await page.RouteAsync("**/*.{png,jpg,jpeg}", async r => await r.AbortAsync());
await page.GotoAsync("https://www.microsoft.com");

或者使用正则表达式模式实现相同功能的代码片段：

var page = await browser.NewPageAsync();
await page.RouteAsync(new Regex("(\\.png$)|(\\.jpg$)"), async r => await r.AbortAsync());
await page.GotoAsync("https://www.microsoft.com");

可以检查请求以决定路由操作。例如，模拟所有包含某些 POST 数据的请求，并保持其他所有请求不变：

await page.RouteAsync("/api/**", async r =>
{
  if (r.Request.PostData.Contains("my-string"))
      await r.FulfillAsync(new() { Body = "mocked-data" });
  else
      await r.ContinueAsync();
});

当请求同时匹配页面路由和浏览器上下文路由（通过 BrowserContext.RouteAsync() 设置）的处理程序时，页面路由优先。

要移除路由及其处理程序，可以使用 Page.UnrouteAsync()。

备注

启用路由会禁用 HTTP 缓存。

参数

  • url string | Regex | Func<string, bool>#

    一个通配符模式、正则表达式模式或接收 URL 的谓词，用于在路由期间进行匹配。如果在上下文选项中设置了 BaseURL，并且提供的 URL 是一个不以 * 开头的字符串，则会使用 new URL() 构造函数进行解析。

  • handler Action<Route>#

    用于路由请求的处理函数。

  • options PageRouteOptions?（可选）

    • Times int?（可选） 新增于：v1.15#

      路由应使用的次数。默认情况下，每次都会使用。

返回值

RouteFromHARAsync​

新增于：v1.23 page.RouteFromHARAsync

如果指定了该方法，页面中发起的网络请求将从 HAR 文件中提供服务。了解更多关于 从 HAR 重放 的信息。

Playwright 不会从 HAR 文件中提供由 Service Worker 拦截的请求。请参阅 此 问题。我们建议在使用请求拦截时，通过将 ServiceWorkers 设置为 'block' 来禁用 Service Worker。

用法

await Page.RouteFromHARAsync(har, options);

参数

  • har string#

    包含预先录制的网络数据的 HAR 文件的路径。如果 path 是相对路径，则相对于当前工作目录进行解析。

  • options PageRouteFromHAROptions? （可选）

    • NotFound enum HarNotFound { Abort, Fallback }? （可选）#

      • 如果设置为 abort，在 HAR 文件中找不到的任何请求都将被中止。
      • 如果设置为 fallback，缺失的请求将被发送到网络。

      默认值为 abort。

    • Update bool? （可选）#

      如果指定，则使用实际网络信息更新给定的 HAR，而不是从文件提供服务。调用 BrowserContext.CloseAsync() 时，文件将写入磁盘。

    • UpdateContent enum RouteFromHarUpdateContentPolicy { Embed, Attach }? （可选） 新增于：v1.32#

      用于控制资源内容管理的可选设置。如果指定 attach，资源将作为单独的文件或 ZIP 存档中的条目持久化。如果指定 embed，内容将内联存储在 HAR 文件中。

    • UpdateMode enum HarMode { Full, Minimal }? （可选） 新增于：v1.32#

      设置为 minimal 时，仅记录从 HAR 进行路由所需的信息。这将省略大小、时间、页面、cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时不会使用。默认值为 minimal。

    • Url|UrlRegex string? | Regex? （可选）#

      用于匹配请求 URL 的通配符模式、正则表达式或谓词。只有 URL 与模式匹配的请求才会从 HAR 文件提供服务。如果未指定，所有请求都将从 HAR 文件提供服务。

返回值

RouteWebSocketAsync​

新增于：v1.48 page.RouteWebSocketAsync

此方法允许修改页面发起的 WebSocket 连接。

请注意，只有在此方法调用后创建的 WebSocket 才会被路由。建议在导航页面之前调用此方法。

用法

以下是一个简单模拟的示例，它响应单个消息。有关更多详细信息和示例，请参阅 WebSocketRoute。

await page.RouteWebSocketAsync("/ws", ws => {
  ws.OnMessage(frame => {
    if (frame.Text == "request")
      ws.Send("response");
  });
});

参数

返回值

RunAndWaitForConsoleMessageAsync​

新增于：v1.9 page.RunAndWaitForConsoleMessageAsync

执行操作并等待页面记录 ConsoleMessage。如果提供了谓词，则会将 ConsoleMessage 值传递给 predicate 函数，并等待 predicate(message) 返回真值。如果在触发 Page.Console 事件之前页面关闭，则会抛出错误。

用法

await Page.RunAndWaitForConsoleMessageAsync(action, options);

参数

  • action Func<Task> 新增于：v1.12#

    触发事件的操作。

  • options PageRunAndWaitForConsoleMessageOptions? （可选）

返回值

WaitForConsoleMessageAsync​

新增于：v1.9 page.WaitForConsoleMessageAsync

执行操作并等待页面记录 ConsoleMessage。如果提供了断言函数 predicate，它会将 ConsoleMessage 值传入 predicate 函数，并等待 predicate(message) 返回真值。如果在触发 Page.Console 事件之前页面关闭，将会抛出错误。

用法

await Page.WaitForConsoleMessageAsync(action, options);

参数

  • options PageRunAndWaitForConsoleMessageOptions?（可选）

返回值

RunAndWaitForDownloadAsync​

新增于：v1.9 page.RunAndWaitForDownloadAsync

执行操作并等待新的 Download。如果提供了谓词，它会将 Download 值传递给 predicate 函数，并等待 predicate(download) 返回真值。如果在下载事件触发之前页面关闭，则会抛出错误。

用法

await Page.RunAndWaitForDownloadAsync(action, options);

参数

  • action Func<Task> 新增于：v1.12#

    触发事件的操作。

  • options PageRunAndWaitForDownloadOptions? （可选）

    • Predicate Func<Download?, bool> （可选）#

      接收 Download 对象，并在等待条件满足时解析为真值。

    • Timeout [float]? （可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 进行更改。

返回值

WaitForDownloadAsync​

新增于：v1.9 page.WaitForDownloadAsync

执行操作并等待新的 Download。如果提供了谓词函数，则会将 Download 值传入 predicate 函数，并等待 predicate(download) 返回真值。如果在下载事件触发之前页面关闭，则会抛出错误。

用法

await Page.WaitForDownloadAsync(action, options);

参数

  • options PageRunAndWaitForDownloadOptions?（可选）

    • Predicate Func<Download?, bool>（可选）#

      接收 Download 对象，当等待条件满足时解析为真值。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

RunAndWaitForFileChooserAsync​

新增于：v1.9 page.RunAndWaitForFileChooserAsync

执行操作并等待创建新的 FileChooser。如果提供了 predicate，它会将 FileChooser 值传入 predicate 函数，并等待 predicate(fileChooser) 返回真值。如果在文件选择器打开之前页面关闭，将抛出错误。

用法

await Page.RunAndWaitForFileChooserAsync(action, options);

参数

  • action Func<Task> 新增于：v1.12#

    触发该事件的操作。

  • options PageRunAndWaitForFileChooserOptions? （可选）

    • Predicate Func<FileChooser?, bool> （可选）#

      接收 FileChooser 对象，并在等待条件满足时解析为真值。

    • Timeout [float]? （可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

WaitForFileChooserAsync​

新增于：v1.9 page.WaitForFileChooserAsync

执行操作并等待创建新的 FileChooser。如果提供了断言函数 predicate，它会将 FileChooser 值传递给 predicate 函数，并等待 predicate(fileChooser) 返回真值。如果在文件选择器打开之前页面关闭，将抛出错误。

用法

await Page.WaitForFileChooserAsync(action, options);

参数

  • options PageRunAndWaitForFileChooserOptions?（可选）

    • Predicate Func<FileChooser?, bool>（可选）#

      接收 FileChooser 对象，并在等待条件满足时解析为真值。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

RunAndWaitForPopupAsync​

新增于：v1.9 page.RunAndWaitForPopupAsync

执行操作并等待弹出的 Page。如果提供了断言函数 predicate，它会将 [Popup] 值传入 predicate 函数，并等待 predicate(page) 返回真值。如果在弹出事件触发之前页面关闭，将会抛出错误。

用法

await Page.RunAndWaitForPopupAsync(action, options);

参数

  • action Func<Task> 新增于：v1.12#

    触发事件的操作。

  • options PageRunAndWaitForPopupOptions? （可选）

    • Predicate Func<Page?, bool> （可选）#

      接收 Page 对象，当等待条件满足时返回真值。

    • Timeout [float]? （可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 更改。

返回值

WaitForPopupAsync​

新增于：v1.9 page.WaitForPopupAsync

执行操作并等待弹出的 Page。如果提供了断言函数 predicate，它会将 [Popup] 值传入 predicate 函数，并等待 predicate(page) 返回真值。如果在弹出事件触发之前页面关闭，将会抛出错误。

用法

await Page.WaitForPopupAsync(action, options);

参数

  • options PageRunAndWaitForPopupOptions?（可选）

    • Predicate Func<Page?, bool>（可选）#

      接收 Page 对象，当等待条件满足时解析为真值。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

RunAndWaitForRequestAsync​

在 v1.9 之前添加 page.RunAndWaitForRequestAsync

等待匹配的请求并返回它。有关事件的更多详细信息，请参阅 等待事件。

用法​

// 等待下一个具有指定 URL 的请求。
await page.RunAndWaitForRequestAsync(async () =>
{
    await page.GetByText("触发请求").ClickAsync();
}, "http://example.com/resource");

// 使用谓词的另一种方式。
await page.RunAndWaitForRequestAsync(async () =>
{
    await page.GetByText("触发请求").ClickAsync();
}, request => request.Url == "https://example.com" && request.Method == "GET");

参数​

  • action Func<Task> 添加于：v1.12#

    触发事件的操作。

  • urlOrPredicate string | Regex | Func<Request, bool>#

    请求 URL 字符串、正则表达式或接收 Request 对象的谓词。当通过上下文选项提供了 BaseURL 且传入的 URL 是路径时，它将通过 new URL() 构造函数进行合并。

  • options PageRunAndWaitForRequestOptions?（可选）

    • Timeout [float]?（可选）#

      最大等待时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 Page.SetDefaultTimeout() 方法更改。

返回值

WaitForRequestAsync​

在 v1.9 之前添加 page.WaitForRequestAsync

等待匹配的请求并返回它。有关事件的更多详细信息，请参阅等待事件。

用法

// 等待具有指定 URL 的下一个请求。
await page.RunAndWaitForRequestAsync(async () =>
{
    await page.GetByText("trigger request").ClickAsync();
}, "http://example.com/resource");

// 使用谓词的另一种方式。
await page.RunAndWaitForRequestAsync(async () =>
{
    await page.GetByText("trigger request").ClickAsync();
}, request => request.Url == "https://example.com" && request.Method == "GET");

参数

  • urlOrPredicate string | Regex | Func<Request, bool>#

    请求 URL 字符串、正则表达式或接收 Request 对象的谓词。当通过上下文选项提供了 BaseURL 且传入的 URL 是路径时，它会通过 new URL() 构造函数进行合并。

  • options PageRunAndWaitForRequestOptions?（可选）

    • Timeout [float]?（可选）#

      最大等待时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过使用 Page.SetDefaultTimeout() 方法更改。

返回值

RunAndWaitForRequestFinishedAsync​

新增于：v1.12 page.RunAndWaitForRequestFinishedAsync

执行操作并等待 Request 完成加载。如果提供了谓词，它会将 Request 值传入 predicate 函数，并等待 predicate(request) 返回真值。如果在触发 Page.RequestFinished 事件之前页面关闭，将抛出错误。

用法

await Page.RunAndWaitForRequestFinishedAsync(action, options);

参数

  • action Func<Task>#

    触发该事件的操作。

  • options PageRunAndWaitForRequestFinishedOptions?（可选）

    • Predicate Func<Request?, bool>（可选）#

      接收 Request 对象，当等待条件满足时解析为真值。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 进行更改。

返回值

WaitForRequestFinishedAsync​

新增于：v1.12 page.WaitForRequestFinishedAsync

执行操作并等待 Request 完成加载。如果提供了谓词，它会将 Request 值传递给 predicate 函数，并等待 predicate(request) 返回真值。如果在触发 Page.RequestFinished 事件之前页面关闭，将会抛出错误。

用法

await Page.WaitForRequestFinishedAsync(action, options);

参数

  • options PageRunAndWaitForRequestFinishedOptions?（可选）

    • Predicate Func<Request?, bool>（可选）#

      接收 Request 对象，当等待条件满足时解析为真值。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 来更改。

返回值

RunAndWaitForResponseAsync​

v1.9 之前添加 page.RunAndWaitForResponseAsync

返回匹配的响应。有关事件的更多详细信息，请参阅等待事件。

用法​

// 等待具有指定 URL 的下一个响应。
await page.RunAndWaitForResponseAsync(async () =>
{
    await page.GetByText("trigger response").ClickAsync();
}, "http://example.com/resource");

// 使用谓词的另一种方式。
await page.RunAndWaitForResponseAsync(async () =>
{
    await page.GetByText("trigger response").ClickAsync();
}, response => response.Url == "https://example.com" && response.Status == 200 && response.Request.Method == "GET");

参数​

  • action Func<Task> 新增于：v1.12#

    触发事件的操作。

  • urlOrPredicate string | Regex | Func<Response, bool>#

    请求 URL 字符串、正则表达式或接收 Response 对象的谓词。当通过上下文选项提供了 BaseURL 且传入的 URL 是一个路径时，它会通过 new URL() 构造函数进行合并。

  • options PageRunAndWaitForResponseOptions?（可选）

返回值

WaitForResponseAsync​

在 v1.9 之前添加 page.WaitForResponseAsync

返回匹配的响应。有关事件的更多详细信息，请参阅等待事件。

用法

// 等待具有指定 URL 的下一个响应。
await page.RunAndWaitForResponseAsync(async () =>
{
    await page.GetByText("trigger response").ClickAsync();
}, "http://example.com/resource");

// 使用谓词的另一种方式。
await page.RunAndWaitForResponseAsync(async () =>
{
    await page.GetByText("trigger response").ClickAsync();
}, response => response.Url == "https://example.com" && response.Status == 200 && response.Request.Method == "GET");

参数

返回值

RunAndWaitForWebSocketAsync​

新增于：v1.9 page.RunAndWaitForWebSocketAsync

执行操作并等待新的 WebSocket。如果提供了断言函数，它会将 WebSocket 值传入 predicate 函数，并等待 predicate(webSocket) 返回真值。如果在 WebSocket 事件触发之前页面关闭，将抛出错误。

用法

await Page.RunAndWaitForWebSocketAsync(action, options);

参数

  • action Func<Task> 新增于：v1.12#

    触发该事件的操作。

  • options PageRunAndWaitForWebSocketOptions? （可选）

    • Predicate Func<WebSocket?, bool> （可选）#

      接收 WebSocket 对象，当等待条件满足时，解析为真值。

    • Timeout [float]? （可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 进行更改。

返回值

WaitForWebSocketAsync​

新增于：v1.9 page.WaitForWebSocketAsync

执行操作并等待新的 WebSocket。如果提供了谓词，它会将 WebSocket 值传递给 predicate 函数，并等待 predicate(webSocket) 返回真值。如果在 WebSocket 事件触发之前页面关闭，将抛出错误。

用法

await Page.WaitForWebSocketAsync(action, options);

参数

  • options PageRunAndWaitForWebSocketOptions?（可选）

    • Predicate Func<WebSocket?, bool>（可选）#

      接收 WebSocket 对象，当等待条件满足时解析为真值。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可通过使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

RunAndWaitForWorkerAsync​

新增于：v1.9 page.RunAndWaitForWorkerAsync

执行操作并等待新的 Worker。如果提供了谓词，它会将 Worker 值传递给 predicate 函数，并等待 predicate(worker) 返回真值。如果在触发 worker 事件之前页面关闭，则会抛出错误。

用法

await Page.RunAndWaitForWorkerAsync(action, options);

参数

  • action Func<Task> 新增于：v1.12#

    触发该事件的操作。

  • options PageRunAndWaitForWorkerOptions? （可选）

    • Predicate Func<Worker?, bool> （可选）#

      接收 Worker 对象，当等待条件满足时返回真值。

    • Timeout [float]? （可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可通过 BrowserContext.SetDefaultTimeout() 更改。

返回值

WaitForWorkerAsync​

新增于：v1.9 page.WaitForWorkerAsync

执行操作并等待新的 Worker。如果提供了谓词，它会将 Worker 值传入 predicate 函数，并等待 predicate(worker) 返回真值。如果在触发 worker 事件之前页面关闭，则会抛出错误。

用法

await Page.WaitForWorkerAsync(action, options);

参数

  • options PageRunAndWaitForWorkerOptions?（可选）

    • Predicate Func<Worker?, bool>（可选）#

      接收 Worker 对象，当等待条件满足时解析为真值。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可通过 BrowserContext.SetDefaultTimeout() 更改。

返回值

ScreenshotAsync​

在 v1.9 之前添加 page.ScreenshotAsync

返回捕获的屏幕截图缓冲区。

用法

await Page.ScreenshotAsync(options);

参数

  • options PageScreenshotOptions?（可选）

    • Animations enum ScreenshotAnimations { Disabled, Allow }?（可选）#

      设置为"disabled"时，将停止 CSS 动画、CSS 过渡和 Web 动画。动画会根据其持续时间得到不同的处理：

      • 有限动画将快进到完成，因此它们将触发transitionend事件。
      • 无限动画将取消到初始状态，然后在截图后重新播放。

      默认值为"allow"，即不触动动画。

    • Caret enum ScreenshotCaret { Hide, Initial }?（可选）#

      设置为"hide"时，截图将隐藏文本插入符号。设置为"initial"时，文本插入符号的行为将不会改变。默认值为"hide"。

    • Clip Clip?（可选）#

      • X [float]

        裁剪区域左上角的 x 坐标

      • Y [float]

        裁剪区域左上角的 y 坐标

      • Width [float]

        裁剪区域的宽度

      • Height [float]

        裁剪区域的高度

      一个指定生成图像裁剪的对象。

    • FullPage bool?（可选）#

      为true时，将截取整个可滚动页面的屏幕截图，而不是当前可见的视口。默认值为false。

    • Mask IEnumerable?<Locator>（可选）#

      指定在截取屏幕截图时应屏蔽的定位器。被屏蔽的元素将覆盖一个粉色框#FF00FF（可通过 MaskColor 自定义），该框将完全覆盖其边框。屏蔽也适用于不可见元素，有关禁用此功能的信息，请参阅 仅匹配可见元素。

    • MaskColor string?（可选） 新增于：v1.35#

      以 CSS 颜色格式指定被屏蔽元素覆盖框的颜色。默认颜色为粉色#FF00FF。

    • OmitBackground bool?（可选）#

      隐藏默认的白色背景，并允许捕获带有透明度的屏幕截图。不适用于jpeg图像。默认值为false。

    • Path string?（可选）#

      保存图像的文件路径。屏幕截图类型将从文件扩展名推断得出。如果 Path 是相对路径，则将相对于当前工作目录进行解析。如果未提供路径，则图像不会保存到磁盘。

    • Quality int?（可选）#

      图像质量，取值范围为 0 到 100。不适用于png图像。

    • Scale enum ScreenshotScale { Css, Device }?（可选）#

      设置为"css"时，屏幕截图在页面上每个 CSS 像素将对应一个物理像素。对于高 DPI 设备，这将使屏幕截图保持较小。使用"device"选项将在每个设备像素上生成一个物理像素，因此高 DPI 设备的屏幕截图将大两倍甚至更大。

      默认值为"device"。

    • Style string?（可选） 新增于：v1.41#

      在进行屏幕截图时应用的样式表文本。在这里，您可以隐藏动态元素、使元素不可见或更改其属性，以帮助您创建可重复的屏幕截图。此样式表穿透 Shadow DOM 并应用于内部框架。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认值为30000（30 秒）。传递0以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Type enum ScreenshotType { Png, Jpeg }?（可选）#

      指定屏幕截图类型，默认值为png。

返回值

SetContentAsync​

在 v1.9 之前添加 page.SetContentAsync

此方法在内部调用 document.write()，继承其所有特定特性和行为。

用法

await Page.SetContentAsync(html, options);

参数

  • html string#

    要分配给页面的 HTML 标记。

  • options PageSetContentOptions?（可选）

    • Timeout [float]?（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#

      何时视为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当触发 DOMContentLoaded 事件时，视为操作完成。
      • 'load' - 当触发 load 事件时，视为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。不要在测试中使用此方法，应依赖 Web 断言来评估准备情况。
      • 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

SetDefaultNavigationTimeout​

在 v1.9 之前添加 page.SetDefaultNavigationTimeout

此设置将更改以下方法及相关快捷方式的默认最大导航时间：

备注

Page.SetDefaultNavigationTimeout() 优先于 Page.SetDefaultTimeout()、BrowserContext.SetDefaultTimeout() 和 BrowserContext.SetDefaultNavigationTimeout()。

用法

Page.SetDefaultNavigationTimeout(timeout);

参数

  • timeout [float]#

    最大导航时间（毫秒）

SetDefaultTimeout​

在 v1.9 之前添加 page.SetDefaultTimeout

此设置将更改所有接受 timeout 选项的方法的默认最长时间。

备注

Page.SetDefaultNavigationTimeout() 优先于 Page.SetDefaultTimeout()。

用法

Page.SetDefaultTimeout(timeout);

参数

  • timeout [float]#

    最长时间（毫秒）。传入 0 可禁用超时。

SetExtraHTTPHeadersAsync​

在 v1.9 之前添加 page.SetExtraHTTPHeadersAsync

额外的 HTTP 标头将随页面发起的每个请求一起发送。

备注

Page.SetExtraHTTPHeadersAsync() 不保证传出请求中标头的顺序。

用法

await Page.SetExtraHTTPHeadersAsync(headers);

参数

  • headers IDictionary<string, string>#

    一个对象，包含要随每个请求发送的其他 HTTP 标头。所有标头值都必须是字符串。

返回

SetViewportSizeAsync​

在 v1.9 之前添加 page.SetViewportSizeAsync

在单个浏览器中有多个页面的情况下，每个页面都可以有自己的视口大小。不过，Browser.NewContextAsync() 允许一次性为上下文中的所有页面设置视口大小（以及更多设置）。

Page.SetViewportSizeAsync() 会调整页面大小。许多网站并不期望手机改变大小，因此你应该在导航到页面之前设置视口大小。Page.SetViewportSizeAsync() 还会重置 screen 大小，如果你需要更好地控制这些属性，可以使用带有 screen 和 viewport 参数的 Browser.NewContextAsync()。

用法

var page = await browser.NewPageAsync();
await page.SetViewportSizeAsync(640, 480);
await page.GotoAsync("https://www.microsoft.com");

参数

  • width int 在 v1.10 中添加#

    页面宽度（以像素为单位）。

  • height int 在 v1.10 中添加#

    页面高度（以像素为单位）。

返回值

TitleAsync​

在 v1.9 之前添加 page.TitleAsync

返回页面的标题。

用法

await Page.TitleAsync();

返回值

UnrouteAsync​

在 v1.9 之前添加 page.UnrouteAsync

移除使用 Page.RouteAsync() 创建的路由。当未指定 handler 时，移除 url 的所有路由。

用法

await Page.UnrouteAsync(url, handler);

参数

  • url string | Regex | Func<string, bool>#

    一个全局模式、正则表达式模式或接收 URL 的谓词，用于在路由时进行匹配。

  • handler Action<Route?> (可选)#

    用于路由请求的可选处理函数。

返回值

UnrouteAllAsync​

添加于：v1.41 page.UnrouteAllAsync

移除使用 Page.RouteAsync() 和 Page.RouteFromHARAsync() 创建的所有路由。

用法

await Page.UnrouteAllAsync(options);

参数

  • options PageUnrouteAllOptions?（可选）

    • Behavior enum UnrouteBehavior { Wait, IgnoreErrors, Default }?（可选）#

      用于指定是否等待已在运行的处理程序，以及在处理程序抛出错误时的操作：

      • 'default' - 不等待当前处理程序调用（如果有）完成，如果未路由的处理程序抛出错误，可能会导致未处理的错误
      • 'wait' - 等待当前处理程序调用（如果有）完成
      • 'ignoreErrors' - 不等待当前处理程序调用（如果有）完成，未路由后处理程序抛出的所有错误将被静默捕获

返回值

Url​

在 v1.9 之前添加 page.Url

用法

Page.Url

返回值

Video​

在 v1.9 之前添加 page.Video

与此页面关联的视频对象。

用法

Page.Video

返回值

ViewportSize​

在 v1.9 之前添加 page.ViewportSize

用法

Page.ViewportSize

返回值

  • ViewportSize?#

    • width int

      页面宽度，单位为像素。

    • height int

      页面高度，单位为像素。

WaitForFunctionAsync​

在 v1.9 之前添加 page.WaitForFunctionAsync

当 expression 返回真值时返回。它解析为真值的 JSHandle。

用法

Page.WaitForFunctionAsync() 可用于观察视口大小变化：

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

class FrameExamples
{
  public static async Task WaitForFunction()
  {
    using var playwright = await Playwright.CreateAsync();
    await using var browser = await playwright.Webkit.LaunchAsync();
    var page = await browser.NewPageAsync();
    await page.SetViewportSizeAsync(50, 50);
    await page.MainFrame.WaitForFunctionAsync("window.innerWidth < 100");
  }
}

要将参数传递给 Page.WaitForFunctionAsync() 函数的谓词：

var selector = ".foo";
await page.WaitForFunctionAsync("selector => !!document.querySelector(selector)", selector);

参数

  • expression string#

    要在浏览器上下文中求值的 JavaScript 表达式。如果该表达式求值为一个函数，则会自动调用该函数。

  • arg EvaluationArgument?（可选）#

    传递给 expression 的可选参数。

  • options PageWaitForFunctionOptions?（可选）

    • PollingInterval [float]?（可选）#

      如果指定，则将其视为函数执行的时间间隔（毫秒）。默认情况下，如果未指定此选项，expression 将在 requestAnimationFrame 回调中执行。

    • Timeout [float]?（可选）#

      最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

返回值

WaitForLoadStateAsync​

在 v1.9 之前添加 page.WaitForLoadStateAsync

当达到所需的加载状态时返回。

当页面达到所需的加载状态（默认为 load）时，此操作将得到解决。调用此方法时，导航必须已经提交。如果当前文档已经达到所需状态，则立即解决。

备注

大多数情况下，不需要此方法，因为 Playwright 在每次操作前自动等待。

用法

await page.GetByRole(AriaRole.Button).ClickAsync(); // 点击触发导航。
await page.WaitForLoadStateAsync(); // 此 Promise 在 'load' 事件之后得到解决。
var popup = await page.RunAndWaitForPopupAsync(async () =>
{
    await page.GetByRole(AriaRole.Button).ClickAsync(); // 点击触发弹出窗口
});
// 等待 "DOMContentLoaded" 事件。
await popup.WaitForLoadStateAsync(LoadState.DOMContentLoaded);
Console.WriteLine(await popup.TitleAsync()); // 弹出窗口已准备好使用。

参数

  • state enum LoadState { Load, DOMContentLoaded, NetworkIdle }? （可选）#

    等待的可选加载状态，默认为 load。如果在加载当前文档时已经达到该状态，此方法将立即解析。可以是以下值之一：

    • 'load' - 等待 load 事件触发。
    • 'domcontentloaded' - 等待 DOMContentLoaded 事件触发。
    • 'networkidle' - 不推荐 等待至少 500 毫秒内没有网络连接。不要在测试中使用此方法，应依靠 Web 断言来评估是否准备就绪。

  • options PageWaitForLoadStateOptions? （可选）

返回值

WaitForURLAsync​

添加于：v1.11 page.WaitForURLAsync

等待主框架导航到给定的 URL。

用法

await page.ClickAsync("a.delayed-navigation"); // 点击链接将间接导致导航
await page.WaitForURLAsync("**/target.html");

参数

  • url string | Regex | Func<string, bool>#

    一个通配符模式、正则表达式模式或接收 URL 的谓词，用于在等待导航时进行匹配。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。

  • options PageWaitForURLOptions?（可选）

    • Timeout [float]?（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#

      何时视为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，视为操作完成。
      • 'load' - 当 load 事件触发时，视为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。不要在测试中使用此方法，应依靠 Web 断言来评估准备情况。
      • 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

Workers​

在 v1.9 之前添加 page.Workers

此方法返回与页面关联的所有专用 WebWorkers。

备注

这不包含 ServiceWorkers

用法

Page.Workers

返回值

属性​

APIRequest​

添加于：v1.16 page.APIRequest

与此页面关联的 API 测试辅助工具。此方法返回与页面上下文上的 BrowserContext.APIRequest 相同的实例。更多详细信息，请参阅 BrowserContext.APIRequest。

用法

Page.APIRequest

类型

Clock​

添加于：v1.45 page.Clock

Playwright 能够模拟时钟和时间流逝。

用法

Page.Clock

类型

Keyboard​

在 v1.9 之前添加 page.Keyboard

用法

Page.Keyboard

类型

Mouse​

在 v1.9 之前添加 page.Mouse

用法

Page.Mouse

类型

Touchscreen​

在 v1.9 之前添加 page.Touchscreen

用法

Page.Touchscreen

类型

事件​

事件 Close​

在 v1.9 之前添加 page.event Close

在页面关闭时触发。

用法

Page.Close += async (_, page) => {};

事件数据

事件 Console​

在 v1.9 之前添加 page.event Console

当页面内的 JavaScript 调用 console API 方法之一（例如 console.log 或 console.dir）时触发。

传递给 console.log 的参数可在 ConsoleMessage 事件处理程序参数中获取。

用法

page.Console += async (_, msg) =>
{
    foreach (var arg in msg.Args)
        Console.WriteLine(await arg.JsonValueAsync<object>());
};

await page.EvaluateAsync("console.log('hello', 5, { foo: 'bar' })");

事件数据

事件 Crash​

在 v1.9 之前添加 page.event Crash

在页面崩溃时触发。如果浏览器页面尝试分配过多内存，可能会崩溃。页面崩溃时，正在进行的和后续的操作将抛出异常。

处理崩溃最常见的方法是捕获异常：

try {
  // 点击过程中可能会发生崩溃。
  await page.ClickAsync("button");
  // 或者在等待事件时。
  await page.WaitForPopup();
} catch (PlaywrightException e) {
  // 页面崩溃时，异常消息中会包含 "crash"。
}

用法

Page.Crash += async (_, page) => {};

事件数据

event Dialog​

在 v1.9 之前添加 page.event Dialog

当 JavaScript 对话框（如 alert、prompt、confirm 或 beforeunload）出现时触发。监听器 必须 调用 Dialog.AcceptAsync() 或 Dialog.DismissAsync() 来处理对话框，否则页面将 冻结 等待对话框，诸如点击等操作将永远不会完成。

用法

page.RequestFailed += (_, request) =>
{
    Console.WriteLine(request.Url + " " + request.Failure);
};
备注

当不存在 Page.Dialog 或 BrowserContext.Dialog 监听器时，所有对话框将自动被取消。

事件数据

event DOMContentLoaded​

添加于：v1.9 page.event DOMContentLoaded

当 JavaScript 的 DOMContentLoaded 事件被派发时触发。

用法

Page.DOMContentLoaded += async (_, page) => {};

事件数据

event Download​

在 v1.9 之前添加 page.event Download

当附件下载开始时触发。用户可以通过传入的 Download 实例对下载的内容进行基本的文件操作。

用法

Page.Download += async (_, download) => {};

事件数据

event FileChooser​

新增于：v1.9 page.event FileChooser

当文件选择器应该出现时触发，例如点击 <input type=file> 之后。Playwright 可以通过使用 FileChooser.SetFilesAsync() 设置要上传的输入文件来响应此事件。

page.FileChooser += (_, fileChooser) =>
{
    fileChooser.SetFilesAsync(@"C:\temp\myfile.pdf");
};

用法

Page.FileChooser += async (_, fileChooser) => {};

事件数据

event FrameAttached​

新增于：v1.9 page.event FrameAttached

当一个框架附加时触发。

用法

Page.FrameAttached += async (_, frame) => {};

事件数据

event FrameDetached​

新增于：v1.9 page.event FrameDetached

当一个框架分离时触发。

用法

Page.FrameDetached += async (_, frame) => {};

事件数据

event FrameNavigated​

新增于：v1.9 page.event FrameNavigated

当一个框架导航到新的 URL 时触发。

用法

Page.FrameNavigated += async (_, frame) => {};

事件数据

event Load​

在 v1.9 之前新增 page.event Load

当 JavaScript 的 load 事件被派发时触发。

用法​

Page.Load += async (_, page) => {};

事件数据​

事件 PageError​

添加于：v1.9 page.event PageError

当页面内发生未捕获的异常时触发。

// 将所有未捕获的错误记录到终端
page.PageError += (_, exception) =>
{
  Console.WriteLine("Uncaught exception: " + exception);
};

用法​

Page.PageError += async (_, value) => {};

事件数据​

事件 Popup​

在 v1.9 之前添加 page.event Popup

当页面打开新标签页或窗口时触发。除了 BrowserContext.Page 事件外，也会触发此事件，但仅针对与该页面相关的弹出窗口。

页面最早在导航到初始 URL 时可用。例如，使用 window.open('http://example.com') 打开弹出窗口时，当对 “http://example.com” 的网络请求完成且其响应已开始在弹出窗口中加载时，将触发此事件。如果要路由/监听此网络请求，请分别使用 BrowserContext.RouteAsync() 和 BrowserContext.Request，而不是 Page 上的类似方法。

var popup = await page.RunAndWaitForPopupAsync(async () =>
{
    await page.GetByText("open the popup").ClickAsync();
});
Console.WriteLine(await popup.EvaluateAsync<string>("location.href"));
备注

使用 Page.WaitForLoadStateAsync() 等待页面进入特定状态（大多数情况下无需使用）。

用法​

Page.Popup += async (_, page) => {};

事件数据

event Request​

在 v1.9 之前添加 page.event Request

当页面发出请求时触发。request 对象是只读的。若要拦截并修改请求，请参阅 Page.RouteAsync() 或 BrowserContext.RouteAsync()。

用法

Page.Request += async (_, request) => {};

事件数据

event RequestFailed​

添加于：v1.9 page.event RequestFailed

当请求失败时触发，例如因超时而失败。

备注

从 HTTP 角度来看，HTTP 错误响应（如 404 或 503）仍属于成功响应，因此请求将通过 Page.RequestFinished 事件完成，而不是通过 Page.RequestFailed 事件。只有当客户端无法从服务器获取 HTTP 响应时（例如由于网络错误 net::ERR_FAILED），请求才会被视为失败。

用法

Page.RequestFailed += async (_, request) => {};

事件数据

event RequestFinished​

添加于：v1.9 page.event RequestFinished

当请求在下载响应体后成功完成时触发。对于成功的响应，事件顺序为 request、response 和 requestfinished。

用法

Page.RequestFinished += async (_, request) => {};

事件数据

event Response​

在 v1.9 之前添加 page.event Response

当请求接收到 response 的状态和标头时触发。对于成功的响应，事件顺序为 request、response 和 requestfinished。

用法

Page.Response += async (_, response) => {};

事件数据

event WebSocket​

添加于：v1.9 page.event WebSocket

当发送 WebSocket 请求时触发。

用法

Page.WebSocket += async (_, webSocket) => {};

事件数据

event Worker​

在 v1.9 之前添加 page.event Worker

当页面生成专用的 WebWorker 时触发。

用法

Page.Worker += async (_, worker) => {};

事件数据

已弃用​

Accessibility​

在 v1.9 之前添加 page.Accessibility
已弃用

不建议使用此属性。如果需要测试页面可访问性，请使用 Axe 等其他库。有关与 Axe 集成的信息，请参阅我们的 Node.js 指南。

用法

Page.Accessibility

类型

CheckAsync​

在 v1.9 之前添加 page.CheckAsync
不推荐使用

请改用基于定位器的 Locator.CheckAsync()。了解更多关于 定位器 的信息。

此方法通过执行以下步骤，选中与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，则此方法将抛出异常。如果该元素已经被选中，则此方法立即返回。
  3. 等待对匹配元素的可操作性检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则整个操作将重试。
  4. 如有需要，将元素滚动到可见区域。
  5. 使用 Page.Mouse 在元素中心点击。
  6. 确保该元素现在已被选中。如果没有，则此方法将抛出异常。

如果在指定的 Timeout 时间内，所有步骤未能全部完成，此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。

用法

await Page.CheckAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageCheckOptions? （可选）

    • Force bool? （可选）#

      是否绕过可操作性检查。默认为 false。

    • NoWaitAfter bool? （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? （可选） 新增于：v1.11#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。

    • Strict bool? （可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]? （可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool? （可选） 新增于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这在等待元素准备好进行操作但不执行操作时很有用。

返回值

ClickAsync​

在 v1.9 之前添加 page.ClickAsync
不推荐使用

请改用基于定位器的 Locator.ClickAsync()。了解更多关于 定位器 的信息。

此方法通过执行以下步骤，点击与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
  2. 对匹配的元素进行 可操作性 检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则整个操作将重试。
  3. 如有需要，将元素滚动到可见区域。
  4. 使用 Page.Mouse 在元素中心或指定的 Position 处点击。
  5. 等待发起的导航成功或失败，除非设置了 NoWaitAfter 选项。

如果在指定的 Timeout 时间内，所有步骤未完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

用法

await Page.ClickAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageClickOptions?（可选）

    • Button enum MouseButton { Left, Right, Middle }?（可选）#

      默认值为 left。

    • ClickCount int?（可选）#

      默认值为 1。请参阅 UIEvent.detail。

    • Delay [float]?（可选）#

      mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。

    • Force bool?（可选）#

      是否绕过 可操作性 检查。默认值为 false。

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#

      要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。

    • NoWaitAfter bool?（可选）#

      已弃用

      此选项将来默认值将为 true。

      启动导航的操作会等待这些导航发生以及页面开始加载。你可以通过设置此标志选择不等待。只有在导航到无法访问的页面等特殊情况下才需要此选项。默认值为 false。

    • Position Position?（可选）#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool?（可选） 添加于：v1.14#

      为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool?（可选） 添加于：v1.11#

      设置此参数时，此方法仅执行 可操作性 检查并跳过操作。默认值为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

DblClickAsync​

在 v1.9 之前添加 page.DblClickAsync
不推荐使用

请改用基于定位器的 Locator.DblClickAsync()。了解更多关于 定位器 的信息。

此方法通过执行以下步骤双击与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有，则等待匹配的元素附加到 DOM 中。
  2. 等待对匹配元素进行 可操作性 检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则整个操作将重试。
  3. 如有需要，将元素滚动到可见区域。
  4. 使用 Page.Mouse 在元素中心或指定的 Position 处双击。

如果在指定的 Timeout 时间内所有步骤未完成，此方法将抛出 TimeoutError。传递零超时将禁用此功能。

备注

page.dblclick() 会派发两个 click 事件和一个 dblclick 事件。

用法

await Page.DblClickAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageDblClickOptions?（可选）

    • Button enum MouseButton { Left, Right, Middle }?（可选）#

      默认值为 left。

    • Delay [float]?（可选）#

      mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。

    • Force bool?（可选）#

      是否绕过可操作性检查。默认值为 false。

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#

      要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键状态。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。

    • NoWaitAfter bool?（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position?（可选）#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool?（可选） 添加于：v1.14#

      为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认值为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool?（可选） 添加于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认值为 false。这对于等待元素准备好进行操作而不实际执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

DispatchEventAsync​

在 v1.9 之前添加 page.DispatchEventAsync
不推荐使用

请改用基于定位器的 Locator.DispatchEventAsync()。了解更多关于 定位器 的信息。

以下代码片段在元素上派发 click 事件。无论元素的可见性状态如何，都会派发 click 事件。这等效于调用 element.click()。

用法

await page.DispatchEventAsync("button#submit", "click");

在底层，它会根据给定的 type 创建一个事件实例，使用 eventInit 属性对其进行初始化，然后在元素上派发该事件。事件默认是 composed、cancelable 且会冒泡的。

由于 eventInit 是特定于事件的，请参考以下事件文档获取初始属性列表：

如果你希望将实时对象传入事件，也可以将 JSHandle 指定为属性值：

var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await page.DispatchEventAsync("#source", "dragstart", new { dataTransfer });

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • type string#

    DOM 事件类型："click"、"dragstart" 等。

  • eventInit EvaluationArgument?（可选）#

    可选的特定于事件的初始化属性。

  • options PageDispatchEventOptions?（可选）

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传递 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

EvalOnSelectorAsync​

新增于：v1.9 page.EvalOnSelectorAsync
不推荐使用

此方法不会等待元素通过可操作性检查，因此可能会导致测试不稳定。请改用 Locator.EvaluateAsync()、其他 Locator 辅助方法或基于 Web 的断言。

该方法在页面中查找与指定选择器匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素与选择器匹配，该方法将抛出错误。返回 expression 的值。

如果 expression 返回一个 Promise，则 Page.EvalOnSelectorAsync() 将等待该 Promise 解决并返回其值。

用法

var searchValue = await page.EvalOnSelectorAsync<string>("#search", "el => el.value");
var preloadHref = await page.EvalOnSelectorAsync<string>("link[rel=preload]", "el => el.href");
var html = await page.EvalOnSelectorAsync(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");

参数

  • selector string#

    要查询的选择器。

  • expression string#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则该函数将自动调用。

  • arg EvaluationArgument?（可选）#

    传递给 expression 的可选参数。

  • options PageEvalOnSelectorOptions?（可选）

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

返回值

  • [object]#

EvalOnSelectorAllAsync​

添加于：v1.9 page.EvalOnSelectorAllAsync
不推荐使用

在大多数情况下，Locator.EvaluateAllAsync()、其他 Locator 辅助方法以及以网页为优先的断言能更好地完成任务。

此方法会查找页面中所有与指定选择器匹配的元素，并将匹配元素的数组作为第一个参数传递给 expression。返回 expression 调用的结果。

如果 expression 返回一个 Promise，那么 Page.EvalOnSelectorAllAsync() 将等待该 Promise 解决，并返回其值。

用法

var divsCount = await page.EvalOnSelectorAllAsync<bool>("div", "(divs, min) => divs.length >= min", 10);

参数

  • selector string#

    要查询的选择器。

  • expression string#

    要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算结果为一个函数，则该函数将自动调用。

  • arg EvaluationArgument?（可选）#

    传递给 expression 的可选参数。

返回值

  • [object]#

FillAsync​

在 v1.9 之前添加 page.FillAsync
不推荐使用

请改用基于定位器的 Locator.FillAsync()。了解更多关于 定位器 的信息。

此方法会等待与 selector 匹配的元素出现，等待 可操作性 检查通过，聚焦该元素，填充内容，并在填充后触发 input 事件。请注意，你可以传入空字符串来清空输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果该元素位于具有关联 控件 的 <label> 元素内，则会填充该控件。

要发送细粒度的键盘事件，请使用 Locator.PressSequentiallyAsync()。

用法

await Page.FillAsync(selector, value, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • value string#

    要为 <input>、<textarea> 或 [contenteditable] 元素填充的值。

  • options PageFillOptions? （可选）

    • Force bool? （可选） 新增于：v1.13#

      是否绕过 可操作性 检查。默认为 false。

    • NoWaitAfter bool? （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool? （可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]? （可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

FocusAsync​

在 v1.9 之前添加 page.FocusAsync
不推荐使用

请改用基于定位器的 Locator.FocusAsync()。了解更多关于 定位器 的信息。

此方法使用 selector 获取一个元素并将其聚焦。如果没有与 selector 匹配的元素，该方法将等待，直到 DOM 中出现匹配的元素。

用法

await Page.FocusAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageFocusOptions?（可选）

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

GetAttributeAsync​

在 v1.9 之前新增 page.GetAttributeAsync
不推荐

请改用基于定位器的 Locator.GetAttributeAsync()。了解更多关于 定位器 的信息。

返回元素属性值。

用法

await Page.GetAttributeAsync(selector, name, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • name string#

    要获取其值的属性名称。

  • options PageGetAttributeOptions?（可选）

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

HoverAsync​

在 v1.9 之前添加 page.HoverAsync
不推荐使用

请改用基于定位器的 Locator.HoverAsync()。了解更多关于 定位器 的信息。

此方法通过执行以下步骤，将鼠标悬停在与 selector 匹配的元素上：

  1. 查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
  2. 除非设置了 Force 选项，否则等待对匹配元素进行 可操作性 检查。如果在检查过程中元素被分离，则会重试整个操作。
  3. 如果需要，将元素滚动到可见区域。
  4. 使用 Page.Mouse 将鼠标悬停在元素中心或指定的 Position 上。

如果在指定的 Timeout 时间内，所有步骤组合未完成，此方法将抛出 TimeoutError。传入零超时时间可禁用此功能。

用法

await Page.HoverAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageHoverOptions?（可选）

    • Force bool?（可选）#

      是否绕过可操作性检查。默认为 false。

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#

      要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键状态。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。

    • NoWaitAfter bool?（可选） 新增于：v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position?（可选）#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool?（可选） 新增于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作而不实际执行操作很有用。请注意，无论 trial 设置如何，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

InnerHTMLAsync​

在 v1.9 之前添加 page.InnerHTMLAsync
不推荐使用

请改用基于定位器的 Locator.InnerHTMLAsync()。了解更多关于 定位器 的信息。

返回 element.innerHTML。

用法

await Page.InnerHTMLAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageInnerHTMLOptions?（可选）

    • Strict bool?（可选）在 v1.14 中添加#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

InnerTextAsync​

在 v1.9 之前添加 page.InnerTextAsync
不推荐

请改用基于定位器的 Locator.InnerTextAsync()。了解更多关于 定位器 的信息。

返回 element.innerText。

用法

await Page.InnerTextAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageInnerTextOptions?（可选）

    • Strict bool?（可选）在 v1.14 中添加#

      为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

InputValueAsync​

新增于：v1.13 page.InputValueAsync
不推荐使用

请改用基于定位器的 Locator.InputValueAsync()。了解更多关于 定位器 的信息。

返回选定的 <input>、<textarea> 或 <select> 元素的 input.value。

对于非输入元素会抛出异常。但是，如果该元素位于具有关联 control 的 <label> 元素内，则返回该控件的值。

用法

await Page.InputValueAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageInputValueOptions?（可选）

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，此调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

IsCheckedAsync​

在 v1.9 之前添加 page.IsCheckedAsync
不推荐

请改用基于定位器的 Locator.IsCheckedAsync()。了解更多关于 定位器 的信息。

返回元素是否被选中。如果该元素不是复选框或单选输入框，则会抛出异常。

用法​

await Page.IsCheckedAsync(selector, options);

参数​

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageIsCheckedOptions?（可选）

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值​

IsDisabledAsync​

在 v1.9 之前添加 page.IsDisabledAsync
不推荐

请改用基于定位器的 Locator.IsDisabledAsync()。了解更多关于 定位器 的信息。

返回元素是否已禁用，与 已启用 相反。

用法

await Page.IsDisabledAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageIsDisabledOptions? (可选)

    • Strict bool? (可选) 在 v1.14 中添加#

      为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]? (可选)#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

IsEditableAsync​

在 v1.9 之前添加 page.IsEditableAsync
不推荐使用

请改用基于定位器的 Locator.IsEditableAsync()。了解更多关于 定位器 的信息。

返回元素是否可编辑。

用法

await Page.IsEditableAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageIsEditableOptions?（可选）

    • Strict bool?（可选）在 v1.14 中添加#

      为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，此调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

IsEnabledAsync​

在 v1.9 之前添加 page.IsEnabledAsync
不推荐使用

请改用基于定位器的 Locator.IsEnabledAsync()。了解更多关于 定位器 的信息。

返回元素是否启用。

用法

await Page.IsEnabledAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageIsEnabledOptions?（可选）

    • Strict bool?（可选）添加于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

IsHiddenAsync​

在 v1.9 之前添加 page.IsHiddenAsync
不推荐使用

请改用基于定位器的 Locator.IsHiddenAsync()。了解更多关于 定位器 的信息。

返回元素是否隐藏，与 可见性 相反。 不匹配任何元素的 selector 被视为隐藏。

用法

await Page.IsHiddenAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageIsHiddenOptions? (可选)

    • Strict bool? (可选) 在 v1.14 中添加#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]? (可选)#

      已弃用

      此选项将被忽略。Page.IsHiddenAsync() 不会等待元素变为隐藏状态，而是立即返回。

返回值

IsVisibleAsync​

在 v1.9 之前添加 page.IsVisibleAsync
不推荐使用

请改用基于定位器的 Locator.IsVisibleAsync()。了解更多关于 定位器 的信息。

返回元素是否 可见。selector 若未匹配到任何元素，则视为不可见。

用法

await Page.IsVisibleAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageIsVisibleOptions?（可选）

    • Strict bool?（可选）在 v1.14 中添加#

      为 true 时，此调用要求选择器仅解析为单个元素。如果给定选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      已弃用

      此选项将被忽略。Page.IsVisibleAsync() 不会等待元素变为可见，而是立即返回。

返回值

PressAsync​

在 v1.9 之前添加 page.PressAsync
不推荐

请改用基于定位器的 Locator.PressAsync()。详细了解 定位器。

聚焦元素，然后使用 Keyboard.DownAsync() 和 Keyboard.UpAsync()。

key 可指定预期的 keyboardEvent.key 值，或指定一个字符以生成相应文本。key 值的全集可在 此处 找到。键的示例如下：

F1 - F12、Digit0 - Digit9、KeyA - KeyZ、Backquote、Minus、Equal、Backslash、Backspace、Tab、Delete、Escape、ArrowDown、End、Enter、Home、Insert、PageDown、PageUp、ArrowRight、ArrowUp 等。

还支持以下修饰快捷键：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。

按住 Shift 键将输入与 key 对应的大写文本。

如果 key 是单个字符，则区分大小写，因此 a 和 A 值将生成不同的相应文本。

也支持诸如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 之类的快捷键。当与修饰符一起指定时，按下后续键时，修饰符将被按下并保持按下状态。

用法

var page = await browser.NewPageAsync();
await page.GotoAsync("https://keycode.info");
await page.PressAsync("body", "A");
await page.ScreenshotAsync(new() { Path = "A.png" });
await page.PressAsync("body", "ArrowLeft");
await page.ScreenshotAsync(new() { Path = "ArrowLeft.png" });
await page.PressAsync("body", "Shift+O");
await page.ScreenshotAsync(new() { Path = "O.png" });

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • key string#

    要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。

  • options PagePressOptions?（可选）

    • Delay [float]?（可选）#

      keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。

    • NoWaitAfter bool?（可选）#

      已弃用

      此选项在未来将默认为 true。

      启动导航的操作会等待这些导航发生以及页面开始加载。你可以通过设置此标志选择不等待。只有在导航到无法访问的页面等特殊情况下才需要此选项。默认为 false。

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

QuerySelectorAsync​

新增于：v1.9 page.QuerySelectorAsync
不推荐使用

请改用基于定位器的 Page.Locator()。详细了解 定位器。

该方法在页面中查找与指定选择器匹配的元素。如果没有元素与选择器匹配，返回值将解析为 null。要等待页面上的元素，请使用 Locator.WaitForAsync()。

用法

await Page.QuerySelectorAsync(selector, options);

参数

  • selector string#

    要查询的选择器。

  • options PageQuerySelectorOptions?（可选）

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，该调用将抛出异常。

返回值

QuerySelectorAllAsync​

添加于：v1.9 page.QuerySelectorAllAsync
不推荐使用

请改用基于定位器的 Page.Locator()。了解更多关于 定位器 的信息。

该方法会查找页面内所有与指定选择器匹配的元素。如果没有元素与选择器匹配，返回值将解析为 []。

用法

await Page.QuerySelectorAllAsync(selector);

参数

  • selector string#

    要查询的选择器。

返回值

RunAndWaitForNavigationAsync​

在 v1.9 之前添加 page.RunAndWaitForNavigationAsync
已弃用

此方法本质上存在竞争问题，请改用 Page.WaitForURLAsync()。

等待主框架导航，并返回主资源响应。如果发生多次重定向，导航将解析为最后一次重定向的响应。如果导航到不同的锚点或由于使用 History API 而进行导航，导航将解析为 null。

用法​

当页面导航到新 URL 或重新加载时，此操作将完成。当你运行的代码会间接导致页面导航时，此操作很有用。例如，点击目标有一个 onclick 处理程序，它会从 setTimeout 触发导航。考虑以下示例：

await page.RunAndWaitForNavigationAsync(async () =>
{
    // 此操作在超时后触发导航。
    await page.GetByText("Navigate after timeout").ClickAsync();
});

// 导航完成后，该方法继续执行
备注

使用 History API 更改 URL 被视为导航。

参数

  • action Func<Task> 新增于：v1.12#

    触发事件的操作。

  • options PageRunAndWaitForNavigationOptions? （可选）

    • Timeout [float]? （可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool> （可选）#

      等待导航时要匹配的通配符模式、正则表达式模式或接收 URL 的谓词。请注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? （可选）#

      何时认为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作完成。
      • 'load' - 当 load 事件触发时，认为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，认为操作完成。不要在测试中使用此方法，应依赖 Web 断言来评估就绪状态。
      • 'commit' - 当接收到网络响应且文档开始加载时，认为操作完成。

返回值

WaitForNavigationAsync​

在 v1.9 之前添加 page.WaitForNavigationAsync
已弃用

此方法本质上存在竞争问题，请改用 Page.WaitForURLAsync()。

等待主框架导航，并返回主资源响应。如果存在多个重定向，导航将使用最后一个重定向的响应来解析。如果导航到不同的锚点或由于使用 History API 而进行导航，导航将使用 null 来解析。

用法

当页面导航到新 URL 或重新加载时，此方法将解析。当你运行的代码会间接导致页面导航时，此方法很有用。例如，点击目标有一个 onclick 处理程序，它会从 setTimeout 触发导航。考虑以下示例：

await page.RunAndWaitForNavigationAsync(async () =>
{
    // 此操作在超时后触发导航。
    await page.GetByText("Navigate after timeout").ClickAsync();
});

// 导航完成后，该方法继续执行
备注

使用 History API 更改 URL 被视为导航。

参数

  • options PageRunAndWaitForNavigationOptions?（可选）

    • Timeout [float]?（可选）#

      最大操作时间（毫秒），默认为 30 秒，传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool>（可选）#

      等待导航时要匹配的通配符模式、正则表达式模式或接收 URL 的谓词。请注意，如果参数是一个没有通配符的字符串，该方法将等待导航到与该字符串完全相等的 URL。

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?（可选）#

      何时视为操作成功，默认为 load。事件可以是：

      • 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，视为操作完成。
      • 'load' - 当 load 事件触发时，视为操作完成。
      • 'networkidle' - 不推荐 当至少 500 毫秒内没有网络连接时，视为操作完成。不要在测试中使用此方法，应依赖 Web 断言来评估就绪状态。
      • 'commit' - 当接收到网络响应且文档开始加载时，视为操作完成。

返回值

SelectOptionAsync​

在 v1.9 之前添加 page.SelectOptionAsync
不推荐

请改用基于定位器的 Locator.SelectOptionAsync()。了解更多关于 定位器 的信息。

此方法等待与 selector 匹配的元素，等待 可操作性 检查，等待所有指定的选项出现在 <select> 元素中，然后选择这些选项。

如果目标元素不是 <select> 元素，此方法将抛出错误。但是，如果该元素位于具有关联 control 的 <label> 元素内，则将改用该控件。

返回已成功选择的选项值数组。

一旦所有提供的选项都被选中，就会触发 change 和 input 事件。

用法

// 匹配值或标签的单选
await page.SelectOptionAsync("select#colors", new[] { "blue" });
// 匹配值和标签两者的单选
await page.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
// 多选
await page.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" });

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • values string | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#

    • Value string? （可选）

      根据 option.value 进行匹配。可选。

    • Label string? （可选）

      根据 option.label 进行匹配。可选。

    • Index int? （可选）

      根据索引进行匹配。可选。

    要选择的选项。如果 <select> 有 multiple 属性，所有匹配的选项都会被选中，否则只有第一个匹配传入选项之一的选项会被选中。字符串值会同时匹配值和标签。如果所有指定的属性都匹配，则认为该选项匹配。

  • options PageSelectOptionOptions? （可选）

    • Force bool? （可选） 新增于：v1.13#

      是否绕过 可操作性 检查。默认为 false。

    • NoWaitAfter bool? （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool? （可选） 新增于：v1.14#

      为 true 时，此调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]? （可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

SetCheckedAsync​

新增于：v1.15 page.SetCheckedAsync
不推荐

请改用基于定位器的 Locator.SetCheckedAsync()。了解更多关于 定位器 的信息。

此方法通过执行以下步骤，选中或取消选中与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，此方法将抛出异常。
  3. 如果该元素已经处于正确的选中状态，此方法将立即返回。
  4. 等待对匹配元素进行 可操作性 检查，除非设置了 Force 选项。如果在检查过程中元素被分离，整个操作将重试。
  5. 如有需要，将元素滚动到可见区域。
  6. 使用 Page.Mouse 在元素中心点击。
  7. 确保该元素现在已被选中或取消选中。如果没有，此方法将抛出异常。

如果在指定的 Timeout 时间内，所有步骤未能完成，此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。

用法

await Page.SetCheckedAsync(selector, checked, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • checkedState bool#

    是否选中或取消选中复选框。

  • options PageSetCheckedOptions? （可选）

    • Force bool? （可选）#

      是否绕过可操作性检查。默认为 false。

    • NoWaitAfter bool? （可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? （可选）#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。

    • Strict bool? （可选）#

      为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]? （可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool? （可选）#

      设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不执行操作很有用。

返回值

SetInputFilesAsync​

在 v1.9 之前添加 page.SetInputFilesAsync
不推荐使用

请改用基于定位器的 Locator.SetInputFilesAsync()。了解更多关于 定位器 的信息。

将文件输入的值设置为这些文件路径或文件。如果某些 filePaths 是相对路径，则它们将相对于当前工作目录进行解析。对于空数组，将清除选定的文件。对于具有 [webkitdirectory] 属性的输入，仅支持单个目录路径。

此方法要求 selector 指向一个 input 元素。但是，如果该元素位于具有关联 control 的 <label> 元素内，则会改为定位该控件。

用法

await Page.SetInputFilesAsync(selector, files, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#

  • options PageSetInputFilesOptions?（可选）

    • NoWaitAfter bool?（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

TapAsync​

在 v1.9 之前添加 page.TapAsync
不推荐使用

请改用基于定位器的 Locator.TapAsync()。了解更多关于 定位器 的信息。

此方法通过执行以下步骤点击与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有匹配元素，则等待直到有匹配元素附加到 DOM 中。
  2. 等待对匹配元素进行 可操作性 检查，除非设置了 Force 选项。如果在检查过程中元素被分离，则整个操作将重试。
  3. 如有需要，将元素滚动到可见区域。
  4. 使用 Page.Touchscreen 点击元素的中心，或指定的 Position。

如果在指定的 Timeout 时间内所有步骤未完成，此方法将抛出 TimeoutError。传入零超时时间将禁用此功能。

备注

如果浏览器上下文的 HasTouch 选项为 false，Page.TapAsync() 方法将抛出异常。

用法

await Page.TapAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageTapOptions?（可选）

    • Force bool?（可选）#

      是否绕过可操作性检查。默认为 false。

    • Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#

      要按下的修饰键。确保在操作过程中仅按下这些修饰键，然后恢复当前的修饰键状态。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。

    • NoWaitAfter bool?（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position?（可选）#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。

    • Strict bool?（可选） 添加于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool?（可选） 添加于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不执行操作很有用。请注意，无论 trial 为何值，都会按下键盘 modifiers，以便测试仅在按下这些键时才可见的元素。

返回值

TextContentAsync​

在 v1.9 之前添加 page.TextContentAsync
不推荐使用

请改用基于定位器的 Locator.TextContentAsync()。了解更多关于 定位器 的信息。

返回 element.textContent。

用法

await Page.TextContentAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageTextContentOptions?（可选）

    • Strict bool?（可选）在 v1.14 中添加#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

TypeAsync​

在 v1.9 之前添加 page.TypeAsync
已弃用

在大多数情况下，你应该使用 Locator.FillAsync() 代替。只有在页面上有特殊键盘处理时，你才需要逐个按键 - 在这种情况下，使用 Locator.PressSequentiallyAsync()。

为文本中的每个字符发送 keydown、keypress/input 和 keyup 事件。page.type 可用于发送细粒度的键盘事件。要在表单字段中填充值，请使用 Page.FillAsync()。

要按下特殊键，如 Control 或 ArrowDown，请使用 Keyboard.PressAsync()。

用法

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • text string#

    要输入到获得焦点元素中的文本。

  • options PageTypeOptions?（可选）

    • Delay [float]?（可选）#

      按键之间等待的时间（毫秒）。默认为 0。

    • NoWaitAfter bool?（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

UncheckAsync​

在 v1.9 之前添加 page.UncheckAsync
不推荐使用

请改用基于定位器的 Locator.UncheckAsync()。了解更多关于 定位器 的信息。

此方法通过执行以下步骤取消选中与 selector 匹配的元素：

  1. 查找与 selector 匹配的元素。如果没有，则等待匹配的元素附加到 DOM 中。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，此方法将抛出异常。如果该元素已经未选中，此方法将立即返回。
  3. 等待对匹配元素的 可操作性 检查，除非设置了 Force 选项。如果在检查过程中元素被分离，整个操作将重试。
  4. 如有需要，将元素滚动到可见区域。
  5. 使用 Page.Mouse 在元素中心点击。
  6. 确保该元素现在已取消选中。如果没有，此方法将抛出异常。

如果在指定的 Timeout 内所有步骤未完成，此方法将抛出 TimeoutError。传入零超时将禁用此功能。

用法

await Page.UncheckAsync(selector, options);

参数

  • selector string#

    用于搜索元素的选择器。如果有多个元素满足该选择器，将使用第一个元素。

  • options PageUncheckOptions?（可选）

    • Force bool?（可选）#

      是否绕过可操作性检查。默认为 false。

    • NoWaitAfter bool?（可选）#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position?（可选） 新增于：v1.11#

      • X [float]

      • Y [float]

      相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

    • Trial bool?（可选） 新增于：v1.11#

      设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作很有用。

返回值

WaitForSelectorAsync​

在 v1.9 之前添加 page.WaitForSelectorAsync
不推荐使用

请改用断言可见性的 Web 断言，或基于定位器的 Locator.WaitForAsync()。了解更多关于 定位器 的信息。

当选择器指定的元素满足 State 选项时返回。如果等待 hidden 或 detached，则返回 null。

备注

Playwright 会在执行操作前自动等待元素准备就绪。使用 Locator 对象和以 Web 优先的断言可使代码无需等待选择器。

等待 选择器 满足 State 选项（从 DOM 中出现/消失，或变为可见/隐藏）。如果在调用该方法时 选择器 已满足条件，该方法将立即返回。如果选择器在 Timeout 毫秒内未满足条件，函数将抛出异常。

用法

此方法在导航过程中均有效：

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

class FrameExamples
{
  public static async Task Images()
  {
      using var playwright = await Playwright.CreateAsync();
      await using var browser = await playwright.Chromium.LaunchAsync();
      var page = await browser.NewPageAsync();

      foreach (var currentUrl in new[] { "https://www.google.com", "https://bbc.com" })
      {
          await page.GotoAsync(currentUrl);
          var element = await page.WaitForSelectorAsync("img");
          Console.WriteLine($"Loaded image: {await element.GetAttributeAsync("src")}");
      }

      await browser.CloseAsync();
  }
}

参数

  • selector string#

    要查询的选择器。

  • options PageWaitForSelectorOptions?（可选）

    • State enum WaitForSelectorState { Attached, Detached, Visible, Hidden }?（可选）#

      默认为 'visible'。可以是以下值：

      • 'attached' - 等待元素出现在 DOM 中。
      • 'detached' - 等待元素不在 DOM 中。
      • 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或 display:none 的元素具有空的边界框，不被视为可见。
      • 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。

    • Strict bool?（可选） 新增于：v1.14#

      为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。

    • Timeout [float]?（可选）#

      最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

WaitForTimeoutAsync​

在 v1.9 之前添加 page.WaitForTimeoutAsync
不推荐

在生产环境中切勿等待超时。依赖时间等待的测试本质上是不可靠的。请使用 Locator 操作和自动等待的 Web 断言。

等待指定的 timeout（单位为毫秒）。

请注意，page.waitForTimeout() 仅应用于调试。在生产环境中使用定时器的测试将不可靠。请改用网络事件、选择器变为可见等信号。

用法

// 等待 1 秒
await page.WaitForTimeoutAsync(1000);

参数

  • timeout [float]#

    等待的超时时间

返回值