Page

Page 提供了与 Browser 中的单个标签页或 Chromium 中的 extension background page 交互的方法。一个 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​

添加一个脚本，该脚本将在以下任一场景中被执行：

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

脚本会在文档创建后但在其任何脚本运行前被评估。这对于修改JavaScript环境非常有用，例如用于初始化Math.random。

用法

在页面加载前覆盖Math.random的示例：

// preload.js
Math.random = () => 42;

await Page.AddInitScriptAsync(scriptPath: "./preload.js");

参数

• script string | string#

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

返回

• void#

AddLocatorHandlerAsync​

在测试网页时，有时会出现意外的覆盖层，例如"注册"对话框，它们会阻止你想要自动执行的操作，比如点击按钮。这些覆盖层并不总是以相同的方式或相同的时间出现，使得它们在自动化测试中难以处理。

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

需要注意的事项：

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

用法

一个示例，当"注册订阅新闻通讯"对话框出现时将其关闭：

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

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

// 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会等待直到覆盖层变为隐藏状态，之后才会继续执行触发该处理程序的操作/断言。此选项允许退出此行为，使得处理程序运行后覆盖层可以保持可见。

  • Times int? (可选) 添加于: v1.44#

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

返回

• void#

AddScriptTagAsync​

向页面添加一个带有指定URL或内容的<script>标签。当脚本的onload事件触发或脚本内容被注入到框架时，返回添加的标签。

用法

await Page.AddScriptTagAsync(options);

参数

• options PageAddScriptTagOptions? (optional)

  • Content string? (可选)#

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

  • Path string? (可选)#

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

  • Type string? (可选)#

    脚本类型。使用'module'来加载JavaScript ES6模块。更多详情请参阅script。

  • Url string? (可选)#

    要添加的脚本的URL。

返回

• ElementHandle#

AddStyleTagAsync​

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

用法

await Page.AddStyleTagAsync(options);

参数

• options PageAddStyleTagOptions? (optional)

  • Content string? (可选)#

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

  • Path string? (可选)#

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

  • Url string? (可选)#

    <link> 标签的URL地址。

返回

• ElementHandle#

BringToFrontAsync​

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

用法

await Page.BringToFrontAsync();

返回

• void#

CloseAsync​

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

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

用法

await Page.CloseAsync(options);

参数

• options PageCloseOptions? (optional)

  • Reason string? (可选) 添加于: v1.40#

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

  • RunBeforeUnload bool? (可选)#

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

返回

• void#

ContentAsync​

Gets the full HTML contents of the page, including the doctype.

用法

await Page.ContentAsync();

返回

• string#

上下文​

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

用法

Page.Context

返回

• BrowserContext#

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

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

  • NoWaitAfter bool? (可选)#

    已弃用

    此选项无效。

    此选项无效。

  • SourcePosition SourcePosition? (可选) 添加于: v1.14#

    • X [浮点数]

    • Y [浮点数]

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

  • Strict bool? (可选) 添加于: v1.14#

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

  • TargetPosition TargetPosition? (可选) 新增于: v1.14#

    • X [浮点数]

    • Y [浮点数]

    在目标元素的这一点上相对于元素内边距框的左上角进行拖放。如果未指定，则使用元素的某个可见点。

  • Timeout [float]? (可选)#

    最大时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过使用BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法来修改。

  • Trial bool? (可选)#

    当设置时，此方法仅执行可操作性检查并跳过实际操作。默认为false。适用于等待元素准备好执行操作但又不实际执行该操作的情况。

返回

• void#

模拟媒体异步​

此方法通过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 }? (可选) 添加于: v1.9#

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

  • Contrast enum Contrast { NoPreference, More, Null }? (可选) 添加于: v1.51#

  • ForcedColors enum ForcedColors { Active, None, Null }? (可选) 添加于: v1.15#

  • Media enum Media { Screen, Print, Null }? (可选) 添加于: v1.9#

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

  • ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (可选) 添加于: v1.12#

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

返回

• void#

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

  传递给expression的可选参数。

返回

• [对象]#

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​

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

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

查看BrowserContext.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​

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

如果callback返回一个Promise，它将被等待。

有关上下文范围内暴露的函数，请参见BrowserContext.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#

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

返回

• void#

框架​

返回符合指定条件的框架。必须指定name或url参数。

用法

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

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

参数

• name string 添加于: v1.9#

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

返回

• Frame?#

FrameByUrl​

返回匹配URL的框架。

用法

Page.FrameByUrl(url);

参数

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

  一个接收帧url作为URL对象的全局模式、正则表达式模式或谓词。

返回

• Frame?#

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#

框架​

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

用法

Page.Frames

返回

• IEnumerable<Frame>#

GetByAltText​

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

用法

例如，这个方法将通过alt文本"Playwright logo"找到图片：

<img alt='Playwright logo'>

await page.GetByAltText("Playwright logo").ClickAsync();

参数

• text string | Regex#

  用于定位元素的文本。

• options PageGetByAltTextOptions? (可选)

  • Exact bool? (可选)#

    是否查找完全匹配：区分大小写且需整个字符串匹配。默认为false。使用正则表达式定位时此参数将被忽略。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

GetByLabel​

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

用法

例如，这个方法将在以下DOM中通过标签"Username"和"Password"找到输入框：

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">

await page.GetByLabel("Username").FillAsync("john");
await page.GetByLabel("Password").FillAsync("secret");

参数

• text string | Regex#

  用于定位元素的文本。

• options PageGetByLabelOptions? (可选)

  • Exact bool? (可选)#

    是否查找完全匹配：区分大小写且需整个字符串匹配。默认为false。使用正则表达式定位时此参数将被忽略。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

GetByPlaceholder​

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

用法

例如，考虑以下DOM结构。

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

您可以通过占位符文本定位后填写输入框：

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

参数

• text string | Regex#

  用于定位元素的文本。

• options PageGetByPlaceholderOptions? (可选)

  • Exact bool? (可选)#

    是否查找完全匹配：区分大小写且需整个字符串匹配。默认为false。使用正则表达式定位时此参数将被忽略。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

GetByRole​

允许通过元素的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指南的早期反馈。

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

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​

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

另请参阅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​

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

用法

考虑以下DOM结构。

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

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

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

参数

• text string | Regex#

  用于定位元素的文本。

• options PageGetByTitleOptions? (可选)

  • Exact bool? (可选)#

    是否查找完全匹配：区分大小写且需整个字符串匹配。默认为false。使用正则表达式定位时此参数将被忽略。请注意完全匹配仍会去除空白字符。

返回

• 定位器#

GoBackAsync​

返回主资源响应。在多次重定向的情况下，导航将解析为最后一次重定向的响应。如果无法返回，则返回null。

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

用法

await Page.GoBackAsync(options);

参数

• options PageGoBackOptions? (optional)

  • 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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Response?#

GoForwardAsync​

返回主资源响应。在多次重定向的情况下，导航将以最后一次重定向的响应结果解析。如果无法前进，则返回null。

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

用法

await Page.GoForwardAsync(options);

参数

• options PageGoForwardOptions? (optional)

  • 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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Response?#

GotoAsync​

返回主资源响应。在多次重定向的情况下，导航将解析为第一个非重定向响应。

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

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

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

用法

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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Response?#

IsClosed​

表示页面已关闭。

用法

Page.IsClosed

返回

• bool#

定位器​

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

了解更多关于定位器的信息。

用法

Page.Locator(selector, options);

参数

• selector string#

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

• options PageLocatorOptions? (可选)

  • Has Locator? (可选)#

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

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

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

  • HasNot Locator? (可选) 添加于: v1.33#

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

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

  • HasNotText|HasNotTextRegex string? | Regex? (可选) 添加于: v1.33#

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

  • HasText|HasTextRegex string? | Regex? (可选)#

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

返回

• 定位器#

主框架​

页面的主框架。Page保证有一个主框架，在导航过程中持续存在。

用法

Page.MainFrame

返回

• Frame#

OpenerAsync​

返回弹出页面的开启者，其他情况返回null。如果开启者已被关闭，则返回null。

用法

await Page.OpenerAsync();

返回

• Page?#

PauseAsync​

暂停脚本执行。Playwright将停止执行脚本，等待用户点击页面覆盖层中的'Resume'按钮或在开发者工具控制台中调用playwright.resume()。

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

用法

await Page.PauseAsync();

返回

• void#

PdfAsync​

返回PDF缓冲区。

page.pdf() 会使用 print CSS媒体类型生成页面的PDF。要生成使用 screen 媒体类型的PDF，需在调用 page.pdf() 前先调用 Page.EmulateMediaAsync()：

用法

// 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英寸

参数

• options PagePdfOptions? (optional)

  • DisplayHeaderFooter bool? (可选)#

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

  • FooterTemplate string? (optional)#

    HTML template for the print footer. Should use the same format as the HeaderTemplate.

  • Format string? (可选)#

    纸张格式。如果设置，将优先于Width或Height选项。默认为'Letter'。

  • HeaderTemplate string? (可选)#

    HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:

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

  • Height string? (可选)#

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

  • Landscape bool? (可选)#

    纸张方向。默认为 false。

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

此方法会重新加载当前页面，就像用户触发了浏览器刷新一样。返回主资源响应。如果存在多次重定向，导航将以最后一次重定向的响应结果为准。

用法

await Page.ReloadAsync(options);

参数

• options PageReloadOptions? (optional)

  • 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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• Response?#

RemoveLocatorHandlerAsync​

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

用法

await Page.RemoveLocatorHandlerAsync(locator);

参数

• locator Locator#

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

返回

• void#

RequestGC异步请求​

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

这有助于检测内存泄漏。例如，如果您的页面有一个可能泄漏的大型对象'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​

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

一旦启用路由功能，每个匹配URL模式的请求都将被挂起，除非它被继续、完成或中止。

用法

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

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

参数

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

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

• handler Action<Route>#

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

• options PageRouteOptions? (可选)

  • Times int? (可选) 添加于: v1.15#

    路由应被使用的频率。默认情况下每次都会被使用。

返回

• void#

RouteFromHARAsync​

如果指定了该选项，页面中发出的网络请求将从HAR文件中获取。了解更多关于从HAR回放的信息。

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

用法

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路由所必需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的HAR信息，这些信息在从HAR回放时不会被使用。默认为minimal。

  • Url|UrlRegex string? | Regex? (可选)#

    用于匹配请求URL的通配符模式、正则表达式或谓词。只有URL匹配该模式的请求才会从HAR文件中获取响应。如果未指定，则所有请求都将从HAR文件中获取响应。

返回

• void#

RouteWebSocketAsync​

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

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

用法

下面是一个简单模拟响应单条消息的示例。更多详情和示例请参见WebSocketRoute。

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

参数

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

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

• handler Action<WebSocketRoute>#

  用于路由WebSocket的处理函数。

返回

• void#

RunAndWaitForConsoleMessageAsync​

执行操作并等待页面中记录一个ConsoleMessage。如果提供了predicate，它会将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#

等待控制台消息异步​

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

用法

await Page.WaitForConsoleMessageAsync(action, options);

参数

• options PageRunAndWaitForConsoleMessageOptions? (optional)

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

    接收ConsoleMessage对象，当等待应该解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• ConsoleMessage#

RunAndWaitForDownloadAsync​

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

用法

await Page.RunAndWaitForDownloadAsync(action, options);

参数

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

  触发该事件的动作。

• options PageRunAndWaitForDownloadOptions? (可选)

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

    接收Download对象，当等待应该结束时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• 下载#

WaitForDownloadAsync​

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

用法

await Page.WaitForDownloadAsync(action, options);

参数

• options PageRunAndWaitForDownloadOptions? (optional)

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

    接收Download对象，当等待应该解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• 下载#

RunAndWaitForFileChooserAsync​

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

用法

await Page.RunAndWaitForFileChooserAsync(action, options);

参数

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

  触发该事件的动作。

• options PageRunAndWaitForFileChooserOptions? (可选)

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

    接收FileChooser对象，当等待应该结束时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• FileChooser#

WaitForFileChooserAsync​

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

用法

await Page.WaitForFileChooserAsync(action, options);

参数

• options PageRunAndWaitForFileChooserOptions? (optional)

  • Predicate Func<FileChooser?, bool> (可选参数)#

    接收FileChooser对象，当等待应该解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• FileChooser#

RunAndWaitForPopupAsync​

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

用法

await Page.RunAndWaitForPopupAsync(action, options);

参数

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

  触发该事件的动作。

• options PageRunAndWaitForPopupOptions? (可选)

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

    接收Page对象，当等待应解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• 页面#

WaitForPopupAsync​

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

用法

await Page.WaitForPopupAsync(action, options);

参数

• options PageRunAndWaitForPopupOptions? (optional)

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

    接收Page对象，当等待应解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• 页面#

RunAndWaitForRequestAsync​

等待匹配的请求并返回它。有关事件的更多详情，请参阅waiting for event。

用法

// 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​

等待匹配的请求并返回它。有关事件的更多详情，请参阅waiting for event。

用法

// 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​

执行操作并等待Request完成加载。如果提供了predicate函数，会将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​

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

用法

await Page.WaitForRequestFinishedAsync(action, options);

参数

• options PageRunAndWaitForRequestFinishedOptions? (optional)

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

    接收Request对象，当等待应解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• Request#

RunAndWaitForResponseAsync​

返回匹配的响应。有关事件的更多详情，请参阅waiting for event。

用法

// 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​

返回匹配的响应。有关事件的更多详情，请参阅waiting for event。

用法

// 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​

执行操作并等待新的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​

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

用法

await Page.WaitForWebSocketAsync(action, options);

参数

• options PageRunAndWaitForWebSocketOptions? (optional)

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

    接收WebSocket对象，当等待应该解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• WebSocket#

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​

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

用法

await Page.WaitForWorkerAsync(action, options);

参数

• options PageRunAndWaitForWorkerOptions? (optional)

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

    接收Worker对象，当等待应该解决时解析为真值。

  • Timeout [float]? (可选)#

    最大等待时间，单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过BrowserContext.SetDefaultTimeout()来修改。

返回

• Worker#

ScreenshotAsync​

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

用法

await Page.ScreenshotAsync(options);

参数

• options PageScreenshotOptions? (optional)

  • Animations enum ScreenshotAnimations { Disabled, Allow }? (可选)#

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

    • 有限动画会被快进到完成状态，因此会触发transitionend事件。
    • 无限循环动画会被取消回到初始状态，截图完成后会重新播放。

    默认为"allow"，表示保持动画原样不做处理。

  • Caret enum ScreenshotCaret { Hide, Initial }? (可选)#

    当设置为"hide"时，截图将隐藏文本插入光标。当设置为"initial"时，文本插入光标行为将保持不变。默认为"hide"。

  • Clip 裁剪？ (可选)#

    • X [float]

      裁剪区域左上角的x坐标

    • Y [float]

      裁剪区域左上角的y坐标

    • Width [float]

      裁剪区域的宽度

    • Height [float]

      裁剪区域的高度

    一个指定结果图像裁剪范围的对象。

  • FullPage bool? (可选参数)#

    当设置为true时，会截取整个可滚动页面的截图，而不是当前可见的视口区域。默认为false。

  • Mask IEnumerable?<Locator> (可选)#

    指定在截图时应被遮罩的定位器。被遮罩的元素将被一个粉红色盒子#FF00FF（可通过MaskColor自定义）完全覆盖其边界框。该遮罩也会应用于不可见元素，如需禁用此功能，请参阅Matching only visible elements。

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

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

用法

await Page.SetContentAsync(html, options);

参数

• html string#

  HTML markup to assign to the page.

• 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毫秒内没有网络连接时，认为操作已完成。不要将此方法用于测试，应依赖网页断言来评估准备状态。
    • 'commit' - 当收到网络响应且文档开始加载时，认为操作已完成。

返回

• void#

设置默认导航超时时间​

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

• Page.GoBackAsync()
• Page.GoForwardAsync()
• Page.GotoAsync()
• Page.ReloadAsync()
• Page.SetContentAsync()
• Page.RunAndWaitForNavigationAsync()
• Page.WaitForURLAsync()

用法

Page.SetDefaultNavigationTimeout(timeout);

参数

• timeout [float]#

  最大导航时间（毫秒）