ElementHandle

继承自：JSHandle

ElementHandle 表示页面内的 DOM 元素。可以使用 Page.QuerySelectorAsync() 方法创建 ElementHandle。

不推荐

不推荐使用 ElementHandle，请改用 Locator 对象和以 Web 为优先的断言。

var handle = await page.QuerySelectorAsync("a");
await handle.ClickAsync();

ElementHandle 会防止 DOM 元素被垃圾回收，除非使用 JsHandle.DisposeAsync() 释放该句柄。当它们的源框架导航时，ElementHandle 会自动释放。

ElementHandle 实例可用作 Page.EvalOnSelectorAsync() 和 Page.EvaluateAsync() 方法的参数。

Locator 和 ElementHandle 之间的区别在于，ElementHandle 指向特定的元素，而 Locator 捕获了如何检索元素的逻辑。

在下面的示例中，handle 指向页面上的特定 DOM 元素。如果该元素更改文本，或者 React 使用它来渲染完全不同的组件，handle 仍然指向该 DOM 元素。这可能会导致意外行为。

var handle = await page.QuerySelectorAsync("text=Submit");
await handle.HoverAsync();
await handle.ClickAsync();

使用定位器时，每次使用 element 时，都会使用选择器在页面中定位最新的 DOM 元素。因此在下面的代码片段中，底层 DOM 元素将被定位两次。

var locator = page.GetByText("Submit");
await locator.HoverAsync();
await locator.ClickAsync();

方法

BoundingBoxAsync

在 v1.9 之前添加

elementHandle.BoundingBoxAsync

此方法返回元素的边界框，如果元素不可见，则返回 null。边界框是相对于主框架视口计算的，通常与浏览器窗口相同。

滚动会影响返回的边界框，类似于 Element.getBoundingClientRect。这意味着 x 和 / 或 y 可能为负数。

与 Element.getBoundingClientRect 不同，来自子框架的元素返回相对于主框架的边界框。

假设页面是静态的，使用边界框坐标来执行输入操作是安全的。例如，以下代码片段应点击元素的中心。

用法

var box = await elementHandle.BoundingBoxAsync();
await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);

返回值

BoundingBox?#
- x [float]
  
  元素的 x 坐标（以像素为单位）。
- y [float]
  
  元素的 y 坐标（以像素为单位）。
- width [float]
  
  元素的宽度（以像素为单位）。
- height [float]
  
  元素的高度（以像素为单位）。

ContentFrameAsync

在 v1.9 之前添加

elementHandle.ContentFrameAsync

返回引用 iframe 节点的元素句柄的内容框架，否则返回 null。

用法

await ElementHandle.ContentFrameAsync();

返回值

Frame?#

OwnerFrameAsync

在 v1.9 之前添加

elementHandle.OwnerFrameAsync

返回包含给定元素的框架。

用法

await ElementHandle.OwnerFrameAsync();

返回值

Frame?#

WaitForElementStateAsync

在 v1.9 之前添加

elementHandle.WaitForElementStateAsync

当元素满足 state 时返回。

根据 state 参数，此方法等待其中一项可操作性检查通过。除非等待 "hidden" 状态，否则在等待过程中元素分离时，此方法将抛出异常。

"visible" 等待直到元素可见。
"hidden" 等待直到元素不可见或未附加。请注意，等待隐藏状态时，元素分离不会抛出异常。
"stable" 等待直到元素既可见又稳定。
"enabled" 等待直到元素启用。
"disabled" 等待直到元素未启用。
"editable" 等待直到元素可编辑。

如果元素在 Timeout 毫秒内未满足条件，此方法将抛出异常。

用法

await ElementHandle.WaitForElementStateAsync(state, options);

参数

state enum ElementState { Visible, Hidden, Stable, Enabled, Disabled, Editable }#

等待的状态，更多详细信息见下文。
options ElementHandleWaitForElementStateOptions?（可选）
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

已弃用

CheckAsync

在 v1.9 之前添加

elementHandle.CheckAsync

不推荐

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

此方法通过执行以下步骤选中元素：

确保该元素是复选框或单选输入框。否则，此方法将抛出异常。如果该元素已经被选中，此方法将立即返回。
等待对该元素的可操作性检查，除非设置了 Force 选项。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心点击。
确保该元素现在已被选中。否则，此方法将抛出异常。

如果在操作过程中的任何时刻，元素从 DOM 中分离，此方法将抛出异常。

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

用法

await ElementHandle.CheckAsync(options);

参数

options ElementHandleCheckOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）新增于：v1.11#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）新增于：v1.11#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这在等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

ClickAsync

在 v1.9 之前添加

elementHandle.ClickAsync

不推荐使用

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

此方法通过执行以下步骤来点击元素：

等待对该元素进行可操作性检查，除非设置了 Force 选项。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心或指定的 Position 处点击。
等待发起的导航成功或失败，除非设置了 NoWaitAfter 选项。

如果在操作过程中的任何时刻，元素从 DOM 中分离，此方法将抛出异常。

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

用法

await ElementHandle.ClickAsync(options);

参数

options ElementHandleClickOptions?（可选）
- Button enum MouseButton { Left, Right, Middle }?（可选）#
  
  默认值为 left。
- ClickCount int?（可选）#
  
  默认值为 1。请参阅 UIEvent.detail。
- Delay [float]?（可选）#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认值为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作过程中只按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项将来默认值将为 true。
  
  启动导航的操作会等待这些导航发生以及页面开始加载。你可以通过设置此标志选择不等待。只有在导航到无法访问的页面等特殊情况下才需要此选项。默认值为 false。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认值为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认值为 false。有助于在不执行操作的情况下等待元素准备好执行操作。

返回值

void #

DblClickAsync

在 v1.9 之前添加

elementHandle.DblClickAsync

不推荐使用

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

此方法通过执行以下步骤双击元素：

等待对元素进行可操作性检查，除非设置了 Force 选项。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心或指定的 Position 处双击。

如果在操作过程中的任何时刻元素从 DOM 中分离，此方法将抛出异常。

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

备注

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

用法

await ElementHandle.DblClickAsync(options);

参数

options ElementHandleDblClickOptions?（可选）
- Button enum MouseButton { Left, Right, Middle }?（可选）#
  
  默认值为 left。
- Delay [float]?（可选）#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认值为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前的修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认值为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认值为 false。对于等待元素准备好进行操作而不执行操作很有用。

返回值

void #

DispatchEventAsync

在 v1.9 之前添加

elementHandle.DispatchEventAsync

不推荐使用

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

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

用法

await elementHandle.DispatchEventAsync("click");

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

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

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

var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await elementHandle.DispatchEventAsync("dragstart", new Dictionary<string, object>
{
    { "dataTransfer", dataTransfer }
});

参数

type string #

DOM 事件类型："click"、"dragstart" 等。
eventInit EvaluationArgument?（可选）#

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

返回值

void #

EvalOnSelectorAsync

新增于：v1.9

elementHandle.EvalOnSelectorAsync

不推荐

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

返回 expression 的返回值。

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

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

用法

var tweetHandle = await page.QuerySelectorAsync(".tweet");
Assert.AreEqual("100", await tweetHandle.EvalOnSelectorAsync(".like", "node => node.innerText"));
Assert.AreEqual("10", await tweetHandle.EvalOnSelectorAsync(".retweets", "node => node.innerText"));

参数

selector string #

要查询的选择器。
expression string #

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

传递给 expression 的可选参数。

返回值

[object]#

EvalOnSelectorAllAsync

新增于：v1.9

elementHandle.EvalOnSelectorAllAsync

不推荐使用

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

返回 expression 的返回值。

该方法会在 ElementHandle 的子树中查找所有与指定选择器匹配的元素，并将匹配到的元素数组作为第一个参数传递给 expression。

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

用法

<div class="feed">
  <div class="tweet">Hello!</div>
  <div class="tweet">Hi!</div>
</div>

var feedHandle = await page.QuerySelectorAsync(".feed");
Assert.AreEqual(new [] { "Hello!", "Hi!" }, await feedHandle.EvalOnSelectorAllAsync<string[]>(".tweet", "nodes => nodes.map(n => n.innerText)"));

参数

selector string #

要查询的选择器。
expression string #

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

传递给 expression 的可选参数。

返回值

[object]#

FillAsync

在 v1.9 之前添加

elementHandle.FillAsync

不推荐

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

此方法会等待可操作性检查，聚焦元素，填充元素，并在填充后触发 input 事件。请注意，你可以传入空字符串来清空输入字段。

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

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

用法

await ElementHandle.FillAsync(value, options);

参数

value string #

要为 <input>、<textarea> 或 [contenteditable] 元素设置的值。
options ElementHandleFillOptions?（可选）
- Force bool?（可选）新增于：v1.13#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

返回值

void #

FocusAsync

在 v1.9 之前添加

elementHandle.FocusAsync

不推荐

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

在元素上调用 focus。

用法

await ElementHandle.FocusAsync();

返回值

void #

GetAttributeAsync

在 v1.9 之前添加

elementHandle.GetAttributeAsync

不推荐

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

返回元素属性值。

用法

await ElementHandle.GetAttributeAsync(name);

参数

name string #

要获取其值的属性名称。

返回值

string?#

HoverAsync

在 v1.9 之前添加

elementHandle.HoverAsync

不推荐

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

此方法通过执行以下步骤将鼠标悬停在元素上：

等待对元素进行可操作性检查，除非设置了 Force 选项。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 将鼠标悬停在元素中心或指定的 Position 位置。

如果在操作过程中的任何时刻，元素从 DOM 中分离，此方法将抛出异常。

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

用法

await ElementHandle.HoverAsync(options);

参数

options ElementHandleHoverOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作过程中仅按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）新增于：v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）新增于：v1.11#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这在等待元素准备好进行操作但不执行操作时很有用。

返回值

void #

InnerHTMLAsync

在 v1.9 之前添加

elementHandle.InnerHTMLAsync

不推荐

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

返回 element.innerHTML。

用法

await ElementHandle.InnerHTMLAsync();

返回值

string #

InnerTextAsync

在 v1.9 之前添加

elementHandle.InnerTextAsync

不推荐

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

返回 element.innerText。

用法

await ElementHandle.InnerTextAsync();

返回值

string #

InputValueAsync

新增于：v1.13

elementHandle.InputValueAsync

不推荐使用

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

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

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

用法

await ElementHandle.InputValueAsync(options);

参数

options ElementHandleInputValueOptions? （可选）
- Timeout [float]? （可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

返回值

string #

IsCheckedAsync

在 v1.9 之前添加

elementHandle.IsCheckedAsync

不推荐

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

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

用法

await ElementHandle.IsCheckedAsync();

返回值

bool #

IsDisabledAsync

在 v1.9 之前添加

elementHandle.IsDisabledAsync

不推荐

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

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

用法

await ElementHandle.IsDisabledAsync();

返回值

bool #

IsEditableAsync

在 v1.9 之前添加

elementHandle.IsEditableAsync

不推荐

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

返回元素是否可编辑。

用法

await ElementHandle.IsEditableAsync();

返回值

bool #

IsEnabledAsync

在 v1.9 之前添加

elementHandle.IsEnabledAsync

不推荐

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

返回元素是否启用。

用法

await ElementHandle.IsEnabledAsync();

返回值

bool #

IsHiddenAsync

在 v1.9 之前添加

elementHandle.IsHiddenAsync

不推荐

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

返回元素是否隐藏，与可见相反。

用法

await ElementHandle.IsHiddenAsync();

返回值

bool #

IsVisibleAsync

在 v1.9 之前添加

elementHandle.IsVisibleAsync

不推荐

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

返回元素是否可见。

用法

await ElementHandle.IsVisibleAsync();

返回值

bool #

PressAsync

在 v1.9 之前添加

elementHandle.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。

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

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

也支持 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T" 等快捷键。当指定修饰符时，按下后续键时，修饰符将被按下并保持按住状态。

用法

await ElementHandle.PressAsync(key, options);

参数

key string #

要按下的键的名称，或要生成的字符，例如 ArrowLeft 或 a。
options ElementHandlePressOptions?（可选）
- Delay [float]?（可选）#
  
  keydown 和 keyup 之间等待的时间，单位为毫秒。默认为 0。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项在未来将默认为 true。
  
  启动导航的操作会等待这些导航发生以及页面开始加载。你可以通过设置此标志选择不等待。只有在导航到无法访问的页面等特殊情况下才需要此选项。默认为 false。
- Timeout [float]?（可选）#
  
  最长等待时间，单位为毫秒。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

QuerySelectorAsync

新增于：v1.9

elementHandle.QuerySelectorAsync

不推荐

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

该方法在 ElementHandle 的子树中查找与指定选择器匹配的元素。如果没有元素与选择器匹配，则返回 null。

用法

await ElementHandle.QuerySelectorAsync(selector);

参数

selector string #

要查询的选择器。

返回值

ElementHandle?#

QuerySelectorAllAsync

新增于：v1.9

elementHandle.QuerySelectorAllAsync

不推荐

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

该方法在 ElementHandle 的子树中查找所有与指定选择器匹配的元素。如果没有元素与选择器匹配，则返回空数组。

用法

await ElementHandle.QuerySelectorAllAsync(selector);

参数

selector string #

要查询的选择器。

返回值

IReadOnlyList<ElementHandle>#

ScreenshotAsync

在 v1.9 之前添加

elementHandle.ScreenshotAsync

不推荐

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

此方法会截取页面的屏幕截图，并裁剪为特定元素的大小和位置。如果该元素被其他元素覆盖，那么在屏幕截图中实际上将看不到该元素。如果该元素是可滚动容器，那么屏幕截图中只会显示当前滚动的内容。

此方法会等待可操作性检查，然后在截取屏幕截图之前将元素滚动到视图中。如果该元素从 DOM 中分离，此方法将抛出错误。

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

用法

await ElementHandle.ScreenshotAsync(options);

参数

options ElementHandleScreenshotOptions?（可选）
- Animations enum ScreenshotAnimations { Disabled, Allow }?（可选）#
  
  设置为"disabled"时，将停止CSS动画、CSS过渡和Web动画。动画会根据其持续时间得到不同处理：
  - 有限动画将快进到完成状态，因此它们将触发transitionend事件。
  - 无限动画将取消到初始状态，然后在截图后重新播放。
  默认为"allow"，即不触动动画。
- Caret enum ScreenshotCaret { Hide, Initial }?（可选）#
  
  设置为"hide"时，截图将隐藏文本插入符号。设置为"initial"时，文本插入符号的行为不会改变。默认为"hide"。
- 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#
  
  进行截图时应用的样式表文本。在这里，你可以隐藏动态元素、使元素不可见或更改其属性，以帮助你创建可重复的截图。此样式表会穿透影子DOM并应用于内部框架。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为30000（30秒）。传入0可禁用超时。默认值可通过BrowserContext.SetDefaultTimeout()或Page.SetDefaultTimeout()方法更改。
- Type enum ScreenshotType { Png, Jpeg }?（可选）#
  
  指定截图类型，默认为png。

返回值

byte #

ScrollIntoViewIfNeededAsync

在 v1.9 之前添加

elementHandle.ScrollIntoViewIfNeededAsync

不推荐使用

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

此方法会等待可操作性检查，然后尝试将元素滚动到可见区域，除非根据 IntersectionObserver 的 ratio 定义，该元素已完全可见。

当 elementHandle 未指向与 Document 或 ShadowRoot 连接的元素时，会抛出异常。

有关滚动的其他方法，请参阅滚动操作。

用法

await ElementHandle.ScrollIntoViewIfNeededAsync(options);

参数

options ElementHandleScrollIntoViewIfNeededOptions?（可选）
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

SelectOptionAsync

在 v1.9 之前添加

elementHandle.SelectOptionAsync

不推荐使用

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

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

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

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

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

用法

// 匹配值或标签的单选
await handle.SelectOptionAsync(new[] { "blue" });
// 匹配标签的单选
await handle.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// 多选
await handle.SelectOptionAsync(new[] { "red", "green", "blue" });
// 选择蓝色、红色和第二个选项的多选
await handle.SelectOptionAsync(new[] {
    new SelectOptionValue() { Label = "blue" },
    new SelectOptionValue() { Index = 2 },
    new SelectOptionValue() { Value = "red" }});

参数

values string | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#
- Value string?（可选）
  
  通过 option.value 进行匹配。可选。
- Label string?（可选）
  
  通过 option.label 进行匹配。可选。
- Index int?（可选）
  
  通过索引进行匹配。可选。
要选择的选项。如果 <select> 有 multiple 属性，所有匹配的选项都会被选中，否则只有第一个匹配传入选项之一的选项会被选中。字符串值会同时匹配值和标签。如果所有指定的属性都匹配，则认为该选项匹配。
options ElementHandleSelectOptionOptions?（可选）
- Force bool?（可选）新增于：v1.13#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

返回值

IReadOnlyList<string>#

SelectTextAsync

在 v1.9 之前添加

elementHandle.SelectTextAsync

不推荐使用

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

此方法会等待可操作性检查，然后聚焦到该元素并选中其所有文本内容。

如果该元素位于 <label> 元素内，且该 <label> 元素关联了一个控件，则聚焦并选中该控件中的文本。

用法

await ElementHandle.SelectTextAsync(options);

参数

options ElementHandleSelectTextOptions?（可选）
- Force bool?（可选）在 v1.13 中添加#
  
  是否绕过可操作性检查。默认为 false。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

SetCheckedAsync

新增于：v1.15

elementHandle.SetCheckedAsync

不推荐

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

此方法通过执行以下步骤来选中或取消选中一个元素：

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

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

用法

await ElementHandle.SetCheckedAsync(checked, options);

参数

checkedState bool #

是否选中或取消选中复选框。
options ElementHandleSetCheckedOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）#
  
  设置此参数时，此方法仅执行可操作性检查并跳过操作。默认为 false。这对于等待元素准备好进行操作但不执行操作很有用。

返回值

void #

SetInputFilesAsync

在 v1.9 之前添加

elementHandle.SetInputFilesAsync

不推荐

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

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

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

用法

await ElementHandle.SetInputFilesAsync(files, options);

参数

files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#
- Name string
  
  文件名
- MimeType string
  
  文件类型
- Buffer byte[]
  
  文件内容
options ElementHandleSetInputFilesOptions?（可选）
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

void #

TapAsync

在 v1.9 之前添加

elementHandle.TapAsync

不推荐使用

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

此方法通过执行以下步骤点击元素：

等待对元素进行可操作性检查，除非设置了 Force 选项。
如有需要，将元素滚动到可见区域。
使用 Page.Touchscreen 点击元素中心，或指定的 Position。

如果在操作过程中的任何时刻，元素从 DOM 中分离，此方法将抛出异常。

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

备注

elementHandle.tap() 要求浏览器上下文的 hasTouch 选项设置为 true。

用法

await ElementHandle.TapAsync(options);

参数

options ElementHandleTapOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }>（可选）#
  
  要按下的修饰键。确保在操作过程中仅按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta” 在 Windows 和 Linux 上解析为 “Control”，在 macOS 上解析为 “Meta”。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）新增于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。这在等待元素准备好进行操作但不执行操作时很有用。

返回值

void #

TextContentAsync

在 v1.9 之前添加

elementHandle.TextContentAsync

不推荐

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

返回 node.textContent。

用法

await ElementHandle.TextContentAsync();

返回值

string?#

TypeAsync

在 v1.9 之前添加

elementHandle.TypeAsync

已弃用

在大多数情况下，你应该改用 Locator.FillAsync()。只有在页面上有特殊键盘处理时，你才需要逐个按键，这种情况下请使用 Locator.PressSequentiallyAsync()。

聚焦元素，然后为文本中的每个字符发送 keydown、keypress/input 和 keyup 事件。

要按下特殊键，如 Control 或 ArrowDown，请使用 ElementHandle.PressAsync()。

用法

参数

text string #

要输入到聚焦元素中的文本。
options ElementHandleTypeOptions?（可选）
- Delay [float]?（可选）#
  
  按键之间等待的时间（毫秒）。默认为 0。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

返回值

void #

UncheckAsync

在 v1.9 之前添加

elementHandle.UncheckAsync

不推荐

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

此方法通过执行以下步骤取消选中元素：

确保该元素是复选框或单选输入框。否则，此方法将抛出异常。如果该元素已经未选中，此方法将立即返回。
等待对该元素进行可操作性检查，除非设置了 Force 选项。
如有需要，将元素滚动到可见区域。
使用 Page.Mouse 在元素中心点击。
确保该元素现在已取消选中。否则，此方法将抛出异常。

如果在操作过程中的任何时刻，元素从 DOM 中分离，此方法将抛出异常。

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

用法

await ElementHandle.UncheckAsync(options);

参数

options ElementHandleUncheckOptions?（可选）
- Force bool?（可选）#
  
  是否绕过可操作性检查。默认为 false。
- NoWaitAfter bool?（可选）#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position?（可选）新增于：v1.11#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角使用的一个点。如果未指定，则使用元素的某个可见点。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
- Trial bool?（可选）新增于：v1.11#
  
  设置此参数后，此方法仅执行可操作性检查并跳过操作。默认为 false。这在等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

WaitForSelectorAsync

在 v1.9 之前添加

elementHandle.WaitForSelectorAsync

不推荐使用

请改用断言可见性的 Web 断言，或基于定位器的 Locator.WaitForAsync()。

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

等待相对于元素句柄的选择器满足 State 选项（从 DOM 中出现/消失，或变为可见/隐藏）。如果在调用该方法时选择器已经满足条件，该方法将立即返回。如果选择器在 Timeout 毫秒内不满足条件，函数将抛出异常。

用法

await page.SetContentAsync("<div><span></span></div>");
var div = await page.QuerySelectorAsync("div");
// 等待相对于 div 的 "span" 选择器。
var span = await page.WaitForSelectorAsync("span", WaitForSelectorState.Attached);

备注

此方法在导航过程中无效，请改用 Page.WaitForSelectorAsync()。

参数

selector string #

要查询的选择器。
options ElementHandleWaitForSelectorOptions?（可选）
- 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.15#
  
  为 true 时，该调用要求选择器解析为单个元素。如果给定的选择器解析为多个元素，该调用将抛出异常。
- Timeout [float]?（可选）#
  
  最大时间（毫秒）。默认为 30000（30 秒）。传入 0 可禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。

返回值

ElementHandle?#

方法​

BoundingBoxAsync​

ContentFrameAsync​

OwnerFrameAsync​

WaitForElementStateAsync​

参数​

返回值​

已弃用​

CheckAsync​

ClickAsync​

DblClickAsync​

DispatchEventAsync​

EvalOnSelectorAsync​

EvalOnSelectorAllAsync​

FillAsync​

参数​

返回值​

FocusAsync​

GetAttributeAsync​

HoverAsync​

InnerHTMLAsync​

InnerTextAsync​

InputValueAsync​

IsCheckedAsync​

IsDisabledAsync​

IsEditableAsync​

IsEnabledAsync​

IsHiddenAsync​

IsVisibleAsync​

PressAsync​

QuerySelectorAsync​

QuerySelectorAllAsync​

ScreenshotAsync​

ScrollIntoViewIfNeededAsync​

SelectOptionAsync​

SelectTextAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

TypeAsync​

UncheckAsync​

WaitForSelectorAsync​

方法

BoundingBoxAsync

ContentFrameAsync

OwnerFrameAsync

WaitForElementStateAsync

参数

返回值

已弃用

CheckAsync

ClickAsync

DblClickAsync

DispatchEventAsync

EvalOnSelectorAsync

EvalOnSelectorAllAsync

FillAsync

参数

返回值

FocusAsync

GetAttributeAsync

HoverAsync

InnerHTMLAsync

InnerTextAsync

InputValueAsync

IsCheckedAsync

IsDisabledAsync

IsEditableAsync

IsEnabledAsync

IsHiddenAsync

IsVisibleAsync

PressAsync

QuerySelectorAsync

QuerySelectorAllAsync

ScreenshotAsync

ScrollIntoViewIfNeededAsync

SelectOptionAsync

SelectTextAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync

TypeAsync

UncheckAsync

WaitForSelectorAsync