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;
// Do some work...
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 #

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

返回值

void #

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#
  
  指定此处理程序应被调用的最大次数。默认情况下无限制。

返回值

void #

AddScriptTagAsync

在 v1.9 之前添加

page.AddScriptTagAsync

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

用法

await Page.AddScriptTagAsync(options);

参数

options PageAddScriptTagOptions? (optional)
- Content string? (optional)#
  
  要注入到框架中的原始 JavaScript 内容。
- Path string? (optional)#
  
  要注入到框架中的 JavaScript 文件的路径。如果 path 是相对路径，则它是相对于当前工作目录解析的。
- Type string? (optional)#
  
  脚本类型。使用 'module' 以加载 JavaScript ES6 模块。有关更多详细信息，请参阅 script。
- Url string? (optional)#
  
  要添加的脚本的 URL。

返回值

ElementHandle #

AddStyleTagAsync

在 v1.9 之前添加

page.AddStyleTagAsync

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

用法

await Page.AddStyleTagAsync(options);

参数

options PageAddStyleTagOptions? (optional)
- Content string? (optional)#
  
  要注入到框架中的原始 CSS 内容。
- Path string? (optional)#
  
  要注入到框架中的 CSS 文件的路径。如果 path 是相对路径，则它是相对于当前工作目录解析的。
- Url string? (optional)#
  
  <link> 标记的 URL。

返回值

ElementHandle #

BringToFrontAsync

在 v1.9 之前添加

page.BringToFrontAsync

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

用法

await Page.BringToFrontAsync();

返回值

void #

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 页面处理程序。

返回值

void #

ContentAsync

在 v1.9 之前添加

page.ContentAsync

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

用法

await Page.ContentAsync();

返回值

string #

Context

在 v1.9 之前添加

page.Context

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

用法

Page.Context

返回值

BrowserContext #

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。有助于等待元素准备好进行操作而无需执行操作。

返回值

void #

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' 已弃用。
- 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 禁用降低运动模拟。

返回值

void #

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 的可选参数。

返回值

JSHandle #

ExposeBindingAsync

在 v1.9 之前添加

page.ExposeBindingAsync

该方法在页面的每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回 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? (optional)
- Handle bool? (optional)#
  
  已弃用
  此选项将在未来版本中删除。
  
  是以句柄形式传递参数，还是按值传递参数。以句柄形式传递时，仅支持一个参数。按值传递时，支持多个参数。

返回值

void #

ExposeFunctionAsync

在 v1.9 之前添加

page.ExposeFunctionAsync

该方法在页面中每个框架的 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 的上下文中调用的回调函数。

返回值

void #

Frame

在 v1.9 之前添加

page.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 匹配的框架。

用法

Page.FrameByUrl(url);

参数

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

glob 模式、正则表达式模式或接收框架 url 作为 URL 对象的谓词。

返回值

Frame?#

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 元素的选择器。

返回值

FrameLocator #

框架

在 v1.9 之前添加

page.Frames

附加到页面的所有框架的数组。

用法

Page.Frames

返回值

IEnumerable<Frame>#

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。当通过正则表达式定位时忽略。请注意，完全匹配仍然会去除空格。

返回值

Locator #

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。当通过正则表达式定位时忽略。请注意，完全匹配仍然会去除空格。

返回值

Locator #

GetByPlaceholder

添加于：v1.27

page.GetByPlaceholder

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

用法

例如，考虑以下 DOM 结构。

<input type="email" placeholder="[email protected]" />

您可以在通过占位符文本定位输入框后填充它

await page
    .GetByPlaceholder("[email protected]")
    .FillAsync("[email protected]");

参数

text string | Regex #

用于定位元素的文本。
options PageGetByPlaceholderOptions? (可选)
- Exact bool? (可选)#
  
  是否查找完全匹配项：区分大小写且全字符串匹配。默认为 false。当通过正则表达式定位时忽略。请注意，完全匹配仍然会去除空格。

返回值

Locator #

GetByRole

添加于：v1.27

page.GetByRole

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

用法

考虑以下 DOM 结构。

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

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

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 角色。
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 的信息。

返回值

Locator #

详情

角色选择器不能替代可访问性审计和一致性测试，而是提供关于 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();

参数

testId string | Regex #

用于定位元素的 ID。

返回值

Locator #

详情

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

GetByText

添加于：v1.27

page.GetByText

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

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

用法

考虑以下 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。当通过正则表达式定位时忽略。请注意，完全匹配仍然会去除空格。

返回值

Locator #

详情

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

类型为 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。当通过正则表达式定位时忽略。请注意，完全匹配仍然会去除空格。

返回值

Locator #

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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

Response?#

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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

Response?#

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 应包括方案，例如 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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

Response?#

IsClosed

在 v1.9 之前添加

page.IsClosed

指示页面已关闭。

用法

Page.IsClosed

返回值

bool #

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#
  
  匹配在内部某处（可能在子元素或后代元素中）不包含指定文本的元素。当传递字符串时，匹配不区分大小写，并搜索子字符串。
- HasText|HasTextRegex string? | Regex? (可选)#
  
  匹配在内部某处（可能在子元素或后代元素中）包含指定文本的元素。当传递字符串时，匹配不区分大小写，并搜索子字符串。例如，"Playwright" 匹配 <article><div>Playwright</div></article>。

返回值

Locator #

MainFrame

在 v1.9 之前添加

page.MainFrame

页面的主框架。页面保证有一个在导航期间持久存在的主框架。

用法

Page.MainFrame

返回值

Frame #

OpenerAsync

在 v1.9 之前添加

page.OpenerAsync

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

用法

await Page.OpenerAsync();

返回值

Page?#

PauseAsync

添加于：v1.9

page.PauseAsync

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

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

注意

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

用法

await Page.PauseAsync();

返回值

void #

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? (可选)#
  
  纸张宽度，接受带单位的值。

返回值

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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

Response?#

RemoveLocatorHandlerAsync

添加于：v1.44

page.RemoveLocatorHandlerAsync

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

用法

await Page.RemoveLocatorHandlerAsync(locator);

参数

locator Locator #

传递给 Page.AddLocatorHandlerAsync() 的定位器。

返回值

void #

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();

返回值

void #

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#
  
  路由应使用的频率。默认情况下，每次都会使用。

返回值

void #

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 文件中提供。

返回值

void #

RouteWebSocketAsync

添加于: v1.48

page.RouteWebSocketAsync

此方法允许修改页面建立的 websocket 连接。

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

用法

以下是一个简单的模拟示例，该示例响应单个消息。有关更多详细信息和示例，请参阅 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 的处理函数。

返回值

void #

RunAndWaitForConsoleMessageAsync

添加于：v1.9

page.RunAndWaitForConsoleMessageAsync

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

用法

await Page.RunAndWaitForConsoleMessageAsync(action, options);

参数

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

触发事件的操作。
options PageRunAndWaitForConsoleMessageOptions? (可选)
- Predicate Func<ConsoleMessage?, bool> (可选)#
  
  接收 ConsoleMessage 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

ConsoleMessage #

WaitForConsoleMessageAsync

添加于：v1.9

page.WaitForConsoleMessageAsync

用法

await Page.WaitForConsoleMessageAsync(action, options);

参数

options PageRunAndWaitForConsoleMessageOptions? (可选)
- Predicate Func<ConsoleMessage?, bool> (可选)#
  
  接收 ConsoleMessage 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

ConsoleMessage #

RunAndWaitForDownloadAsync

添加于：v1.9

page.RunAndWaitForDownloadAsync

执行操作并等待新的 Download。如果提供了谓词，它会将 Download 值传递到 predicate 函数中，并等待 predicate(download) 返回真值。如果在 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() 更改。

返回值

Download #

WaitForDownloadAsync

添加于：v1.9

page.WaitForDownloadAsync

用法

await Page.WaitForDownloadAsync(action, options);

参数

options PageRunAndWaitForDownloadOptions? (可选)
- Predicate Func<Download?, bool> (可选)#
  
  接收 Download 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

Download #

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() 更改。

返回值

FileChooser #

WaitForFileChooserAsync

添加于：v1.9

page.WaitForFileChooserAsync

用法

await Page.WaitForFileChooserAsync(action, options);

参数

options PageRunAndWaitForFileChooserOptions? (可选)
- Predicate Func<FileChooser?, bool> (可选)#
  
  接收 FileChooser 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

FileChooser #

添加于：v1.9

page.RunAndWaitForPopupAsync

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

用法

await Page.RunAndWaitForPopupAsync(action, options);

参数

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

触发事件的操作。
options PageRunAndWaitForPopupOptions? (可选)
- Predicate Func<Page?, bool> (可选)#
  
  接收 Page 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

Page #

添加于：v1.9

page.WaitForPopupAsync

用法

await Page.WaitForPopupAsync(action, options);

参数

options PageRunAndWaitForPopupOptions? (可选)
- Predicate Func<Page?, bool> (可选)#
  
  接收 Page 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

Page #

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() 方法更改。

返回值

Request #

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() 方法更改。

返回值

Request #

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() 更改。

返回值

Request #

WaitForRequestFinishedAsync

添加于：v1.12

page.WaitForRequestFinishedAsync

用法

await Page.WaitForRequestFinishedAsync(action, options);

参数

options PageRunAndWaitForRequestFinishedOptions? (可选)
- Predicate Func<Request?, bool> (可选)#
  
  接收 Request 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

Request #

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? (可选)
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大等待时间，默认为 30 秒。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

Response #

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? (可选)
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大等待时间，默认为 30 秒。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

Response #

RunAndWaitForWebSocketAsync

添加于：v1.9

page.RunAndWaitForWebSocketAsync

执行操作并等待新的 WebSocket。如果提供了 predicate，它会将 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() 更改。

返回值

WebSocket #

WaitForWebSocketAsync

添加于：v1.9

page.WaitForWebSocketAsync

用法

await Page.WaitForWebSocketAsync(action, options);

参数

options PageRunAndWaitForWebSocketOptions? （可选）
- Predicate Func<WebSocket?, bool> （可选）#
  
  接收 WebSocket 对象，并在等待应该解决时解析为真值。
- Timeout [float]? （可选）#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

WebSocket #

RunAndWaitForWorkerAsync

添加于：v1.9

page.RunAndWaitForWorkerAsync

执行操作并等待新的 Worker。如果提供了 predicate，它会将 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() 更改。

返回值

Worker #

WaitForWorkerAsync

添加于：v1.9

page.WaitForWorkerAsync

用法

await Page.WaitForWorkerAsync(action, options);

参数

options PageRunAndWaitForWorkerOptions? （可选）
- Predicate Func<Worker?, bool> （可选）#
  
  接收 Worker 对象，并在等待应该解决时解析为真值。
- Timeout [float]? （可选）#
  
  等待的最大时间（以毫秒为单位）。默认为 30000 (30 秒)。传递 0 以禁用超时。默认值可以使用 BrowserContext.SetDefaultTimeout() 更改。

返回值

Worker #

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。

返回值

byte[]#

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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

void #

在 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 标头。所有标头值都必须是字符串。

返回值

void #

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#

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

返回值

void #

TitleAsync

在 v1.9 之前添加

page.TitleAsync

返回页面的标题。

用法

await Page.TitleAsync();

返回值

string #

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?> （可选）#

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

返回值

void #

UnrouteAllAsync

添加于: v1.41

page.UnrouteAllAsync

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

用法

await Page.UnrouteAllAsync(options);

参数

options PageUnrouteAllOptions? （可选）
- Behavior enum UnrouteBehavior { Wait, IgnoreErrors, Default }? （可选）#
  
  指定是否等待已运行的处理程序以及如果它们抛出错误该怎么办
  - 'default' - 不等待当前处理程序调用（如果有）完成；如果未路由的处理程序抛出错误，则可能导致未处理的错误
  - 'wait' - 等待当前处理程序调用（如果有）完成
  - 'ignoreErrors' - 不等待当前处理程序调用（如果有）完成；未路由后处理程序抛出的所有错误都会被静默捕获

返回值

void #

Url

在 v1.9 之前添加

page.Url

用法

Page.Url

返回值

string #

Video

在 v1.9 之前添加

page.Video

与此页面关联的 Video 对象。

用法

Page.Video

返回值

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() 方法更改默认值。

返回值

JSHandle #

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? （可选）
- Timeout [float]? （可选）#
  
  最大操作时间（毫秒），默认为 30 秒，传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

void #

Workers

在 v1.9 之前添加

page.Workers

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

注意

这不包含 ServiceWorker

用法

Page.Workers

返回值

IEnumerable<Worker>#

Properties

APIRequest

添加于: v1.16

page.APIRequest

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

用法

Page.APIRequest

Type

APIRequestContext

Clock

添加于: v1.45

page.Clock

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

用法

Page.Clock

Type

Clock

Keyboard

在 v1.9 之前添加

page.Keyboard

用法

Page.Keyboard

Type

Keyboard

Mouse

在 v1.9 之前添加

page.Mouse

用法

Page.Mouse

Type

Mouse

Touchscreen

在 v1.9 之前添加

page.Touchscreen

用法

Page.Touchscreen

Type

Touchscreen

Events

event Close

在 v1.9 之前添加

page.event Close

当页面关闭时发出。

用法

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

事件数据

Page

event Console

在 v1.9 之前添加

page.event Console

当页面内的 JavaScript 调用控制台 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' })");

事件数据

ConsoleMessage

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) => {};

事件数据

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 侦听器时，所有对话框都会自动关闭。

事件数据

Dialog

event DOMContentLoaded

添加于：v1.9

page.event DOMContentLoaded

当 JavaScript DOMContentLoaded 事件被分派时发出。

用法

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

事件数据

Page

event Download

在 v1.9 之前添加

page.event Download

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

用法

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

事件数据

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) => {};

事件数据

FileChooser

event FrameAttached

添加于：v1.9

page.event FrameAttached

当附加框架时发出。

用法

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

事件数据

Frame

event FrameDetached

添加于：v1.9

page.event FrameDetached

当 frame 被分离时触发。

用法

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

事件数据

Frame

event FrameNavigated

添加于：v1.9

page.event FrameNavigated

当 frame 导航到一个新的 url 时触发。

用法

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

事件数据

Frame

event Load

在 v1.9 之前添加

page.event Load

当 JavaScript load 事件被分发时触发。

用法

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

事件数据

Page

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) => {};

事件数据

string

在 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) => {};

事件数据

Page

event Request

在 v1.9 之前添加

page.event Request

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

用法

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

事件数据

Request

event RequestFailed

添加于：v1.9

page.event RequestFailed

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

注意

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

用法

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

事件数据

Request

event RequestFinished

添加于：v1.9

page.event RequestFinished

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

用法

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

事件数据

Request

event Response

在 v1.9 之前添加

page.event Response

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

用法

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

事件数据

Response

event WebSocket

添加于：v1.9

page.event WebSocket

当 WebSocket 请求被发送时触发。

用法

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

事件数据

WebSocket

event Worker

在 v1.9 之前添加

page.event Worker

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

用法

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

事件数据

Worker

已弃用

无障碍功能

在 v1.9 之前添加

page.Accessibility

已弃用

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

用法

Page.Accessibility

Type

辅助功能

CheckAsync

在 v1.9 之前添加

page.CheckAsync

不建议使用

请改用基于 locator 的 Locator.CheckAsync()。阅读更多关于 locator 的信息。

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

查找与 selector 匹配的元素。如果没有，请等待直到匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选输入框。否则，此方法将抛出异常。如果元素已被选中，则此方法立即返回。
等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果元素在检查期间被分离，则会重试整个操作。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 在元素的中心点击。
确保元素现在已被选中。否则，此方法将抛出异常。

当所有步骤在指定的 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。有助于等待元素准备好进行操作而无需执行操作。

返回值

void #

ClickAsync

在 v1.9 之前添加

page.ClickAsync

不建议使用

请改用基于 locator 的 Locator.ClickAsync()。阅读更多关于 locator 的信息。

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

查找与 selector 匹配的元素。如果没有，请等待直到匹配的元素附加到 DOM。
等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果元素在检查期间被分离，则会重试整个操作。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 在元素的中心或指定的 Position 点击。
等待启动的导航成功或失败，除非设置了 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，以允许测试仅在按下这些键时才可见的元素。

返回值

void #

DblClickAsync

在 v1.9 之前添加

page.DblClickAsync

不建议使用

请改用基于 locator 的 Locator.DblClickAsync()。阅读更多关于 locator 的信息。

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

查找与 selector 匹配的元素。如果没有，请等待直到匹配的元素附加到 DOM。
等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果元素在检查期间被分离，则会重试整个操作。
如果需要，将元素滚动到视图中。
使用 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，以允许测试仅在按下这些键时才可见的元素。

返回值

void #

DispatchEventAsync

在 v1.9 之前添加

page.DispatchEventAsync

不建议使用

请改用基于 locator 的 Locator.DispatchEventAsync()。阅读更多关于 locator 的信息。

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

用法

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

在底层，它基于给定的 type 创建一个事件实例，使用 eventInit 属性初始化它，并在元素上分派它。默认情况下，事件是 composed、cancelable 和 bubble 的。

由于 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() 方法更改默认值。

返回值

void #

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 的 Locator.FillAsync()。阅读更多关于 locator 的信息。

此方法等待与 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() 方法更改默认值。

返回值

void #

FocusAsync

在 v1.9 之前添加

page.FocusAsync

不建议使用

请改用基于 locator 的 Locator.FocusAsync()。阅读更多关于 locator 的信息。

此方法获取具有 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() 方法更改默认值。

返回值

void #

GetAttributeAsync

在 v1.9 之前添加

page.GetAttributeAsync

不建议使用

请改用基于 locator 的 Locator.GetAttributeAsync()。阅读更多关于 locator 的信息。

返回元素属性值。

用法

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() 方法更改默认值。

返回值

string?#

HoverAsync

在 v1.9 之前添加

page.HoverAsync

不建议使用

请改用基于 locator 的 Locator.HoverAsync()。阅读更多关于 locator 的信息。

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

查找与 selector 匹配的元素。如果没有，请等待直到匹配的元素附加到 DOM。
等待对匹配元素执行可操作性检查，除非设置了 Force 选项。如果元素在检查期间被分离，则会重试整个操作。
如果需要，将元素滚动到视图中。
使用 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，以允许测试仅在按下这些键时才可见的元素。

返回值

void #

InnerHTMLAsync

在 v1.9 之前添加

page.InnerHTMLAsync

不建议使用

请改用基于 locator 的 Locator.InnerHTMLAsync()。阅读更多关于 locator 的信息。

返回 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() 方法更改默认值。

返回值

string #

InnerTextAsync

在 v1.9 之前添加

page.InnerTextAsync

不建议使用

请改用基于 locator 的 Locator.InnerTextAsync()。阅读更多关于 locator 的信息。

返回 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() 方法更改默认值。

返回值

string #

InputValueAsync

添加于：v1.13

page.InputValueAsync

不建议使用

使用基于定位器的 Locator.InputValueAsync() 代替。阅读更多关于定位器的信息。

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

如果元素不是 input 元素则会抛出错误。但是，如果元素位于具有关联控件的 <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() 方法更改默认值。

返回值

string #

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() 方法更改默认值。

返回值

bool #

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() 方法更改默认值。

返回值

bool #

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() 方法更改默认值。

返回值

bool #

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() 方法更改默认值。

返回值

bool #

IsHiddenAsync

在 v1.9 之前添加

page.IsHiddenAsync

不建议使用

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

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

用法

await Page.IsHiddenAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个。
options PageIsHiddenOptions? (可选)
- Strict bool? (optional)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将引发异常。
- Timeout [float]? (可选)#
  
  已弃用
  此选项被忽略。Page.IsHiddenAsync() 不会等待元素变为隐藏状态，并立即返回。

返回值

bool #

IsVisibleAsync

在 v1.9 之前添加

page.IsVisibleAsync

不建议使用

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

返回元素是否为可见状态。不匹配任何元素的 selector 被认为不可见。

用法

await Page.IsVisibleAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个。
options PageIsVisibleOptions? (可选)
- Strict bool? (optional)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将引发异常。
- Timeout [float]? (可选)#
  
  已弃用
  此选项被忽略。Page.IsVisibleAsync() 不会等待元素变为可见状态，并立即返回。

返回值

bool #

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? (optional)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将引发异常。
- Timeout [float]? (可选)#
  
  最长等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

QuerySelectorAsync

添加于：v1.9

page.QuerySelectorAsync

不建议使用

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

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

用法

await Page.QuerySelectorAsync(selector, options);

参数

selector string #

要查询的选择器。
options PageQuerySelectorOptions? (可选)
- Strict bool? (optional)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将引发异常。

返回值

ElementHandle?#

QuerySelectorAllAsync

添加于：v1.9

page.QuerySelectorAllAsync

不建议使用

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

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

用法

await Page.QuerySelectorAllAsync(selector);

参数

selector string #

要查询的选择器。

返回值

IEnumerable<ElementHandle>#

在 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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

Response?#

在 v1.9 之前添加

page.WaitForNavigationAsync

已弃用

此方法本质上存在竞争条件，请使用 Page.WaitForURLAsync() 代替。

用法

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' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回值

Response?#

SelectOptionAsync

在 v1.9 之前添加

page.SelectOptionAsync

不建议使用

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

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

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

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

一旦所有提供的选项都被选中，将触发 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() 方法更改默认值。

返回值

IEnumerable<string>#

SetCheckedAsync

添加于：v1.15

page.SetCheckedAsync

不建议使用

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

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

查找与 selector 匹配的元素。如果没有，则等待直到匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选按钮。如果不是，此方法将抛出错误。
如果元素已经处于正确的选中状态，则此方法立即返回。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 在元素的中心点击。
确保元素现在已选中或未选中。如果不是，此方法将抛出错误。

当所有步骤在指定的 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。有助于等待元素准备好进行操作而无需执行操作。

返回值

void #

SetInputFilesAsync

在 v1.9 之前添加

page.SetInputFilesAsync

不建议使用

使用基于定位器的 Locator.SetInputFilesAsync() 代替。阅读更多关于定位器的信息。

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

此方法期望 selector 指向一个 input 元素。但是，如果元素位于具有关联控件的 <label> 元素内，则目标将改为该控件。

用法

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

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，将使用第一个。
files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#
- Name string
  
  文件名
- MimeType string
  
  文件类型
- Buffer byte[]
  
  文件内容
options PageSetInputFilesOptions? (可选)
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Strict bool? (optional)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定的选择器解析为多个元素，则调用将引发异常。
- Timeout [float]? (可选)#
  
  最长等待时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

TapAsync

在 v1.9 之前添加

page.TapAsync

不建议使用

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

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

查找与 selector 匹配的元素。如果没有，则等待直到匹配的元素附加到 DOM。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 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，以允许测试仅在按下这些键时才可见的元素。

返回值

void #

TextContentAsync

在 v1.9 之前添加

page.TextContentAsync

不建议使用

使用基于定位器的 Locator.TextContentAsync() 代替。阅读更多关于定位器的信息。

返回 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() 方法更改默认值。

返回值

string?#

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() 方法更改默认值。

返回值

void #

UncheckAsync

在 v1.9 之前添加

page.UncheckAsync

不建议使用

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

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

查找与 selector 匹配的元素。如果没有，则等待直到匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选按钮。如果不是，此方法将抛出错误。如果元素已经未选中，则此方法立即返回。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 在元素的中心点击。
确保元素现在已未选中。如果不是，此方法将抛出错误。

当所有步骤在指定的 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。有助于等待元素准备好进行操作而无需执行操作。

返回值

void #

WaitForSelectorAsync

在 v1.9 之前添加

page.WaitForSelectorAsync

不建议使用

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

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

注意

Playwright 会自动等待元素准备就绪后再执行操作。使用 Locator 对象和 Web 优先断言使代码无需等待选择器。

等待 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 字符串 #

要查询的选择器。
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() 方法更改默认值。

返回值

ElementHandle?#

WaitForTimeoutAsync

在 v1.9 之前添加

page.WaitForTimeoutAsync

不建议使用

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

等待给定的 timeout 毫秒。

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

用法

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

参数

timeout [float]#

等待的超时时间

返回值

void #

方法​

AddInitScriptAsync​

AddLocatorHandlerAsync​

AddScriptTagAsync​

AddStyleTagAsync​

BringToFrontAsync​

CloseAsync​

ContentAsync​

Context​

DragAndDropAsync​

EmulateMediaAsync​

EvaluateAsync​

EvaluateHandleAsync​

ExposeBindingAsync​

ExposeFunctionAsync​

Frame​

FrameByUrl​

FrameLocator​

框架​

GetByAltText​

GetByLabel​

GetByPlaceholder​

GetByRole​

GetByTestId​

GetByText​

GetByTitle​

GoBackAsync​

GoForwardAsync​

GotoAsync​

IsClosed​

Locator​

MainFrame​

OpenerAsync​

PauseAsync​

PdfAsync​

ReloadAsync​

RemoveLocatorHandlerAsync​

RequestGCAsync​

RouteAsync​

RouteFromHARAsync​

RouteWebSocketAsync​

RunAndWaitForConsoleMessageAsync​

WaitForConsoleMessageAsync​

RunAndWaitForDownloadAsync​

WaitForDownloadAsync​

RunAndWaitForFileChooserAsync​

WaitForFileChooserAsync​

RunAndWaitForPopupAsync​

WaitForPopupAsync​

RunAndWaitForRequestAsync​

WaitForRequestAsync​

RunAndWaitForRequestFinishedAsync​

WaitForRequestFinishedAsync​

RunAndWaitForResponseAsync​

WaitForResponseAsync​

RunAndWaitForWebSocketAsync​

WaitForWebSocketAsync​

RunAndWaitForWorkerAsync​

WaitForWorkerAsync​

ScreenshotAsync​

SetContentAsync​

SetDefaultNavigationTimeout​

SetDefaultTimeout​

SetExtraHTTPHeadersAsync​

SetViewportSizeAsync​

TitleAsync​

UnrouteAsync​

UnrouteAllAsync​

Url​

Video​

ViewportSize​

WaitForFunctionAsync​

WaitForLoadStateAsync​

WaitForURLAsync​

Workers​

Properties​

APIRequest​

Clock​

Keyboard​

Mouse​

方法

AddInitScriptAsync

AddLocatorHandlerAsync

AddScriptTagAsync

AddStyleTagAsync

BringToFrontAsync

CloseAsync

ContentAsync

Context

DragAndDropAsync

EmulateMediaAsync

EvaluateAsync

EvaluateHandleAsync

ExposeBindingAsync

ExposeFunctionAsync

Frame

FrameByUrl

FrameLocator

框架

GetByAltText

GetByLabel

GetByPlaceholder

GetByRole

GetByTestId

GetByText

GetByTitle

GoBackAsync

GoForwardAsync

GotoAsync

IsClosed

Locator

MainFrame

OpenerAsync

PauseAsync

PdfAsync

ReloadAsync

RemoveLocatorHandlerAsync

RequestGCAsync

RouteAsync

RouteFromHARAsync

RouteWebSocketAsync

RunAndWaitForConsoleMessageAsync

WaitForConsoleMessageAsync

RunAndWaitForDownloadAsync

WaitForDownloadAsync

RunAndWaitForFileChooserAsync

WaitForFileChooserAsync

RunAndWaitForPopupAsync

WaitForPopupAsync

RunAndWaitForRequestAsync

WaitForRequestAsync

RunAndWaitForRequestFinishedAsync

WaitForRequestFinishedAsync

RunAndWaitForResponseAsync

WaitForResponseAsync

RunAndWaitForWebSocketAsync

WaitForWebSocketAsync

RunAndWaitForWorkerAsync

WaitForWorkerAsync

ScreenshotAsync

SetContentAsync

SetDefaultNavigationTimeout

SetDefaultTimeout

SetExtraHTTPHeadersAsync

SetViewportSizeAsync

TitleAsync

UnrouteAsync

UnrouteAllAsync

Url

Video

ViewportSize

WaitForFunctionAsync

WaitForLoadStateAsync

WaitForURLAsync

Workers

Properties

APIRequest

Clock

Keyboard

Mouse