ElementHandle

扩展：JSHandle

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

不推荐

不建议使用 ElementHandle，请改用 Locator 对象和以 Web 为中心的断言。

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

除非使用 JsHandle.DisposeAsync() 处置句柄，否则 ElementHandle 会阻止 DOM 元素被垃圾回收。当其来源框架被导航时，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 [浮点数]
  
  元素在像素中的 x 坐标。
- y [浮点数]
  
  元素在像素中的 y 坐标。
- width [浮点数]
  
  元素在像素中的宽度。
- height [浮点数]
  
  元素在像素中的高度。

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 [浮点数]? (可选)#
  
  以毫秒为单位的最大时间。默认为 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 [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Timeout [浮点数]? (可选)#
  
  以毫秒为单位的最大时间。默认为 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 枚举 MouseButton { Left, Right, Middle }? (可选)#
  
  默认为 left。
- ClickCount int? (可选)#
  
  默认为 1。参见 UIEvent.detail。
- Delay [float]? (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- Force bool? (可选)#
  
  是否绕过可操作性检查。默认为 false。
- Modifiers IEnumerable?<枚举 KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta”在 Windows 和 Linux 上解析为“Control”，在 macOS 上解析为“Meta”。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项将来将默认为 true。
  
  启动导航的操作将等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择不等待。您只需要在特殊情况下使用此选项，例如导航到不可访问的页面。默认为 false。
- Position Position? (可选)#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- 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 枚举 MouseButton { Left, Right, Middle }? (可选)#
  
  默认为 left。
- Delay [float]? (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- Force bool? (可选)#
  
  是否绕过可操作性检查。默认为 false。
- Modifiers IEnumerable?<枚举 KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间仅按下这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。“ControlOrMeta”在 Windows 和 Linux 上解析为“Control”，在 macOS 上解析为“Meta”。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)#
  - X [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- 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 辅助方法和 Web 首要断言可以更好地完成这项工作。

返回 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 [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- 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。

对于非输入元素会抛出异常。但是，如果元素位于具有关联控件的<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()。详细了解定位器。

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

用法

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 #

要查询的选择器。

返回值

IEnumerable<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#
  
  要在截取屏幕截图时应用的样式表的文本。在这里，您可以隐藏动态元素，使元素不可见或更改其属性以帮助您创建可重复的屏幕截图。此样式表穿透 Shadow 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>元素，则此方法会抛出错误。但是，如果该元素位于具有关联control的<label>元素内部，则将使用该control。

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

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

用法

// Single selection matching the value or label
await handle.SelectOptionAsync(new[] { "blue" });
// single selection matching the label
await handle.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection
await handle.SelectOptionAsync(new[] { "red", "green", "blue" });
// multiple selection for blue, red and second option
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() 方法更改默认值。

返回值

IEnumerable<string>#

SelectTextAsync

在 v1.9 之前添加

elementHandle.SelectTextAsync

不推荐

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

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

如果该元素位于具有关联control的<label>元素内部，则改为聚焦并选择control中的文本。

用法

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 [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- 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>元素内部，则目标为该control。

用法

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 [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- 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 [浮点数]
  - Y [浮点数]
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)在以下版本中添加：v1.11#
  
  设置此选项时，此方法仅执行可操作性检查并跳过操作。默认为 false。用于在执行操作之前等待元素准备好，而无需执行操作。

返回值

void #

WaitForSelectorAsync

在 v1.9 之前添加

elementHandle.WaitForSelectorAsync

不推荐

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

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

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

用法

await page.SetContentAsync("<div><span></span></div>");
var div = await page.QuerySelectorAsync("div");
// Waiting for the "span" selector relative to the div.
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