页面

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

此示例创建了一个页面，将其导航到 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? (可选)
- NoWaitAfter bool? (可选)添加于：v1.44#
  
  默认情况下，在调用处理程序后，Playwright 会等待覆盖层消失，只有在此之后，Playwright 才会继续执行触发处理程序的操作/断言。此选项允许选择退出此行为，以便覆盖层可以在处理程序运行后保持可见。
- Times int? (可选)添加于：v1.44#
  
  指定此处理程序应调用的最大次数。默认情况下是无限次。

返回值

void #

AddScriptTagAsync

添加于 v1.9 之前

page.AddScriptTagAsync

在页面中添加一个 <script> 标签，并使用所需的 URL 或内容。当脚本的 onload 触发或脚本内容被注入到框架中时，返回添加的标签。

用法

await Page.AddScriptTagAsync(options);

参数

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

返回值

ElementHandle #

AddStyleTagAsync

添加于 v1.9 之前

page.AddStyleTagAsync

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

用法

await Page.AddStyleTagAsync(options);

参数

options PageAddStyleTagOptions? (可选)
- Content string? (可选)#
  
  要注入到框架中的原始 CSS 内容。
- Path string? (可选)#
  
  要注入到框架中的 CSS 文件路径。如果 path 是相对路径，则它将相对于当前工作目录解析。
- Url string? (可选)#
  
  <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? (可选)
- Reason string? (可选)添加于：v1.40#
  
  要报告给因页面关闭而中断的操作的原因。
- RunBeforeUnload bool? (可选)#
  
  默认值为 false。是否运行 before unload 页面处理程序。

返回值

void #

ContentAsync

添加于 v1.9 之前

page.ContentAsync

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

用法

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? (可选)
- Force bool? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- SourcePosition SourcePosition? (可选)添加于：v1.14#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框的左上角，在此点上点击源元素。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- TargetPosition TargetPosition? (可选)添加于：v1.14#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框的左上角，在此点上将元素拖放到目标元素上。如果未指定，则使用元素的某个可见点。
- Timeout [浮点数]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)#
  
  如果设置，此方法仅执行 actionability 检查，并跳过操作。默认为 false。对于在执行操作之前等待元素准备就绪但无需执行操作时很有用。

返回值

void #

EmulateMediaAsync

添加于 v1.9 之前

page.EmulateMediaAsync

此方法使用 media 参数更改 CSS media 类型，或使用 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
await page.EvaluateAsync("matchMedia('(prefers-color-scheme: no-preference)').matches");
// → false

参数

options PageEmulateMediaOptions? (可选)
- ColorScheme enum ColorScheme { Light, Dark, NoPreference, Null }? (可选)添加于：v1.9#
  
  模拟 'prefers-colors-scheme' 媒体特征，支持的值为 'light'、'dark'、'no-preference'。传递 'Null' 将禁用颜色方案模拟。
- ForcedColors enum ForcedColors { Active, None, Null }? (可选)添加于：v1.15#
- Media enum Media { Screen, Print, Null }? (可选)添加于：v1.9#
  
  更改页面的 CSS 媒体类型。唯一允许的值为 'Screen'、'Print' 和 'Null'。传递 'Null' 将禁用 CSS 媒体模拟。
- ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (可选)添加于：v1.12#
  
  模拟 'prefers-reduced-motion' 媒体特征，支持的值为 'reduce'、'no-preference'。传递 null 将禁用减少运动模拟。

返回值

void #

EvaluateAsync

添加于 v1.9 之前

page.EvaluateAsync

返回 expression 调用的值。

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

如果传递给 Page.EvaluateAsync() 的函数返回一个不可序列化的值，则 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? (可选)#

要传递给 expression 的可选参数。

返回值

[对象]#

EvaluateHandleAsync

添加于 v1.9 之前

page.EvaluateHandleAsync

将 expression 调用的值作为 JSHandle 返回。

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

可选参数，传递给 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 #

窗口对象上函数的名称。
callback Action<BindingSource, T, [TResult]>#

将在 Playwright 的上下文中调用的回调函数。
options PageExposeBindingOptions? (可选)
- Handle bool? (可选)#
  
  已弃用
  此选项将在将来删除。
  
  是否将参数作为句柄传递，而不是按值传递。传递句柄时，仅支持一个参数。按值传递时，支持多个参数。

返回值

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 #

窗口对象上函数的名称
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 中定位文本为“提交”的元素，例如 <iframe id="my-frame">

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

参数

selector string #

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

返回值

FrameLocator #

Frames

添加于 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 中通过标签“用户名”和“密码”查找输入

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

返回值

定位器 #

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 的更多信息。

返回值

定位器 #

细节

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

返回值

定位器 #

细节

默认情况下，使用 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。定位正则表达式时忽略。请注意，完全匹配仍然会修剪空格。

返回值

定位器 #

细节

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

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

GetByTitle

添加于：v1.27

page.GetByTitle

允许根据其标题属性定位元素。

用法

考虑以下 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' - 当收到网络响应并且文档开始加载时，将操作视为完成。

返回值

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“未找到”和 500“内部服务器错误”）时，该方法不会引发错误。这些响应的状态码可以通过调用 Response.Status 来检索。

注意

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

注意

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

用法

await Page.GotoAsync(url, options);

参数

url string #

要将页面导航到的 URL。 URL 应包含方案，例如 https://。当通过上下文选项提供 BaseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。
options PageGotoOptions? (可选)
- Referer string? (可选)#
  
  Referer 标头值。如果提供，它将优先于由 Page.SetExtraHTTPHeadersAsync() 设置的 referer 标头值。
- Timeout [float]? (可选)#
  
  最大操作时间（以毫秒为单位），默认为 30 秒，传递 0 禁用超时。默认值可以通过使用 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法进行更改。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (可选)#
  
  何时认为操作成功，默认为 load。事件可以是以下任一事件：
  - 'domcontentloaded' - 当 DOMContentLoaded 事件触发时，认为操作已完成。
  - 'load' - 当 load 事件触发时，认为操作已完成。
  - 'networkidle' - 不建议 当至少 500 毫秒内没有网络连接时，将操作视为完成。不要将此方法用于测试，而是依靠 Web 断言来评估就绪状态。
  - 'commit' - 当收到网络响应并且文档开始加载时，将操作视为完成。

返回值

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? (可选)#
  
  将方法的结果缩小到那些包含与该相对定位器匹配的元素的结果。例如，article 包含 text=Playwright 匹配 <article><div>Playwright</div></article>。
  
  内部定位器 **必须相对于** 外部定位器，并且从外部定位器匹配开始查询，而不是文档根目录。例如，您可以找到包含 div 的 content 在 <article><content><div>Playwright</div></content></article> 中。但是，查找包含 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>。

返回值

Locator #

MainFrame

添加于 v1.9 之前

page.MainFrame

页面的主框架。页面保证具有在导航过程中持久存在的主框架。

用法

Page.MainFrame

返回值

Frame #

OpenerAsync

添加于 v1.9 之前

page.OpenerAsync

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

用法

await Page.OpenerAsync();

返回值

Page?#

PauseAsync

添加于：v1.9

page.PauseAsync

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

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

注意

此方法要求 Playwright 在有头模式下启动，其中 Headless 选项为假值。

用法

await Page.PauseAsync();

返回值

void #

PdfAsync

添加于 v1.9 之前

page.PdfAsync

返回 PDF 缓冲区。

注意

目前，仅在 Chromium 无头模式下支持生成 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.5in x 11in
Legal: 8.5in x 14in
Tabloid: 11in x 17in
Ledger: 17in x 11in
A0: 33.1in x 46.8in
A1: 23.4in x 33.1in
A2: 16.54in x 23.4in
A3: 11.7in x 16.54in
A4: 8.27in x 11.7in
A5: 5.83in x 8.27in
A6: 4.13in x 5.83in

注意

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() 不会拦截服务工作者拦截的请求。请参阅此问题。我们建议在使用请求拦截时通过将 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");

可以检查请求以决定路由操作。例如，模拟包含某些发布数据的请求，并按原样保留所有其他请求

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

当请求与两个处理程序匹配时，页面路由优先于浏览器上下文路由（使用 BrowserContext.RouteAsync() 设置）。

要删除带有其处理程序的路由，可以使用 Page.UnrouteAsync()。

注意

启用路由会禁用 http 缓存。

参数

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

一个通配符模式、正则表达式模式或接收 URL 的谓词，以便在路由时匹配。当通过上下文选项提供 BaseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。
handler Action<Route>#

处理程序函数，用于路由请求。
options PageRouteOptions? (可选)
- Times int? (可选)添加于：v1.15#
  
  路由应使用多少次。默认情况下，它每次都会使用。

返回值

void #

RouteFromHARAsync

添加于: v1.23

page.RouteFromHARAsync

如果指定了，页面中的网络请求将从 HAR 文件中提供服务。阅读有关从 HAR 重放的更多信息。

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

用法

await Page.RouteFromHARAsync(har, options);

参数

har string #

包含预先录制的网络数据的 HAR 文件的路径。如果 path 是相对路径，则它相对于当前工作目录解析。
options PageRouteFromHAROptions? (可选)
- NotFound enum HarNotFound { Abort, Fallback }? (可选)#
  - 如果设置为“abort”，则 HAR 文件中未找到的任何请求都将被中止。
  - 如果设置为“fallback”，则缺少的请求将被发送到网络。
  默认为 abort。
- Update bool? (可选)#
  
  如果指定，则使用实际网络信息更新给定的 HAR，而不是从文件提供服务。文件在调用 BrowserContext.CloseAsync() 时写入磁盘。
- UpdateContent enum RouteFromHarUpdateContentPolicy { Embed, Attach }? (可选)添加于：v1.32#
  
  可选设置，用于控制资源内容管理。如果指定了“attach”，则资源会作为单独的文件或 ZIP 存档中的条目持久化。如果指定了“embed”，则内容会存储在 HAR 文件中。
- UpdateMode enum HarMode { Full, Minimal }? (可选)添加于：v1.32#
  
  设置为 minimal 时，只记录从 HAR 路由所需的信息。这将省略大小、时间、页面、cookie、安全性和其他在从 HAR 重放时未使用的 HAR 信息类型。默认为 minimal。
- Url|UrlRegex string? | Regex? (可选)#
  
  用于匹配请求 URL 的通配符模式、正则表达式或谓词。只有 URL 与模式匹配的请求才会从 HAR 文件提供服务。如果未指定，则所有请求都将从 HAR 文件提供服务。

返回值

void #

RouteWebSocketAsync

添加于: v1.48

page.RouteWebSocketAsync

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

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

用法

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

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

参数

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

只有 URL 与此模式匹配的 WebSockets 才会被路由。字符串模式可以相对于 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) 返回真值。如果页面在下载事件触发之前关闭，则会抛出错误。

用法

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) 返回真值。如果页面在弹出事件触发之前关闭，则会抛出错误。

用法

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。如果提供谓词，它将 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。如果提供谓词，它将 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 [浮点数]
    
    剪切区域左上角的 x 坐标
  - Y [浮点数]
    
    剪切区域左上角的 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]#

以毫秒为单位的最大时间

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

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

用法

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

传递给表达式的可选参数。
options PageWaitForFunctionOptions? (可选)
- PollingInterval [float]? (可选)#
  
  如果指定，则将其视为以毫秒为单位的间隔，函数将在该间隔内执行。默认情况下，如果没有指定该选项，则表达式将在 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

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

注意

不包含 ServiceWorkers

用法

Page.Workers

返回值

IEnumerable<Worker>#

Properties

APIRequest

添加时间：v1.16

page.APIRequest

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

用法

Page.APIRequest

类型

APIRequestContext

Clock

添加时间：v1.45

page.Clock

Playwright 能够模拟时钟和时间的推移。

用法

Page.Clock

类型

时钟

Keyboard

添加于 v1.9 之前

page.Keyboard

用法

Page.Keyboard

类型

键盘

Mouse

添加于 v1.9 之前

page.Mouse

用法

Page.Mouse

类型

鼠标

Touchscreen

添加于 v1.9 之前

page.Touchscreen

用法

Page.Touchscreen

类型

触摸屏

Events

event Close

添加于 v1.9 之前

page.event Close

页面关闭时发出。

用法

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

事件数据

页面

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

添加于 v1.9 之前

page.event Dialog

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

用法

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

注意

当没有 Page.Dialog 或 BrowserContext.Dialog 监听器存在时，所有对话框将自动被关闭。

事件数据

对话框

event DOMContentLoaded

添加于：v1.9

page.event DOMContentLoaded

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

用法

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

事件数据

页面

event Download

添加于 v1.9 之前

page.event Download

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

用法

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

事件数据

下载

event FileChooser

添加于：v1.9

page.event FileChooser

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

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

用法

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

事件数据

文件选择器

event FrameAttached

添加于：v1.9

page.event FrameAttached

当附加框架时发出。

用法

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

事件数据

框架

event FrameDetached

添加于：v1.9

page.event FrameDetached

当分离框架时发出。

用法

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

事件数据

框架

event FrameNavigated

添加于：v1.9

page.event FrameNavigated

当框架导航到新的 url 时发出。

用法

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

事件数据

框架

event Load

添加于 v1.9 之前

page.event Load

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

用法

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

事件数据

页面

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

事件数据

页面

event Request

添加于 v1.9 之前

page.event Request

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

用法

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

事件数据

请求

event RequestFailed

添加于：v1.9

page.event RequestFailed

当请求失败（例如超时）时发出。

注意

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

用法

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

事件数据

请求

事件 RequestFinished

添加于：v1.9

page.event RequestFinished

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

用法

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

事件数据

请求

事件 Response

添加于 v1.9 之前

page.event Response

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

用法

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

事件数据

响应

事件 WebSocket

添加于：v1.9

page.event WebSocket

在发送 WebSocket 请求时发出。

用法

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

事件数据

WebSocket

事件 Worker

添加于 v1.9 之前

page.event Worker

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

用法

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

事件数据

工作线程

已弃用

辅助功能

添加于 v1.9 之前

page.Accessibility

已弃用

不建议使用此属性。如果您需要测试页面辅助功能，请使用其他库，例如 Axe。有关与 Axe 集成的详细信息，请参阅我们的 Node.js 指南。

用法

Page.Accessibility

类型

无障碍功能

CheckAsync

添加于 v1.9 之前

page.CheckAsync

不建议

使用基于定位器的 Locator.CheckAsync() 替代。详细了解定位器。

此方法通过执行以下步骤检查与选择器匹配的元素。

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

当所有步骤组合在指定的 Timeout 内尚未完成时，此方法将引发 TimeoutError。传递零超时将禁用此功能。

用法

await Page.CheckAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageCheckOptions? (可选)
- Force bool? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Position Position? (可选)添加时间：v1.11#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加时间：v1.11#
  
  如果设置，此方法仅执行 actionability 检查，并跳过操作。默认为 false。对于在执行操作之前等待元素准备就绪但无需执行操作时很有用。

返回值

void #

ClickAsync

添加于 v1.9 之前

page.ClickAsync

不建议

使用基于定位器的 Locator.ClickAsync() 替代。详细了解定位器。

此方法通过执行以下步骤单击与选择器匹配的元素。

查找与选择器匹配的元素。如果没有，则等待直到与 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? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后将当前修饰键恢复回原样。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项将在将来默认为 true。
  
  启动导航的操作将等待这些导航发生以及页面开始加载。您可以通过设置此标志来选择退出等待。您只需要在导航到不可访问页面的特殊情况下使用此选项。默认为 false。
- Position Position? (可选)#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加时间：v1.11#
  
  当设置此选项时，此方法仅执行可操作性检查并跳过操作。默认为 false。对于不执行操作而等待元素准备就绪的操作很有用。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

返回值

void #

DblClickAsync

添加于 v1.9 之前

page.DblClickAsync

不建议

使用基于定位器的 Locator.DblClickAsync() 替代。详细了解定位器。

此方法通过执行以下步骤双击与选择器匹配的元素。

查找与选择器匹配的元素。如果没有，则等待直到与 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? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后将当前修饰键恢复回原样。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Position Position? (可选)#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加时间：v1.11#
  
  当设置此选项时，此方法仅执行可操作性检查并跳过操作。默认为 false。对于不执行操作而等待元素准备就绪的操作很有用。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

返回值

void #

DispatchEventAsync

添加于 v1.9 之前

page.DispatchEventAsync

不建议

使用基于定位器的 Locator.DispatchEventAsync() 代替。了解更多关于定位器。

下面的代码段在元素上分发了 click 事件。无论元素的可见性状态如何，click 都会被分发。这相当于调用 element.click()。

用法

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

在幕后，它基于给定的类型创建一个事件实例，用 eventInit 属性对其进行初始化，并在元素上进行分发。事件默认情况下是 composed、cancelable 和冒泡的。

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

你也可以指定 JSHandle 作为属性值，如果你想将实时对象传递到事件中。

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

参数

selector string #

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

DOM 事件类型："click"，"dragstart" 等。
eventInit EvaluationArgument? (可选)#

可选的特定于事件的初始化属性。
options PageDispatchEventOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

EvalOnSelectorAsync

添加于：v1.9

page.EvalOnSelectorAsync

不建议

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

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

如果表达式返回一个 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? (可选)#

可选参数，传递给表达式。
options PageEvalOnSelectorOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。

返回值

[object]#

EvalOnSelectorAllAsync

添加于：v1.9

page.EvalOnSelectorAllAsync

不建议

在大多数情况下，Locator.EvaluateAllAsync()、其他定位器辅助方法和基于网络的断言做得更好。

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

如果表达式返回一个 Promise，那么 Page.EvalOnSelectorAllAsync() 会等待 Promise 解决并返回其值。

用法

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

参数

selector string #

要查询的选择器。
expression string #

要在浏览器上下文中评估的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument? (可选)#

可选参数，传递给表达式。

返回值

[object]#

FillAsync

添加于 v1.9 之前

page.FillAsync

不建议

使用基于定位器的 Locator.FillAsync() 代替。了解更多关于定位器。

此方法等待与选择器匹配的元素，等待操作性检查，聚焦元素，填充它，并在填充后触发 input 事件。请注意，你可以传递一个空字符串来清除输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法会抛出错误。但是，如果元素在与控件相关联的 <label> 元素内部，则会填充控件。

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

用法

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

参数

selector string #

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

要为 <input>、<textarea> 或 [contenteditable] 元素填充的值。
options PageFillOptions? (可选)
- Force bool? (可选)添加于：v1.13#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

FocusAsync

添加于 v1.9 之前

page.FocusAsync

不建议

使用基于定位器的 Locator.FocusAsync() 代替。了解更多关于定位器。

此方法使用选择器获取元素并聚焦它。如果没有任何元素与选择器匹配，则此方法会一直等待直到 DOM 中出现匹配的元素。

用法

await Page.FocusAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageFocusOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

GetAttributeAsync

添加于 v1.9 之前

page.GetAttributeAsync

不建议

使用基于定位器的 Locator.GetAttributeAsync() 代替。了解更多关于定位器。

返回元素属性值。

用法

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

参数

selector string #

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

要获取值的属性名称。
options PageGetAttributeOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

string?#

HoverAsync

添加于 v1.9 之前

page.HoverAsync

不建议

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

此方法通过执行以下步骤，将鼠标悬停在与选择器相匹配的元素上。

查找与选择器相匹配的元素。如果没有，则等待匹配元素附加到 DOM。
等待对匹配元素进行可操作性检查，除非设置了 Force 选项。如果元素在检查期间被分离，则整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 将鼠标悬停在元素的中心或指定的 Position 上。

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

用法

await Page.HoverAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageHoverOptions? (可选)
- Force bool? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后将当前修饰键恢复回原样。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter bool? (可选)添加于：v1.28#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Position Position? (可选)#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加时间：v1.11#
  
  当设置此选项时，此方法仅执行可操作性检查并跳过操作。默认为 false。对于不执行操作而等待元素准备就绪的操作很有用。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

返回值

void #

InnerHTMLAsync

添加于 v1.9 之前

page.InnerHTMLAsync

不建议

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

返回 element.innerHTML。

用法

await Page.InnerHTMLAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageInnerHTMLOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

string #

InnerTextAsync

添加于 v1.9 之前

page.InnerTextAsync

不建议

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

返回 element.innerText。

用法

await Page.InnerTextAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageInnerTextOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

string #

InputValueAsync

添加于：v1.13

page.InputValueAsync

不建议

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

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

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

用法

await Page.InputValueAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageInputValueOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

string #

IsCheckedAsync

添加于 v1.9 之前

page.IsCheckedAsync

不建议

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

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

用法

await Page.IsCheckedAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageIsCheckedOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

bool #

IsDisabledAsync

添加于 v1.9 之前

page.IsDisabledAsync

不建议

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

返回元素是否被禁用，与 enabled 相反。

用法

await Page.IsDisabledAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageIsDisabledOptions? (可选)
- Strict bool? (可选)添加于：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? (可选)添加于：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? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

bool #

IsHiddenAsync

添加于 v1.9 之前

page.IsHiddenAsync

不建议

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

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

用法

await Page.IsHiddenAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageIsHiddenOptions? (可选)
- Strict bool? (可选)添加于：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? (可选)添加于：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? (可选)添加于：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? (可选)添加于：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()。

等待主帧导航并返回主资源响应。如果发生多次重定向，导航将以最后一次重定向的响应解析。如果导航到不同的锚点或由于使用历史记录 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

注意

使用历史记录 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

注意

使用历史记录 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> 元素，则此方法将抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则将使用该 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#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Strict bool? (可选)添加于：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 在元素的中心单击。
确保元素现在已选中或未选中。如果未选中，此方法将抛出错误。

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

用法

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

参数

selector 字符串 #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
checkedState 布尔值 #

是否选中或取消选中复选框。
options PageSetCheckedOptions? (可选)
- Force 布尔值? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter 布尔值? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Position Position? (可选)#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict 布尔值? (可选)#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [浮点数]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial 布尔值? (可选)#
  
  如果设置，此方法仅执行 actionability 检查，并跳过操作。默认为 false。对于在执行操作之前等待元素准备就绪但无需执行操作时很有用。

返回值

空 #

SetInputFilesAsync

添加于 v1.9 之前

page.SetInputFilesAsync

不建议

使用基于定位器的 Locator.SetInputFilesAsync() 代替。详细了解定位器。

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

此方法期望选择器指向输入元素。但是，如果元素位于与关联的 <label> 元素内部控制，则改为目标控制。

用法

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

参数

selector 字符串 #

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

返回值

空 #

TapAsync

添加于 v1.9 之前

page.TapAsync

不建议

使用基于定位器的 Locator.TapAsync() 代替。详细了解定位器。

此方法通过执行以下步骤来轻击与选择器匹配的元素

查找与选择器匹配的元素。如果没有，请等待匹配的元素附加到 DOM。
等待匹配元素的可操作性检查，除非设置了 Force 选项。如果元素在检查期间被分离，则整个操作将被重试。
如果需要，将元素滚动到视图中。
使用 Page.Touchscreen 轻击元素的中心，或指定的位置。

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

注意

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

用法

await Page.TapAsync(selector, options);

参数

selector 字符串 #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageTapOptions? (可选)
- Force 布尔值? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后将当前修饰键恢复回原样。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter 布尔值? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Position Position? (可选)#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [浮点数]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加时间：v1.11#
  
  当设置此选项时，此方法仅执行可操作性检查并跳过操作。默认为 false。对于不执行操作而等待元素准备就绪的操作很有用。请注意，键盘 modifiers 将始终按下，无论 trial 如何，以允许测试仅在按下这些键时可见的元素。

返回值

空 #

TextContentAsync

添加于 v1.9 之前

page.TextContentAsync

不建议

使用基于定位器的 Locator.TextContentAsync() 代替。详细了解定位器。

返回 element.textContent。

用法

await Page.TextContentAsync(selector, options);

参数

selector 字符串 #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageTextContentOptions? (可选)
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [浮点数]? (可选)#
  
  以毫秒为单位的最大时间。默认为 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 字符串 #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
text 字符串 #

要键入到已聚焦元素中的文本。
options PageTypeOptions? (可选)
- Delay [浮点数]? (可选)#
  
  键入之间要等待的时间（以毫秒为单位）。默认为 0。
- NoWaitAfter 布尔值? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [浮点数]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

空 #

UncheckAsync

添加于 v1.9 之前

page.UncheckAsync

不建议

使用基于定位器的 Locator.UncheckAsync() 代替。详细了解定位器。

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

查找与选择器匹配的元素。如果没有，请等待匹配的元素附加到 DOM。
确保匹配的元素是复选框或单选按钮。如果不是，此方法将抛出错误。如果元素已取消选中，此方法将立即返回。
等待匹配元素上的可操作性检查，除非设置了 Force 选项。如果元素在检查过程中被分离，整个操作将重新尝试。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 在元素的中心单击。
确保该元素现在已取消选中。如果不是，此方法会抛出异常。

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

用法

await Page.UncheckAsync(selector, options);

参数

selector string #

用于搜索元素的选择器。如果有多个元素满足选择器，则将使用第一个元素。
options PageUncheckOptions? (可选)
- Force bool? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项没有效果。
  
  此选项没有效果。
- Position Position? (可选)添加时间：v1.11#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Strict bool? (可选)添加于：v1.14#
  
  如果为 true，则调用需要选择器解析为单个元素。如果给定选择器解析为多个元素，则调用将抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加时间：v1.11#
  
  如果设置，此方法仅执行 actionability 检查，并跳过操作。默认为 false。对于在执行操作之前等待元素准备就绪但无需执行操作时很有用。

返回值

void #

WaitForSelectorAsync

添加于 v1.9 之前

page.WaitForSelectorAsync

不建议

使用断言可见性或基于定位器的 Locator.WaitForAsync() 的 Web 断言。详细了解定位器。

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

注意

Playwright 会自动等待元素准备就绪，然后执行操作。使用 Locator 对象和 Web 首选断言可以使代码无须等待选择器。

等待 selector 满足 State 选项（在 DOM 中出现/消失，或变得可见/隐藏）。如果在调用方法时 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? (可选)添加于：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​

Frames​

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

Frames

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