Skip to main content

Page

Page 提供了与 浏览器 中的单个标签页或 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;
// Do some work...
page.Load -= PageLoadHandler;

方法​

AddInitScriptAsync​

在 v1.9 版本之前添加 page.AddInitScriptAsync

添加一个脚本，该脚本将在以下情况之一中执行

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

脚本在文档创建之后但在其任何脚本运行之前执行。这对于修改 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()，这些操作不依赖于处理程序更改状态。

用法

关闭“注册新闻邮件”对话框（当它出现时）的示例

// Setup the handler.
await page.AddLocatorHandlerAsync(page.GetByText("Sign up to the newsletter"), async () => {
  await page.GetByRole(AriaRole.Button, new() { Name = "No thanks" }).ClickAsync();
});

// Write the test as usual.
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "Start here" }).ClickAsync();

跳过“确认您的安全详细信息”页面（当它显示时）的示例

// Setup the handler.
await page.AddLocatorHandlerAsync(page.GetByText("Confirm your security details"), async () => {
  await page.GetByRole(AriaRole.Button, new() { Name = "Remind me later" }).ClickAsync();
});

// Write the test as usual.
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "Start here" }).ClickAsync();

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

// Setup the handler.
await page.AddLocatorHandlerAsync(page.Locator("body"), async () => {
  await page.EvaluateAsync("window.removeObstructionsForTestIfNeeded()");
}, new() { NoWaitAfter = true });

// Write the test as usual.
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "Start here" }).ClickAsync();

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

await page.AddLocatorHandlerAsync(page.GetByText("Sign up to the newsletter"), async locator => {
  await locator.ClickAsync();
}, new() { Times = 1 });

参数

  • locator Locator#

    触发处理程序的定位器。

  • handler Func<Locator, Task>#

    一旦 locator 出现就应该运行的函数。此函数应消除阻止点击等操作的元素。

  • options PageAddLocatorHandlerOptions? (optional)

    • NoWaitAfter bool? (optional)添加于：v1.44#

      默认情况下，在调用处理程序后，Playwright 将等待直到覆盖层变为隐藏状态，然后 Playwright 才会继续执行触发处理程序的操作/断言。此选项允许选择退出此行为，以便覆盖层可以在处理程序运行后保持可见状态。

    • Times int? (optional)添加于：v1.44#

      指定此处理程序应被调用的最大次数。默认情况下无限制。

返回

AddScriptTagAsync​

在 v1.9 版本之前添加 page.AddScriptTagAsync

将 <script> 标签添加到页面中，其中包含所需的 url 或内容。当脚本的 onload 事件触发或脚本内容被注入到 frame 中时，返回添加的标签。

用法

await Page.AddScriptTagAsync(options);

参数

  • options PageAddScriptTagOptions? (optional)

    • Content string? (optional)#

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

    • Path string? (optional)#

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

    • Type string? (optional)#

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

    • Url string? (optional)#

      要添加的脚本的 URL。

返回

AddStyleTagAsync​

在 v1.9 版本之前添加 page.AddStyleTagAsync

将 <link rel="stylesheet"> 标签添加到页面中，其中包含所需的 url，或者将包含内容的 <style type="text/css"> 标签添加到页面中。当样式表的 onload 事件触发或 CSS 内容被注入到 frame 中时，返回添加的标签。

用法

await Page.AddStyleTagAsync(options);

参数

  • options PageAddStyleTagOptions? (optional)

    • Content string? (optional)#

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

    • Path string? (optional)#

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

    • Url string? (optional)#

      <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? (optional)

    • Reason string? (optional)添加于：v1.40#

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

    • RunBeforeUnload bool? (optional)#

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

返回

ContentAsync​

在 v1.9 版本之前添加 page.ContentAsync

获取页面的完整 HTML 内容，包括 doctype。

用法

await Page.ContentAsync();

返回

Context​

在 v1.9 版本之前添加 page.Context

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

用法

Page.Context

返回

DragAndDropAsync​

添加于：v1.13 page.DragAndDropAsync

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

用法

await Page.DragAndDropAsync("#source", "#target");
// or specify exact positions relative to the top-left corners of the elements:
await Page.DragAndDropAsync("#source", "#target", new()
{
    SourcePosition = new() { X = 34, Y = 7 },
    TargetPosition = new() { X = 10, Y = 20 },
});

参数

  • source string#

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

  • target string#

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

  • options PageDragAndDropOptions? (optional)

    • Force bool? (optional)#

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

    • NoWaitAfter bool? (optional)#

      已弃用

      此选项无效。

      此选项无效。

    • SourcePosition SourcePosition? (optional)添加于：v1.14#

      • X [float]

      • Y [float]

      在此点相对于元素填充框的左上角单击源元素。如果未指定，则使用元素的某些可见点。

    • Strict bool? (optional)添加于：v1.14#

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

    • TargetPosition TargetPosition? (optional)添加于：v1.14#

      • X [float]

      • Y [float]

      在此点相对于元素填充框的左上角放置到目标元素上。如果未指定，则使用元素的某些可见点。

    • Timeout [float]? (optional)#

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

    • Trial bool? (optional)#

      设置后，此方法仅执行可操作性检查并跳过该操作。默认为 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? (optional)

    • ColorScheme enum ColorScheme { Light, Dark, NoPreference, Null }? (optional)添加于：v1.9#

      模拟 prefers-colors-scheme 媒体功能，支持的值为 'light' 和 'dark'。传递 'Null' 将禁用配色方案模拟。'no-preference' 已弃用。

    • Contrast enum Contrast { NoPreference, More, Null }? (optional)添加于：v1.51#

    • ForcedColors enum ForcedColors { Active, None, Null }? (optional)添加于：v1.15#

    • Media enum Media { Screen, Print, Null }? (optional)添加于：v1.9#

      更改页面的 CSS 媒体类型。唯一允许的值为 'Screen'、'Print' 和 'Null'。传递 'Null' 将禁用 CSS 媒体模拟。

    • ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (optional)添加于：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")); // prints "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? (optional)#

    传递给 expression 的可选参数。

返回

  • [object]#

EvaluateHandleAsync​

在 v1.9 版本之前添加 page.EvaluateHandleAsync

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

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

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

用法

// Handle for the window object.
var aWindowHandle = await page.EvaluateHandleAsync("() => Promise.resolve(window)");

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

var docHandle = await page.EvaluateHandleAsync("document"); // Handle for the `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? (optional)#

    传递给 expression 的可选参数。

返回

ExposeBindingAsync​

在 v1.9 版本之前添加 page.ExposeBindingAsync

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

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

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

注意

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

用法

将页面 URL 公开给页面中所有 frame 的示例

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? (optional)

    • Handle bool? (optional)#

      已弃用

      此选项将在未来版本中移除。

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

返回

ExposeFunctionAsync​

在 v1.9 版本之前添加 page.ExposeFunctionAsync

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

如果 callback 返回 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

返回符合指定条件的 frame。必须指定 name 或 url 中的一个。

用法

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

参数

  • name string添加于：v1.9#

    在 iframe 的 name 属性中指定的 Frame 名称。

返回

FrameByUrl​

添加于：v1.9 page.FrameByUrl

返回 URL 匹配的 frame。

用法

Page.FrameByUrl(url);

参数

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

    一个 glob 模式、正则表达式模式或谓词，接收 frame 的 url 作为 URL 对象。

返回

FrameLocator​

添加于版本: v1.17 page.FrameLocator

当使用 iframe 时，您可以创建一个 frame 定位器，它将进入 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

附加到页面的所有 frame 的数组。

用法

Page.Frames

返回

GetByAltText​

添加于版本: v1.27 page.GetByAltText

允许通过元素的 alt 文本定位元素。

用法

例如，此方法将通过 alt 文本 "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 role、ARIA 属性 和 可访问名称 来定位元素。

用法

考虑以下 DOM 结构。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

您可以根据每个元素的隐式 role 定位它们

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

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

await page
    .GetByRole(AriaRole.Button, new() {
        NameRegex = new Regex("submit", 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 role。

  • 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? (可选)#

      控制是否匹配隐藏元素的可选项。默认情况下，role 选择器仅匹配非隐藏元素，如 ARIA 定义。

      了解更多关于 aria-hidden。

    • Level int? (可选)#

      一个数字属性，通常用于 role 为 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。

返回

详情

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

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

GetByTestId​

添加于版本: v1.27 page.GetByTestId

通过测试 ID 定位元素。

用法

考虑以下 DOM 结构。

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

您可以通过元素的测试 ID 定位元素

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

参数

返回

详情

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

GetByText​

添加于版本: v1.27 page.GetByText

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

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

用法

考虑以下 DOM 结构

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

您可以按文本子字符串、完全匹配字符串或正则表达式进行定位

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

// Matches first <div>
page.GetByText("Hello world");

// Matches second <div>
page.GetByText("Hello", new() { Exact = true });

// Matches both <div>s
page.GetByText(new Regex("Hello"));

// Matches second <div>
page.GetByText(new Regex("^hello$", RegexOptions.IgnoreCase));

参数

  • text string | Regex#

    用于定位元素的文本。

  • options PageGetByTextOptions? (可选)

    • Exact bool? (可选)#

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

返回

详情

即使是完全匹配，按文本匹配也始终会规范化空格。例如，它将多个空格变成一个，将换行符变成空格，并忽略前导和尾随空格。

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

GetByTitle​

添加于版本: v1.27 page.GetByTitle

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

用法

考虑以下 DOM 结构。

<span title='Issues count'>25 issues</span>

您可以在通过标题文本定位后检查问题计数

await Expect(Page.GetByTitle("Issues count")).toHaveText("25 issues");

参数

  • 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 "Not Found" 和 500 "Internal Server Error"。可以通过调用 Response.Status 检索此类响应的状态代码。

注意

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

注意

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

用法

await Page.GotoAsync(url, options);

参数

  • url string#

    要导航到的页面 URL。URL 应包含 scheme，例如 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

返回弹出页面的 opener，对于其他页面返回 null。如果 opener 已关闭，则返回 null。

用法

await Page.OpenerAsync();

返回

PauseAsync​

添加于：v1.9 page.PauseAsync

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

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

注意

此方法要求 Playwright 在有头模式下启动，并使用 falsy Headless 选项。

用法

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 属性可以强制渲染精确的颜色。

用法

// Generates a PDF with 'screen' media type
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? (可选)#

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

返回

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. In your page, save a WeakRef for the "suspect".
await Page.EvaluateAsync("globalThis.suspectWeakRef = new WeakRef(suspect)");
// 2. Request garbage collection.
await Page.RequestGCAsync();
// 3. Check that weak ref does not deref to the original object.
Assert.True(await Page.EvaluateAsync("!globalThis.suspectWeakRef.deref()"));

用法

await Page.RequestGCAsync();

返回

RouteAsync​

在 v1.9 版本之前添加 page.RouteAsync

路由提供了修改页面发出的网络请求的功能。

启用路由后，除非继续、完成或中止，否则每个与 URL 模式匹配的请求都将暂停。

注意

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

注意

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

注意

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>#

    glob 模式、正则表达式模式或谓词，用于接收 URL 以在路由时进行匹配。当通过上下文选项提供了 BaseURL 并且传递的 URL 是路径时，它会通过 new URL() 构造函数进行合并。

  • handler Action<Route>#

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

  • options PageRouteOptions? (可选)

    • Times int? (optional)添加于：v1.15#

      路由应使用的频率。默认情况下，它将在每次使用。

返回

RouteFromHARAsync​

新增于: v1.23 page.RouteFromHARAsync

如果指定，页面中发出的网络请求将从 HAR 文件提供。阅读更多关于 从 HAR 文件回放 的信息。

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

用法

await Page.RouteFromHARAsync(har, options);

参数

  • har string#

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

  • options PageRouteFromHAROptions? (可选)

    • NotFound enum HarNotFound { Abort, Fallback }? (可选)#

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

      默认为中止。

    • 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 的 glob 模式、正则表达式或谓词。只有 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");
  });
});

参数

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

    只有 URL 与此模式匹配的 WebSocket 才会被路由。字符串模式可以是相对于 BaseURL 上下文选项的相对路径。

  • handler Action<WebSocketRoute>#

    用于路由 WebSocket 的处理函数。

返回

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。如果提供了谓词，它会将 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 被创建。如果提供了谓词，它会将 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 被创建。如果提供了谓词，它会将 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。如果提供了谓词，它会将 [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。如果提供了谓词，它会将 [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

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

用法

// Waits for the next request with the specified url.
await page.RunAndWaitForRequestAsync(async () =>
{
    await page.GetByText("trigger request").ClickAsync();
}, "http://example.com/resource");

// Alternative way with a predicate.
await page.RunAndWaitForRequestAsync(async () =>
{
    await page.GetByText("trigger request").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

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

用法

// Waits for the next request with the specified url.
await page.RunAndWaitForRequestAsync(async () =>
{
    await page.GetByText("trigger request").ClickAsync();
}, "http://example.com/resource");

// Alternative way with a predicate.
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

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

用法

// Waits for the next response with the specified url.
await page.RunAndWaitForResponseAsync(async () =>
{
    await page.GetByText("trigger response").ClickAsync();
}, "http://example.com/resource");

// Alternative way with a predicate.
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

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

用法

// Waits for the next response with the specified url.
await page.RunAndWaitForResponseAsync(async () =>
{
    await page.GetByText("trigger response").ClickAsync();
}, "http://example.com/resource");

// Alternative way with a predicate.
await page.RunAndWaitForResponseAsync(async () =>
{
    await page.GetByText("trigger response").ClickAsync();
}, response => response.Url == "https://example.com" && response.Status == 200 && response.Request.Method == "GET");

参数

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

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

  • options PageRunAndWaitForResponseOptions? (可选)

返回

RunAndWaitForWebSocketAsync​

添加于：v1.9 page.RunAndWaitForWebSocketAsync

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

用法

await Page.RunAndWaitForWebSocketAsync(action, options);

参数

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

    触发事件的操作。

  • options PageRunAndWaitForWebSocketOptions? (可选)

    • Predicate Func<WebSocket?, bool> (可选)#

      接收 WebSocket 对象，并在等待应该解决时解析为 truthy 值。

    • Timeout [float]? (可选)#

      等待的最长时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 更改默认值。

返回

WaitForWebSocketAsync​

添加于：v1.9 page.WaitForWebSocketAsync

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

用法

await Page.WaitForWebSocketAsync(action, options);

参数

  • options PageRunAndWaitForWebSocketOptions? (可选)

    • Predicate Func<WebSocket?, bool> (可选)#

      接收 WebSocket 对象，并在等待应该解决时解析为 truthy 值。

    • Timeout [float]? (可选)#

      等待的最长时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 更改默认值。

返回

RunAndWaitForWorkerAsync​

添加于：v1.9 page.RunAndWaitForWorkerAsync

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

用法

await Page.RunAndWaitForWorkerAsync(action, options);

参数

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

    触发事件的操作。

  • options PageRunAndWaitForWorkerOptions? (可选)

    • Predicate Func<Worker?, bool> (可选)#

      接收 Worker 对象，并在等待应该解决时解析为 truthy 值。

    • Timeout [float]? (可选)#

      等待的最长时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 更改默认值。

返回

WaitForWorkerAsync​

添加于：v1.9 page.WaitForWorkerAsync

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

用法

await Page.WaitForWorkerAsync(action, options);

参数

  • options PageRunAndWaitForWorkerOptions? (可选)

    • Predicate Func<Worker?, bool> (可选)#

      接收 Worker 对象，并在等待应该解决时解析为 truthy 值。

    • 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>#

    用于在路由时匹配的 glob 模式、正则表达式模式或谓词，接收 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

与此页面关联的 Video 对象。

用法

Page.Video

返回

ViewportSize​

在 v1.9 版本之前添加 page.ViewportSize

用法

Page.ViewportSize

返回

  • ViewportSize?#

    • width int

      页面宽度，以像素为单位。

    • height int

      页面高度，以像素为单位。

WaitForFunctionAsync​

在 v1.9 版本之前添加 page.WaitForFunctionAsync

当 expression 返回 truthy 值时返回。它解析为 truthy 值的 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() 函数的 predicate

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(); // Click triggers navigation.
await page.WaitForLoadStateAsync(); // The promise resolves after 'load' event.
var popup = await page.RunAndWaitForPopupAsync(async () =>
{
    await page.GetByRole(AriaRole.Button).ClickAsync(); // click triggers the popup
});
// Wait for the "DOMContentLoaded" event.
await popup.WaitForLoadStateAsync(LoadState.DOMContentLoaded);
Console.WriteLine(await popup.TitleAsync()); // popup is ready to use.

参数

  • 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"); // clicking the link will indirectly cause a navigation
await page.WaitForURLAsync("**/target.html");

参数

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

    用于在等待导航时匹配的 glob 模式、正则表达式模式或谓词，接收 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

返回

Properties​

APIRequest​

新增于: v1.16 page.APIRequest

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

用法

Page.APIRequest

Type

Clock​

新增于: v1.45 page.Clock

Playwright 具有模拟时钟和时间流逝的能力。

用法

Page.Clock

Type

Keyboard​

在 v1.9 版本之前添加 page.Keyboard

用法

Page.Keyboard

Type

Mouse​

在 v1.9 版本之前添加 page.Mouse

用法

Page.Mouse

Type

Touchscreen​

在 v1.9 版本之前添加 page.Touchscreen

用法

Page.Touchscreen

Type

Events​

event Close​

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

当页面关闭时发出。

用法

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

Event data

event 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' })");

Event data

event Crash​

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

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

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

try {
  // Crash might happen during a click.
  await page.ClickAsync("button");
  // Or while waiting for an event.
  await page.WaitForPopup();
} catch (PlaywrightException e) {
  // When the page crashes, exception message contains "crash".
}

用法

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

Event data

event Dialog​

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

当出现 JavaScript 对话框时发出，例如 alert、prompt、confirm 或 beforeunload。侦听器必须 Dialog.AcceptAsync() 或 Dialog.DismissAsync() 对话框 - 否则页面将 冻结 等待对话框，并且诸如 click 之类的操作将永远不会完成。

用法

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

当没有 Page.Dialog 或 BrowserContext.Dialog 侦听器时，所有对话框都会自动关闭。

Event data

event DOMContentLoaded​

添加于：v1.9 page.event DOMContentLoaded

当 JavaScript DOMContentLoaded 事件被调度时发出。

用法

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

Event data

event Download​

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

当附件下载开始时发出。用户可以通过传递的 Download 实例访问已下载内容的基本文件操作。

用法

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

Event data

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 data

event FrameAttached​

添加于：v1.9 page.event FrameAttached

当框架附加时发出。

用法

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

Event data

event FrameDetached​

添加于：v1.9 page.event FrameDetached

当框架分离时发出。

用法

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

Event data

event FrameNavigated​

添加于：v1.9 page.event FrameNavigated

当框架导航到新 URL 时发出。

用法

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

Event data

event Load​

在 v1.9 版本之前添加 page.event Load

当 JavaScript load 事件被调度时发出。

用法

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

Event data

event PageError​

添加于：v1.9 page.event PageError

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

// Log all uncaught errors to the terminal
page.PageError += (_, exception) =>
{
  Console.WriteLine("Uncaught exception: " + exception);
};

用法

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

Event data

event 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 data

event Request​

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

当页面发出请求时发出。 request 对象是只读的。为了拦截和更改请求，请参阅 Page.RouteAsync() 或 BrowserContext.RouteAsync()。

用法

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

Event data

event RequestFailed​

添加于：v1.9 page.event RequestFailed

当请求失败时发出，例如由于超时。

注意

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

用法

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

Event data

event RequestFinished​

添加于：v1.9 page.event RequestFinished

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

用法

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

Event data

event Response​

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

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

用法

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

Event data

event WebSocket​

添加于：v1.9 page.event WebSocket

当发送 WebSocket 请求时发出。

用法

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

Event data

event Worker​

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

当页面派生专用 WebWorker 时发出。

用法

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

Event data

已弃用​

无障碍性​

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

不推荐使用此属性。如果您需要测试页面无障碍性，请使用其他库，例如 Axe。请参阅我们的 Node.js 指南，了解与 Axe 的集成。

用法

Page.Accessibility

Type

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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

返回

EvalOnSelectorAsync​

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

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

此方法在页面中查找与指定选择器匹配的元素，并将其作为第一个参数传递给 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? (optional)添加于：v1.14#

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

返回

  • [object]#

EvalOnSelectorAllAsync​

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

在大多数情况下，Locator.EvaluateAllAsync()、其他 Locator 辅助方法和 Web-first 断言效果更好。

此方法在页面中查找与指定选择器匹配的所有元素，并将匹配元素的数组作为第一个参数传递给 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] 元素，则此方法会抛出错误。但是，如果元素位于具有关联 control 的 <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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：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? (optional)添加于版本: v1.28#

      已弃用

      此选项无效。

      此选项无效。

    • Position Position? (可选)#

      • X [float]

      • Y [float]

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

    • Strict bool? (optional)添加于：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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：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? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

返回

IsHiddenAsync​

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

使用基于 locator 的 Locator.IsHiddenAsync() 代替。阅读更多关于 locator 的信息。

返回元素是否隐藏，与 visible 相反。不匹配任何元素的 selector 被认为是隐藏的。

用法

await Page.IsHiddenAsync(selector, options);

参数

  • selector string#

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

  • options PageIsHiddenOptions? (可选)

    • Strict bool? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

      已弃用

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

返回

IsVisibleAsync​

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

使用基于 locator 的 Locator.IsVisibleAsync() 代替。阅读更多关于 locator 的信息。

返回元素是否 visible。不匹配任何元素的 selector 被认为不是 visible 的。

用法

await Page.IsVisibleAsync(selector, options);

参数

  • selector string#

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

  • options PageIsVisibleOptions? (可选)

    • Strict bool? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

      已弃用

      此选项被忽略。Page.IsVisibleAsync() 不会等待元素变为 visible 状态，并立即返回。

返回

PressAsync​

在 v1.9 版本之前添加 page.PressAsync
不推荐使用

使用基于 locator 的 Locator.PressAsync() 代替。阅读更多关于 locator 的信息。

聚焦元素，然后使用 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? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

返回

QuerySelectorAsync​

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

使用基于 locator 的 Page.Locator() 代替。阅读更多关于 locator 的信息。

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

用法

await Page.QuerySelectorAsync(selector, options);

参数

  • selector string#

    要查询的选择器。

  • options PageQuerySelectorOptions? (可选)

    • Strict bool? (optional)添加于：v1.14#

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

返回

QuerySelectorAllAsync​

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

使用基于 locator 的 Page.Locator() 代替。阅读更多关于 locator 的信息。

该方法在页面中查找与指定 selector 匹配的所有元素。如果没有元素与 selector 匹配，则返回值解析为 []。

用法

await Page.QuerySelectorAllAsync(selector);

参数

  • selector string#

    要查询的选择器。

返回

RunAndWaitForNavigationAsync​

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

此方法本质上是竞态的，请使用 Page.WaitForURLAsync() 代替。

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

用法

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

await page.RunAndWaitForNavigationAsync(async () =>
{
    // This action triggers the navigation after a timeout.
    await page.GetByText("Navigate after timeout").ClickAsync();
});

// The method continues after navigation has finished
注意

使用 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> (可选)#

      用于在等待导航时匹配的 glob 模式、正则表达式模式或谓词，接收 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 () =>
{
    // This action triggers the navigation after a timeout.
    await page.GetByText("Navigate after timeout").ClickAsync();
});

// The method continues after navigation has finished
注意

使用 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> (可选)#

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

    • WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (可选)#

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

      • 'domcontentloaded' - 当 DOMContentLoaded 事件被触发时，认为操作已完成。
      • 'load' - 当 load 事件被触发时，认为操作已完成。
      • 'networkidle' - **不建议使用** 当至少 500 毫秒没有网络连接时，认为操作已完成。不要将此方法用于测试，而是依靠 web 断言来评估就绪状态。
      • 'commit' - 当收到网络响应并且文档开始加载时，认为操作已完成。

返回

SelectOptionAsync​

在 v1.9 版本之前添加 page.SelectOptionAsync
不推荐使用

使用基于 locator 的 Locator.SelectOptionAsync() 代替。阅读更多关于 locator 的信息。

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

如果目标元素不是 <select> 元素，则此方法会抛出错误。但是，如果元素位于 <label> 元素内，并且该元素具有关联的 control，则将使用该 control 代替。

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

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

用法

// Single selection matching the value or label
await page.SelectOptionAsync("select#colors", new[] { "blue" });
// single selection matching both the value and the label
await page.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
// multiple
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? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

返回

SetCheckedAsync​

添加于：v1.15 page.SetCheckedAsync
不推荐使用

使用基于 locator 的 Locator.SetCheckedAsync() 代替。阅读更多关于 locator 的信息。

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

  1. 查找与 selector 匹配的元素。如果没有，则等待直到匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，则此方法会抛出异常。
  3. 如果元素已经处于正确的选中状态，则此方法立即返回。
  4. 等待对匹配元素进行 actionability 检查，除非设置了 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 的 Locator.SetInputFilesAsync() 代替。阅读更多关于 locator 的信息。

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

此方法期望 selector 指向 input 元素。但是，如果元素位于 <label> 元素内，并且该元素具有关联的 control，则会改为定位到该 control。

用法

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

参数

  • selector string#

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

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

  • options PageSetInputFilesOptions? (可选)

    • NoWaitAfter bool? (可选)#

      已弃用

      此选项无效。

      此选项无效。

    • Strict bool? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

返回

TapAsync​

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

使用基于 locator 的 Locator.TapAsync() 代替。阅读更多关于 locator 的信息。

此方法通过执行以下步骤来轻触与 selector 匹配的元素

  1. 查找与 selector 匹配的元素。如果没有，则等待直到匹配的元素附加到 DOM。
  2. 等待对匹配元素进行 actionability 检查，除非设置了 Force 选项。如果在检查期间元素被分离，则会重试整个操作。
  3. 如果需要，将元素滚动到视图中。
  4. 使用 Page.Touchscreen 轻触元素的中心，或指定的 Position。

当所有步骤组合在一起在指定的 Timeout 期间未完成时，此方法会抛出 TimeoutError。传递零超时将禁用此功能。

注意

Page.TapAsync() 方法在浏览器上下文的 HasTouch 选项为 false 时会抛出异常。

用法

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? (optional)添加于：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 的 Locator.TextContentAsync() 代替。阅读更多关于 locator 的信息。

返回 element.textContent。

用法

await Page.TextContentAsync(selector, options);

参数

  • selector string#

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

  • options PageTextContentOptions? (可选)

    • Strict bool? (optional)添加于：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? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

返回

UncheckAsync​

在 v1.9 版本之前添加 page.UncheckAsync
不推荐使用

使用基于 locator 的 Locator.UncheckAsync() 代替。阅读更多关于 locator 的信息。

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

  1. 查找与 selector 匹配的元素。如果没有，则等待直到匹配的元素附加到 DOM。
  2. 确保匹配的元素是复选框或单选输入框。如果不是，则此方法会抛出异常。如果元素已取消选中，则此方法立即返回。
  3. 等待对匹配元素进行 actionability 检查，除非设置了 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? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

    • Trial bool? (可选)新增于: v1.11#

      设置后，此方法仅执行可操作性检查并跳过该操作。默认为 false。可用于等待元素准备好执行操作，而无需执行该操作。

返回

WaitForSelectorAsync​

在 v1.9 版本之前添加 page.WaitForSelectorAsync
不推荐使用

使用 Web 断言来断言可见性或基于 locator 的 Locator.WaitForAsync() 代替。阅读更多关于 locator 的信息。

当 selector 指定的元素满足 State 选项时返回。如果等待 hidden 或 detached，则返回 null。

注意

Playwright 会自动等待元素准备就绪，然后再执行操作。使用 Locator 对象和 Web 优先断言使代码无需 wait-for-selector。

等待 selector 满足 State 选项（出现/从 DOM 中消失，或变为可见/隐藏）。如果在调用方法时 selector 已经满足条件，则该方法将立即返回。如果 selector 在 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? (optional)添加于：v1.14#

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

    • Timeout [float]? (可选)#

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

返回

WaitForTimeoutAsync​

在 v1.9 版本之前添加 page.WaitForTimeoutAsync
不推荐使用

永远不要在生产环境中等待超时。等待时间的测试本质上是不稳定的。使用 Locator 操作和自动等待的 Web 断言。

等待给定的 timeout 毫秒数。

请注意，page.waitForTimeout() 应该仅用于调试。在生产环境中使用定时器的测试可能会不稳定。请改用网络事件、选择器变为可见等信号。

用法

// Wait for 1 second
await page.WaitForTimeoutAsync(1000);

参数

  • timeout [float]#

    等待的超时时间

返回