Frame

常に、ページはその現在のフレームツリーをPage.MainFrameおよびFrame.ChildFramesメソッドを介して公開します。

Frameオブジェクトのライフサイクルは、ページオブジェクト上でディスパッチされる3つのイベントによって制御されます。

Page.FrameAttached - フレームがページにアタッチされたときに発火します。フレームはページに一度だけアタッチできます。
Page.FrameNavigated - フレームが別のURLにナビゲーションをコミットしたときに発火します。
Page.FrameDetached - フレームがページからデタッチされたときに発火します。フレームはページから一度だけデタッチできます。

フレームツリーをダンプする例

using Microsoft.Playwright;
using System;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Firefox.LaunchAsync();
        var page = await browser.NewPageAsync();

        await page.GotoAsync("https://www.bing.com");
        DumpFrameTree(page.MainFrame, string.Empty);
    }

    private static void DumpFrameTree(IFrame frame, string indent)
    {
        Console.WriteLine($"{indent}{frame.Url}");
        foreach (var child in frame.ChildFrames)
            DumpFrameTree(child, indent + " ");
    }
}

メソッド

AddScriptTagAsync

v1.9より前に追加

frame.AddScriptTagAsync

スクリプトのonloadが発火したとき、またはスクリプトコンテンツがフレームに注入されたときに、追加されたタグを返します。

指定されたURLまたはコンテンツを持つ<script>タグをページに追加します。

使用方法

await Frame.AddScriptTagAsync(options);

引数

options FrameAddScriptTagOptions? (任意)
- Content string? (任意)#
  
  フレームに注入される生のJavaScriptコンテンツ。
- Path string? (任意)#
  
  フレームに注入されるJavaScriptファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。
- Type string? (任意)#
  
  スクリプトタイプ。JavaScript ES6モジュールをロードするには 'module' を使用します。詳細については、script を参照してください。
- Url string? (任意)#
  
  追加するスクリプトのURL。

戻り値

ElementHandle #

AddStyleTagAsync

v1.9より前に追加

frame.AddStyleTagAsync

スタイルシートのonloadが発火したとき、またはCSSコンテンツがフレームに注入されたときに、追加されたタグを返します。

指定されたURLを持つ<link rel="stylesheet">タグ、またはコンテンツを持つ<style type="text/css">タグをページに追加します。

使用方法

await Frame.AddStyleTagAsync(options);

引数

options FrameAddStyleTagOptions? (任意)
- Content string? (任意)#
  
  フレームに注入される生のCSSコンテンツ。
- Path string? (任意)#
  
  フレームに注入されるCSSファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。
- Url string? (任意)#
  
  <link>タグのURL。

戻り値

ElementHandle #

ChildFrames

v1.9より前に追加

frame.ChildFrames

使用方法

Frame.ChildFrames

戻り値

IReadOnlyList<Frame>#

ContentAsync

v1.9より前に追加

frame.ContentAsync

DOCTYPEを含む、フレームの完全なHTMLコンテンツを取得します。

使用方法

await Frame.ContentAsync();

戻り値

string #

DragAndDropAsync

追加日: v1.13

frame.DragAndDropAsync

使用方法

await Frame.DragAndDropAsync(source, target, options);

引数

source string #

ドラッグする要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
target string #

ドロップする要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameDragAndDropOptions? (任意)
- Force bool? (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- SourcePosition SourcePosition? (任意)追加日: v1.14#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準としたこの点で、ソース要素をクリックします。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- TargetPosition TargetPosition? (任意)追加日: v1.14#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準としたこの点で、ターゲット要素上にドロップします。指定しない場合、要素の表示可能な点が使用されます。
- Timeout [float]? (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (任意)#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。

戻り値

void #

EvaluateAsync

v1.9より前に追加

frame.EvaluateAsync

expressionの戻り値を返します。

Frame.EvaluateAsync()に渡された関数がPromiseを返す場合、Frame.EvaluateAsync()はそのPromiseが解決されるのを待ち、その値を返します。

Frame.EvaluateAsync()に渡された関数が非Serializableな値を返す場合、Frame.EvaluateAsync()はundefinedを返します。Playwrightは、JSONによってシリアル化できない追加の値（-0、NaN、Infinity、-Infinity）も転送をサポートしています。

使用方法

var result = await frame.EvaluateAsync<int>("([x, y]) => Promise.resolve(x * y)", new[] { 7, 8 });
Console.WriteLine(result);

関数の代わりに文字列を渡すこともできます。

Console.WriteLine(await frame.EvaluateAsync<int>("1 + 2")); // prints "3"

ElementHandleインスタンスは、Frame.EvaluateAsync()への引数として渡すことができます。

var bodyHandle = await frame.EvaluateAsync("document.body");
var html = await frame.EvaluateAsync<string>("([body, suffix]) => body.innerHTML + suffix", new object [] { bodyHandle, "hello" });
await bodyHandle.DisposeAsync();

引数

expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数に評価される場合、その関数は自動的に呼び出されます。
arg EvaluationArgument? (任意)#

expressionに渡すオプションの引数。

戻り値

[object]#

EvaluateHandleAsync

v1.9より前に追加

frame.EvaluateHandleAsync

expressionの戻り値をJSHandleとして返します。

Frame.EvaluateAsync()とFrame.EvaluateHandleAsync()の唯一の違いは、Frame.EvaluateHandleAsync()がJSHandleを返すことです。

Frame.EvaluateHandleAsync()に渡された関数がPromiseを返す場合、Frame.EvaluateHandleAsync()はそのPromiseが解決されるのを待ち、その値を返します。

使用方法

// Handle for the window object.
var aWindowHandle = await frame.EvaluateHandleAsync("() => Promise.resolve(window)");

関数の代わりに文字列を渡すこともできます。

var docHandle = await frame.EvaluateHandleAsync("document"); // Handle for the `document`

JSHandleインスタンスは、Frame.EvaluateHandleAsync()への引数として渡すことができます。

var handle = await frame.EvaluateHandleAsync("() => document.body");
var resultHandle = await frame.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 #

FrameElementAsync

v1.9より前に追加

frame.FrameElementAsync

このフレームに対応するframeまたはiframe要素ハンドルを返します。

これはElementHandle.ContentFrameAsync()の逆です。返されるハンドルは実際には親フレームに属することに注意してください。

このメソッドは、frameElement()が返される前にフレームがデタッチされた場合、エラーをスローします。

使用方法

var frameElement = await frame.FrameElementAsync();
var contentFrame = await frameElement.ContentFrameAsync();
Console.WriteLine(frame == contentFrame); // -> True

戻り値

ElementHandle #

FrameLocator

追加日: v1.17

frame.FrameLocator

iframeを操作する場合、iframeに入り、そのiframe内の要素を選択できるフレームロケーターを作成できます。

使用方法

以下のスニペットは、IDがmy-frameであるiframe内のテキスト「Submit」を持つ要素（例: <iframe id="my-frame">）を特定します。

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

引数

selector string #

DOM要素を解決するときに使用するセレクター。

戻り値

FrameLocator #

GetByAltText

追加日: v1.27

frame.GetByAltText

要素をそのaltテキストで特定できます。

使用方法

例えば、このメソッドはaltテキスト「Playwright logo」で画像を見つけます。

<img alt='Playwright logo'>

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

引数

text string | Regex #

要素を特定するためのテキスト。
options FrameGetByAltTextOptions? (任意)
- Exact bool? (任意)#
  
  正確な一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトはfalseです。正規表現で特定する場合は無視されます。正確な一致でも空白はトリミングされます。

戻り値

Locator #

GetByLabel

追加日: v1.27

frame.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 FrameGetByLabelOptions? (任意)
- Exact bool? (任意)#
  
  正確な一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトはfalseです。正規表現で特定する場合は無視されます。正確な一致でも空白はトリミングされます。

戻り値

Locator #

GetByPlaceholder

追加日: v1.27

frame.GetByPlaceholder

プレースホルダーテキストで入力要素を特定できます。

使用方法

例えば、以下のDOM構造を考えてみましょう。

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

プレースホルダーテキストで入力を特定した後、入力に値を設定できます。

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

引数

text string | Regex #

要素を特定するためのテキスト。
options FrameGetByPlaceholderOptions? (任意)
- Exact bool? (任意)#
  
  正確な一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトはfalseです。正規表現で特定する場合は無視されます。正確な一致でも空白はトリミングされます。

戻り値

Locator #

GetByRole

追加日: v1.27

frame.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 FrameGetByRoleOptions? (任意)
- Checked bool? (任意)#
  
  通常、aria-checkedまたはネイティブの<input type=checkbox>コントロールによって設定される属性。
  
  aria-checkedについて詳しくはこちら。
- Disabled bool? (任意)#
  
  通常、aria-disabledまたはdisabledによって設定される属性。
  
  注意
  他のほとんどの属性とは異なり、disabledはDOM階層を通じて継承されます。aria-disabledについて詳しくはこちら。
- Exact bool? (任意)追加日: v1.28#
  
  Name|NameRegexが正確に一致するかどうか：大文字と小文字を区別し、文字列全体が一致します。デフォルトはfalseです。Name|NameRegexが正規表現の場合、無視されます。厳密な一致でも空白はトリミングされることに注意してください。
- Expanded bool? (任意)#
  
  通常、aria-expandedによって設定される属性。
  
  aria-expandedについて詳しくはこちら。
- IncludeHidden bool? (任意)#
  
  非表示の要素を照合するかどうかを制御するオプション。デフォルトでは、ARIAによって定義された非非表示要素のみがロールセレクターによって照合されます。
  
  aria-hiddenについて詳しくはこちら。
- Level int? (任意)#
  
  通常、heading、listitem、row、treeitemのロールに存在する数値属性で、<h1>-<h6>要素のデフォルト値があります。
  
  aria-levelについて詳しくはこちら。
- Name|NameRegex string? | Regex? (任意)#
  
  アクセシブルネームに一致するオプション。デフォルトでは、大文字小文字を区別せずに部分文字列を検索します。Exactを使用してこの動作を制御します。
  
  アクセシブルネームについて詳しくはこちら。
- Pressed bool? (任意)#
  
  通常、aria-pressedによって設定される属性。
  
  aria-pressedについて詳しくはこちら。
- Selected bool? (任意)#
  
  通常、aria-selectedによって設定される属性。
  
  aria-selectedについて詳しくはこちら。

戻り値

Locator #

詳細

ロールセレクターは、アクセシビリティ監査および適合性テストを置き換えるものではありませんが、ARIAガイドラインに関する早期フィードバックを提供します。

多くのHTML要素には、ロールセレクターによって認識される暗黙的に定義されたロールがあります。サポートされているすべてのロールはこちらで確認できます。ARIAガイドラインは、roleおよび/またはaria-*属性をデフォルト値に設定することで、暗黙的なロールと属性を重複させることを推奨していません。

GetByTestId

追加日: v1.27

frame.GetByTestId

テストIDで要素を特定します。

使用方法

以下のDOM構造を考えてみましょう。

<button data-testid="directions">Itinéraire</button>

テストIDで要素を特定できます。

await page.GetByTestId("directions").ClickAsync();

引数

testId string | Regex #

要素を特定するためのID。

戻り値

Locator #

詳細

デフォルトでは、data-testid属性がテストIDとして使用されます。必要に応じて、Selectors.SetTestIdAttribute()を使用して別のテストID属性を設定できます。

GetByText

追加日: v1.27

frame.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 FrameGetByTextOptions? (任意)
- Exact bool? (任意)#
  
  正確な一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトはfalseです。正規表現で特定する場合は無視されます。正確な一致でも空白はトリミングされます。

戻り値

Locator #

詳細

テキストによるマッチングは、厳密な一致であっても常に空白を正規化します。例えば、複数のスペースを1つに、改行をスペースに変換し、先頭と末尾の空白を無視します。

buttonおよびsubmitタイプの入力要素は、テキストコンテンツの代わりにそのvalueによって照合されます。例えば、テキスト"Log in"で検索すると、<input type=button value="Log in">に一致します。

GetByTitle

追加日: v1.27

frame.GetByTitle

要素をそのtitle属性で特定できます。

使用方法

以下のDOM構造を考えてみましょう。

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

タイトルテキストで要素を特定した後、問題の数をチェックできます。

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

引数

text string | Regex #

要素を特定するためのテキスト。
options FrameGetByTitleOptions? (任意)
- Exact bool? (任意)#
  
  正確な一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトはfalseです。正規表現で特定する場合は無視されます。正確な一致でも空白はトリミングされます。

戻り値

Locator #

GotoAsync

v1.9より前に追加

frame.GotoAsync

メインリソースの応答を返します。複数のリダイレクトがある場合、ナビゲーションは最後のリダイレクトの応答で解決されます。

メソッドは以下の場合にエラーをスローします。

SSLエラーがある（例：自己署名証明書の場合）。
ターゲットURLが無効。
ナビゲーション中にTimeoutを超過した。
リモートサーバーが応答しない、または到達不能。
メインリソースのロードに失敗した。

このメソッドは、リモートサーバーから404 "Not Found"や500 "Internal Server Error"を含む有効なHTTPステータスコードが返された場合でも、エラーをスローしません。これらの応答のステータスコードは、Response.Statusを呼び出すことで取得できます。

注意

このメソッドは、エラーをスローするか、メインリソースの応答を返します。唯一の例外は、about:blankへのナビゲーション、または異なるハッシュを持つ同じURLへのナビゲーションで、これらは成功しnullを返します。

注意

ヘッドレスモードはPDFドキュメントへのナビゲーションをサポートしていません。上流の問題を参照してください。

使用方法

await Frame.GotoAsync(url, options);

引数

url string #

フレームがナビゲートするURL。URLにはスキーマ（例: https://）を含める必要があります。
options FrameGotoOptions? (任意)
- Referer string? (任意)#
  
  Refererヘッダー値。提供された場合、Page.SetExtraHTTPHeadersAsync()によって設定されたrefererヘッダー値よりも優先されます。
- Timeout [float]? (任意)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (任意)#
  
  操作が成功したとみなされるタイミング。デフォルトはloadです。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したとみなす。
  - 'load' - loadイベントが発火したときに操作が終了したとみなす。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したとみなす。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
  - 'commit' - ネットワーク応答を受信し、ドキュメントの読み込みが開始されたときに操作が終了したとみなす。

戻り値

Response?#

IsDetached

v1.9より前に追加

frame.IsDetached

フレームがデタッチされている場合はtrueを、そうでない場合はfalseを返します。

使用方法

Frame.IsDetached

戻り値

bool #

IsEnabledAsync

v1.9より前に追加

frame.IsEnabledAsync

要素が有効であるかどうかを返します。

使用方法

await Frame.IsEnabledAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameIsEnabledOptions? (任意)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

bool #

Locator

追加日: v1.14

frame.Locator

このメソッドは、このページ/フレームでアクションを実行するために使用できる要素ロケーターを返します。ロケーターはアクションを実行する直前に要素に解決されるため、同じロケーターに対する一連のアクションが実際には異なるDOM要素に対して実行される可能性があります。これは、これらのアクション間でDOM構造が変更された場合に発生します。

ロケーターについて詳しくはこちら.

使用方法

Frame.Locator(selector, options);

引数

selector string #

DOM要素を解決するときに使用するセレクター。
options FrameLocatorOptions? (任意)
- Has Locator? (任意)#
  
  この相対ロケーターに一致する要素を含む結果にメソッドの結果を絞り込みます。例えば、text=Playwrightを持つarticleは<article><div>Playwright</div></article>に一致します。
  
  内部ロケーターは外部ロケーターに相対的である必要があり、ドキュメントルートからではなく、外部ロケーターの一致からクエリされます。例えば、<article><content><div>Playwright</div></content></article>内のdivを持つcontentを見つけることができます。しかし、contentの外側の要素を使用してはならないため、article divを持つcontentを検索することは失敗します。
  
  外部ロケーターと内部ロケーターは同じフレームに属する必要があることに注意してください。内部ロケーターはFrameLocatorを含んではいけません。
- HasNot Locator? (任意)追加日: v1.33#
  
  内部ロケーターに一致する要素を含まない要素に一致します。内部ロケーターは外部ロケーターに対してクエリされます。例えば、divを含まないarticleは<article><span>Playwright</span></article>に一致します。
  
  外部ロケーターと内部ロケーターは同じフレームに属する必要があることに注意してください。内部ロケーターはFrameLocatorを含んではいけません。
- HasNotText|HasNotTextRegex string? | Regex? (任意)追加日: v1.33#
  
  内部のどこかに、子要素または子孫要素に指定されたテキストを含まない要素に一致します。文字列が渡された場合、大文字と小文字を区別せず、部分文字列を検索します。
- HasText|HasTextRegex string? | Regex? (任意)#
  
  内部のどこかに、子要素または子孫要素に指定されたテキストを含む要素に一致します。文字列が渡された場合、大文字と小文字を区別せず、部分文字列を検索します。例えば、"Playwright"は<article><div>Playwright</div></article>に一致します。

戻り値

Locator #

Name

v1.9より前に追加

frame.Name

タグで指定されたフレームのname属性を返します。

名前が空の場合、代わりにid属性を返します。

注意

この値はフレームが作成されたときに一度計算され、後で属性が変更されても更新されません。

使用方法

Frame.Name

戻り値

string #

Page

v1.9より前に追加

frame.Page

このフレームを含むページを返します。

使用方法

Frame.Page

戻り値

Page #

ParentFrame

v1.9より前に追加

frame.ParentFrame

親フレームがあれば、それを返します。デタッチされたフレームとメインフレームはnullを返します。

使用方法

Frame.ParentFrame

戻り値

Frame?#

SetContentAsync

v1.9より前に追加

frame.SetContentAsync

このメソッドは内部的にdocument.write()を呼び出し、そのすべての特定の特性と動作を継承します。

使用方法

await Frame.SetContentAsync(html, options);

引数

html string #

ページに割り当てるHTMLマークアップ。
options FrameSetContentOptions? (任意)
- Timeout [float]? (任意)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (任意)#
  
  操作が成功したとみなされるタイミング。デフォルトはloadです。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したとみなす。
  - 'load' - loadイベントが発火したときに操作が終了したとみなす。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したとみなす。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
  - 'commit' - ネットワーク応答を受信し、ドキュメントの読み込みが開始されたときに操作が終了したとみなす。

戻り値

void #

TitleAsync

v1.9より前に追加

frame.TitleAsync

ページのタイトルを返します。

使用方法

await Frame.TitleAsync();

戻り値

string #

Url

v1.9より前に追加

frame.Url

フレームのURLを返します。

使用方法

Frame.Url

戻り値

string #

WaitForFunctionAsync

v1.9より前に追加

frame.WaitForFunctionAsync

expressionが真値を返したときに返り、その値を返します。

使用方法

Frame.WaitForFunctionAsync()はビューポートサイズの変化を監視するために使用できます。

using Microsoft.Playwright;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Firefox.LaunchAsync();
        var page = await browser.NewPageAsync();
        await page.SetViewportSizeAsync(50, 50);
        await page.MainFrame.WaitForFunctionAsync("window.innerWidth < 100");
    }
}

frame.waitForFunction関数の述語に引数を渡すには

var selector = ".foo";
await page.MainFrame.WaitForFunctionAsync("selector => !!document.querySelector(selector)", selector);

引数

expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数に評価される場合、その関数は自動的に呼び出されます。
arg EvaluationArgument? (任意)#

expressionに渡すオプションの引数。
options FrameWaitForFunctionOptions? (任意)
- PollingInterval [float]? (任意)#
  
  指定された場合、関数が実行される間隔（ミリ秒単位）として扱われます。デフォルトでは、オプションが指定されていない場合、expressionはrequestAnimationFrameコールバックで実行されます。
- Timeout [float]? (任意)#
  
  最大待機時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

JSHandle #

WaitForLoadStateAsync

v1.9より前に追加

frame.WaitForLoadStateAsync

必要なロード状態に達するまで待機します。

これは、フレームがデフォルトでloadの必要なロード状態に達したときに返ります。このメソッドが呼び出された時点で、ナビゲーションはコミットされている必要があります。現在のドキュメントがすでに必要な状態に達している場合、即座に解決されます。

注意

ほとんどの場合、このメソッドはPlaywrightがすべてのアクションの前に自動待機するため必要ありません。

使用方法

await frame.ClickAsync("button");
await frame.WaitForLoadStateAsync(); // Defaults to LoadState.Load

引数

state enum LoadState { Load, DOMContentLoaded, NetworkIdle }? (任意)#

待機するオプションのロード状態。デフォルトはloadです。現在のドキュメントのロード中にすでに状態に達している場合、メソッドはすぐに解決されます。以下のいずれかです。
- 'load' - loadイベントが発火するまで待機する。
- 'domcontentloaded' - DOMContentLoadedイベントが発火するまで待機する。
- 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がないまで待機する。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
options FrameWaitForLoadStateOptions? (任意)
- Timeout [float]? (任意)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

WaitForURLAsync

追加日: v1.11

frame.WaitForURLAsync

フレームが指定されたURLにナビゲートするまで待機します。

使用方法

await frame.ClickAsync("a.delayed-navigation"); // clicking the link will indirectly cause a navigation
await frame.WaitForURLAsync("**/target.html");

引数

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

ナビゲーションを待機中に一致させるグロブパターン、正規表現パターン、またはURLを受け取る述語。ワイルドカード文字を含まない文字列がパラメータとして渡された場合、メソッドは文字列と完全に一致するURLへのナビゲーションを待機します。
options FrameWaitForURLOptions? (任意)
- Timeout [float]? (任意)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (任意)#
  
  操作が成功したとみなされるタイミング。デフォルトはloadです。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したとみなす。
  - 'load' - loadイベントが発火したときに操作が終了したとみなす。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したとみなす。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
  - 'commit' - ネットワーク応答を受信し、ドキュメントの読み込みが開始されたときに操作が終了したとみなす。

戻り値

void #

非推奨

CheckAsync

v1.9より前に追加

frame.CheckAsync

推奨しません

ロケーターベースのLocator.CheckAsync()を使用してください。ロケーターについて詳しくはこちら。

このメソッドは、セレクターに一致する要素を以下の手順でチェックします。

セレクターに一致する要素を見つけます。見つからない場合は、一致する要素がDOMにアタッチされるまで待機します。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはスローします。要素がすでにチェックされている場合、このメソッドは即座に返ります。
Forceオプションが設定されていない限り、一致した要素に対するアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて要素をビューにスクロールします。
Page.Mouseを使用して要素の中央をクリックします。
要素が現在チェックされていることを確認します。そうでない場合、このメソッドはスローします。

すべての手順が指定されたTimeout内に完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロに設定すると、これを無効にできます。

使用方法

await Frame.CheckAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameCheckOptions? (任意)
- Force bool? (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (任意)追加日: v1.11#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用する点。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (任意)追加日: v1.11#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。

戻り値

void #

ClickAsync

v1.9より前に追加

frame.ClickAsync

推奨しません

ロケーターベースのLocator.ClickAsync()を使用してください。ロケーターについて詳しくはこちら。

このメソッドは、セレクターに一致する要素を以下の手順でクリックします。

セレクターに一致する要素を見つけます。見つからない場合は、一致する要素がDOMにアタッチされるまで待機します。
Forceオプションが設定されていない限り、一致した要素に対するアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて要素をビューにスクロールします。
Page.Mouseを使用して、要素の中央、または指定されたPositionをクリックします。
NoWaitAfterオプションが設定されていない限り、開始されたナビゲーションが成功または失敗するまで待機します。

使用方法

await Frame.ClickAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameClickOptions? (任意)
- Button enum MouseButton { Left, Right, Middle }? (任意)#
  
  デフォルトはleftです。
- ClickCount int? (任意)#
  
  デフォルトは1です。UIEvent.detailを参照してください。
- Delay [float]? (任意)#
  
  mousedownとmouseupの間の待機時間（ミリ秒単位）。デフォルトは0です。
- Force bool? (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (任意)#
  
  押すモディファイアキー。操作中にこれらのモディファイアのみが押されていることを保証し、その後現在のモディファイアを元に戻します。指定しない場合、現在押されているモディファイアが使用されます。「ControlOrMeta」は、WindowsおよびLinuxでは「Control」に、macOSでは「Meta」に解決されます。
- NoWaitAfter bool? (任意)#
  
  非推奨
  このオプションは将来的にtrueがデフォルトになります。
  
  ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページの読み込みが開始されるのを待機します。このフラグを設定することで待機をオプトアウトできます。このオプションは、アクセスできないページへのナビゲーションなどの例外的な場合にのみ必要です。デフォルトはfalseです。
- Position Position? (任意)#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用する点。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (任意)追加日: v1.11#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。キーボードのmodifiersは、trialに関係なく押され、これらのキーが押されている場合にのみ表示される要素をテストできることに注意してください。

戻り値

void #

DblClickAsync

v1.9より前に追加

frame.DblClickAsync

推奨しません

ロケーターベースのLocator.DblClickAsync()を使用してください。ロケーターについて詳しくはこちら。

このメソッドは、セレクターに一致する要素を以下の手順でダブルクリックします。

セレクターに一致する要素を見つけます。見つからない場合は、一致する要素がDOMにアタッチされるまで待機します。
Forceオプションが設定されていない限り、一致した要素に対するアクション可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて要素をビューにスクロールします。
Page.Mouseを使用して、要素の中央、または指定されたPositionをダブルクリックします。dblclick()の最初のクリックでナビゲーションイベントがトリガーされた場合、このメソッドはスローされます。

注意

frame.dblclick()は、2つのclickイベントと1つのdblclickイベントをディスパッチします。

使用方法

await Frame.DblClickAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameDblClickOptions? (任意)
- Button enum MouseButton { Left, Right, Middle }? (任意)#
  
  デフォルトはleftです。
- Delay [float]? (任意)#
  
  mousedownとmouseupの間の待機時間（ミリ秒単位）。デフォルトは0です。
- Force bool? (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (任意)#
  
  押すモディファイアキー。操作中にこれらのモディファイアのみが押されていることを保証し、その後現在のモディファイアを元に戻します。指定しない場合、現在押されているモディファイアが使用されます。「ControlOrMeta」は、WindowsおよびLinuxでは「Control」に、macOSでは「Meta」に解決されます。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (オプション)#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用する点。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (任意)追加日: v1.11#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。キーボードのmodifiersは、trialに関係なく押され、これらのキーが押されている場合にのみ表示される要素をテストできることに注意してください。

戻り値

void #

DispatchEventAsync

v1.9より前に追加

frame.DispatchEventAsync

推奨しません

代わりにロケーターベースの Locator.DispatchEventAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

以下のスニペットは、要素に対して`click`イベントをディスパッチします。要素の可視状態に関わらず、`click`はディスパッチされます。これは、element.click()を呼び出すのと同等です。

使用方法

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

内部的には、指定されたタイプに基づいてイベントのインスタンスを作成し、eventInitプロパティで初期化し、要素でディスパッチします。イベントはデフォルトで`composed`、`cancelable`、バブルします。

eventInitはイベント固有であるため、初期プロパティのリストについてはイベントのドキュメントを参照してください。

ライブオブジェクトをイベントに渡したい場合は、プロパティ値として`JSHandle`を指定することもできます。

// Note you can only create DataTransfer in Chromium and Firefox
var dataTransfer = await frame.EvaluateHandleAsync("() => new DataTransfer()");
await frame.DispatchEventAsync("#source", "dragstart", new { dataTransfer });

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
type string #

DOMイベントタイプ: "click"、"dragstart"など。
eventInit EvaluationArgument? (オプション)#

オプションのイベント固有の初期化プロパティ。
options FrameDispatchEventOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

EvalOnSelectorAsync

追加: v1.9

frame.EvalOnSelectorAsync

推奨しません

このメソッドは、要素がアクション可能チェックに合格するのを待たないため、不安定なテストにつながる可能性があります。代わりにLocator.EvaluateAsync()、その他のLocatorヘルパーメソッド、またはウェブファーストのアサーションを使用してください。

expressionの戻り値を返します。

このメソッドは、フレーム内で指定されたセレクターに一致する要素を見つけ、それをexpressionの最初の引数として渡します。セレクターに一致する要素がない場合、このメソッドはエラーをスローします。

もしexpressionがPromiseを返す場合、Frame.EvalOnSelectorAsync()はそのPromiseが解決されるのを待ち、その値を返します。

使用方法

var searchValue = await frame.EvalOnSelectorAsync<string>("#search", "el => el.value");
var preloadHref = await frame.EvalOnSelectorAsync<string>("link[rel=preload]", "el => el.href");
var html = await frame.EvalOnSelectorAsync(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");

引数

selector string #

クエリ対象のセレクター。
expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数に評価される場合、その関数は自動的に呼び出されます。
arg EvaluationArgument? (オプション)#

expressionに渡すオプションの引数。
options FrameEvalOnSelectorOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

戻り値

[object]#

EvalOnSelectorAllAsync

追加: v1.9

frame.EvalOnSelectorAllAsync

推奨しません

ほとんどの場合、Locator.EvaluateAllAsync()、その他のLocatorヘルパーメソッド、およびウェブファーストのアサーションの方が優れています。

expressionの戻り値を返します。

このメソッドは、フレーム内で指定されたセレクターに一致するすべての要素を見つけ、一致した要素の配列をexpressionの最初の引数として渡します。

もしexpressionがPromiseを返す場合、Frame.EvalOnSelectorAllAsync()はそのPromiseが解決されるのを待ち、その値を返します。

使用方法

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

引数

selector string #

クエリ対象のセレクター。
expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数に評価される場合、その関数は自動的に呼び出されます。
arg EvaluationArgument? (オプション)#

expressionに渡すオプションの引数。

戻り値

[object]#

FillAsync

v1.9より前に追加

frame.FillAsync

推奨しません

代わりにロケーターベースの Locator.FillAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

このメソッドは、セレクターに一致する要素を待ち、アクション可能チェックを待ち、要素にフォーカスし、値を入力し、入力後に`input`イベントをトリガーします。空の文字列を渡すことで入力フィールドをクリアできることに注意してください。

ターゲット要素が`<input>`、`<textarea>`、または`[contenteditable]`要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連するcontrolを持つ`<label>`要素内にある場合は、代わりにそのコントロールが入力されます。

きめ細かいキーボードイベントを送信するには、Locator.PressSequentiallyAsync()を使用してください。

使用方法

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

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
value string #

`<input>`、`<textarea>`、または`[contenteditable]`要素に入力する値。
options FrameFillOptions? (オプション)
- Force bool? (オプション)追加日: v1.13#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

FocusAsync

v1.9より前に追加

frame.FocusAsync

推奨しません

代わりにロケーターベースの Locator.FocusAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

このメソッドは、セレクターに一致する要素を取得し、そこにフォーカスします。セレクターに一致する要素がない場合、このメソッドは一致する要素がDOMに表示されるまで待機します。

使用方法

await Frame.FocusAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameFocusOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

GetAttributeAsync

v1.9より前に追加

frame.GetAttributeAsync

推奨しません

代わりにロケーターベースの Locator.GetAttributeAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

要素の属性値を返します。

使用方法

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

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
name string #

値を取得する属性名。
options FrameGetAttributeOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

string?#

HoverAsync

v1.9より前に追加

frame.HoverAsync

推奨しません

代わりにロケーターベースの Locator.HoverAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

このメソッドは、以下のステップを実行して、セレクターに一致する要素にホバーします。

セレクターに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
Forceオプションが設定されていない限り、マッチした要素に対するアクション可能チェックを待機します。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて要素をビューにスクロールします。
要素の中心、または指定されたPositionにホバーするには、Page.Mouseを使用します。

指定されたTimeout期間中にすべてのステップが完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトに0を渡すと、これを無効にできます。

使用方法

await Frame.HoverAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameHoverOptions? (オプション)
- 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]
  要素のパディングボックスの左上隅を基準に使用する点。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (任意)追加日: v1.11#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。キーボードのmodifiersは、trialに関係なく押され、これらのキーが押されている場合にのみ表示される要素をテストできることに注意してください。

戻り値

void #

InnerHTMLAsync

v1.9より前に追加

frame.InnerHTMLAsync

推奨しません

代わりにロケーターベースの Locator.InnerHTMLAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

`element.innerHTML`を返します。

使用方法

await Frame.InnerHTMLAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameInnerHTMLOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

string #

InnerTextAsync

v1.9より前に追加

frame.InnerTextAsync

推奨しません

代わりにロケーターベースの Locator.InnerTextAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

`element.innerText`を返します。

使用方法

await Frame.InnerTextAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameInnerTextOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

string #

InputValueAsync

追加日: v1.13

frame.InputValueAsync

推奨しません

代わりにロケーターベースの Locator.InputValueAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

選択された`<input>`または`<textarea>`または`<select>`要素の`input.value`を返します。

非入力要素に対してはエラーをスローします。ただし、要素が関連するcontrolを持つ`<label>`要素内にある場合は、そのコントロールの値を返します。

使用方法

await Frame.InputValueAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameInputValueOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

string #

IsCheckedAsync

v1.9より前に追加

frame.IsCheckedAsync

推奨しません

代わりにロケーターベースの Locator.IsCheckedAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

要素がチェックされているかどうかを返します。要素がチェックボックスまたはラジオ入力でない場合はエラーをスローします。

使用方法

await Frame.IsCheckedAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameIsCheckedOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

bool #

IsDisabledAsync

v1.9より前に追加

frame.IsDisabledAsync

推奨しません

代わりにロケーターベースの Locator.IsDisabledAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

要素が無効であるかどうか（enabledの反対）を返します。

使用方法

await Frame.IsDisabledAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameIsDisabledOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

bool #

IsEditableAsync

v1.9より前に追加

frame.IsEditableAsync

推奨しません

代わりにロケーターベースの Locator.IsEditableAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

要素が編集可能であるかどうかを返します。

使用方法

await Frame.IsEditableAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameIsEditableOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

bool #

IsHiddenAsync

v1.9より前に追加

frame.IsHiddenAsync

推奨しません

代わりにロケーターベースの Locator.IsHiddenAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

要素が非表示であるかどうか（visibleの反対）を返します。要素に一致しないセレクターは非表示と見なされます。

使用方法

await Frame.IsHiddenAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameIsHiddenOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  非推奨
  このオプションは無視されます。Frame.IsHiddenAsync()は要素が非表示になるのを待たず、すぐに返します。

戻り値

bool #

IsVisibleAsync

v1.9より前に追加

frame.IsVisibleAsync

推奨しません

代わりにロケーターベースの Locator.IsVisibleAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

要素がvisibleであるかどうかを返します。要素に一致しないセレクターは表示されていないと見なされます。

使用方法

await Frame.IsVisibleAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameIsVisibleOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  非推奨
  このオプションは無視されます。Frame.IsVisibleAsync()は要素が表示されるのを待たず、すぐに返します。

戻り値

bool #

PressAsync

v1.9より前に追加

frame.PressAsync

推奨しません

代わりにロケーターベースの Locator.PressAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

keyは、意図するkeyboardEvent.keyの値、またはテキストを生成するための単一の文字を指定できます。key値のスーパーセットはこちらで確認できます。キーの例は以下の通りです。

F1 - F12、Digit0- Digit9、KeyA- KeyZ、Backquote、Minus、Equal、Backslash、Backspace、Tab、Delete、Escape、ArrowDown、End、Enter、Home、Insert、PageDown、PageUp、ArrowRight、ArrowUpなど。

以下の修飾ショートカットもサポートされています: Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。`ControlOrMeta`はWindowsとLinuxでは`Control`に、macOSでは`Meta`に解決されます。

`Shift`を押しながら入力すると、keyに対応するテキストが大文字で入力されます。

keyが単一の文字の場合、大文字と小文字が区別されるため、`a`と`A`の値はそれぞれ異なるテキストを生成します。

key: "Control+o"、key: "Control++、key: "Control+Shift+T"などのショートカットもサポートされています。修飾子と一緒に指定した場合、後続のキーが押されている間、修飾子は押されたままになります。

使用方法

await Frame.PressAsync(selector, key, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
key string #

押すキーの名前、または生成する文字（例: `ArrowLeft`または`a`）。
options FramePressOptions? (オプション)
- Delay [float]? (オプション)#
  
  `keydown`と`keyup`の間で待機する時間（ミリ秒単位）。デフォルトは0です。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは将来的にtrueがデフォルトになります。
  
  ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページの読み込みが開始されるのを待機します。このフラグを設定することで待機をオプトアウトできます。このオプションは、アクセスできないページへのナビゲーションなどの例外的な場合にのみ必要です。デフォルトはfalseです。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

QuerySelectorAsync

追加: v1.9

frame.QuerySelectorAsync

推奨しません

代わりにロケーターベースの Frame.Locator() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

フレーム要素を指す`ElementHandle`を返します。

注意

ElementHandleの使用は推奨されません。代わりにLocatorオブジェクトとウェブファーストのアサーションを使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致する要素を見つけます。セレクターに一致する要素がない場合、`null`を返します。

使用方法

await Frame.QuerySelectorAsync(selector, options);

引数

selector string #

クエリ対象のセレクター。
options FrameQuerySelectorOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。

戻り値

ElementHandle?#

QuerySelectorAllAsync

追加: v1.9

frame.QuerySelectorAllAsync

推奨しません

代わりにロケーターベースの Frame.Locator() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

フレーム要素を指す`ElementHandles`を返します。

注意

ElementHandleの使用は推奨されません。代わりにLocatorオブジェクトを使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致するすべての要素を見つけます。セレクターに一致する要素がない場合、空の配列を返します。

使用方法

await Frame.QuerySelectorAllAsync(selector);

引数

selector string #

クエリ対象のセレクター。

戻り値

IReadOnlyList<ElementHandle>#

v1.9より前に追加

frame.RunAndWaitForNavigationAsync

非推奨

このメソッドは本質的に競合状態をはらんでいるため、代わりにFrame.WaitForURLAsync()を使用してください。

フレームのナビゲーションを待ち、メインリソースの応答を返します。複数のリダイレクトがある場合、ナビゲーションは最後のリダイレクトの応答で解決されます。異なるアンカーへのナビゲーションやHistory APIの使用によるナビゲーションの場合、ナビゲーションは`null`で解決されます。

使用方法

このメソッドは、フレームが新しいURLにナビゲートするのを待ちます。これは、フレームが間接的にナビゲートする原因となるコードを実行する場合に役立ちます。以下の例を検討してください。

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // Clicking the link will indirectly cause a navigation.
    await frame.ClickAsync("a.delayed-navigation");
});

// Resolves after navigation has finished

注意

URLを変更するためのHistory APIの使用は、ナビゲーションと見なされます。

引数

action Func<Task>追加: v1.12#

イベントをトリガーするアクション。
options FrameRunAndWaitForNavigationOptions? (オプション)
- Timeout [float]? (オプション)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool> (オプション)#
  
  ナビゲーションを待機中に一致させるグロブパターン、正規表現パターン、またはURLを受け取る述語。ワイルドカード文字を含まない文字列がパラメータとして渡された場合、メソッドは文字列と完全に一致するURLへのナビゲーションを待機します。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (オプション)#
  
  操作が成功したとみなされるタイミング。デフォルトはloadです。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したとみなす。
  - 'load' - loadイベントが発火したときに操作が終了したとみなす。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したとみなす。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
  - 'commit' - ネットワーク応答を受信し、ドキュメントの読み込みが開始されたときに操作が終了したとみなす。

戻り値

Response?#

v1.9より前に追加

frame.WaitForNavigationAsync

非推奨

このメソッドは本質的に競合状態をはらんでいるため、代わりにFrame.WaitForURLAsync()を使用してください。

使用方法

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // Clicking the link will indirectly cause a navigation.
    await frame.ClickAsync("a.delayed-navigation");
});

// Resolves after navigation has finished

注意

URLを変更するためのHistory APIの使用は、ナビゲーションと見なされます。

引数

options FrameRunAndWaitForNavigationOptions? (オプション)
- Timeout [float]? (オプション)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒で、0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool> (オプション)#
  
  ナビゲーションを待機中に一致させるグロブパターン、正規表現パターン、またはURLを受け取る述語。ワイルドカード文字を含まない文字列がパラメータとして渡された場合、メソッドは文字列と完全に一致するURLへのナビゲーションを待機します。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (オプション)#
  
  操作が成功したとみなされるタイミング。デフォルトはloadです。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が終了したとみなす。
  - 'load' - loadイベントが発火したときに操作が終了したとみなす。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がないときに操作が終了したとみなす。テストにはこのメソッドを使用せず、代わりにWebアサーションに依存して準備状況を評価してください。
  - 'commit' - ネットワーク応答を受信し、ドキュメントの読み込みが開始されたときに操作が終了したとみなす。

戻り値

Response?#

SelectOptionAsync

v1.9より前に追加

frame.SelectOptionAsync

推奨しません

代わりにロケーターベースの Locator.SelectOptionAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

このメソッドは、セレクターに一致する要素を待ち、アクション可能チェックを待ち、指定されたすべてのオプションが`<select>`要素に存在することを確認してから、それらのオプションを選択します。

ターゲット要素が`<select>`要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連するcontrolを持つ`<label>`要素内にある場合は、代わりにそのコントロールが使用されます。

正常に選択されたオプション値の配列を返します。

提供されたすべてのオプションが選択されると、`change`イベントと`input`イベントをトリガーします。

使用方法

// Single selection matching the value or label
await frame.SelectOptionAsync("select#colors", new[] { "blue" });
// single selection matching both the value and the label
await frame.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection
await frame.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" });

引数

selector string #

クエリ対象のセレクター。
values string | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#
- Value string? (オプション)
  
  `option.value`による一致。オプション。
- Label string? (オプション)
  
  `option.label`による一致。オプション。
- Index int? (オプション)
  
  インデックスによる一致。オプション。
選択するオプション。`<select>`に`multiple`属性がある場合、一致するすべてのオプションが選択されます。それ以外の場合、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。文字列値は値とラベルの両方に一致します。すべての指定されたプロパティが一致する場合、オプションは一致すると見なされます。
options FrameSelectOptionOptions? (オプション)
- Force bool? (オプション)追加日: v1.13#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

IReadOnlyList<string>#

SetCheckedAsync

追加: v1.15

frame.SetCheckedAsync

推奨しません

代わりにロケーターベースの Locator.SetCheckedAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

このメソッドは、以下のステップを実行して、セレクターに一致する要素をチェックまたはアンチェックします。

セレクターに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはエラーをスローします。
要素がすでに正しいチェック状態である場合、このメソッドはすぐに返します。
Forceオプションが設定されていない限り、マッチした要素に対するアクション可能チェックを待機します。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて要素をビューにスクロールします。
Page.Mouseを使用して要素の中央をクリックします。
要素が現在チェックされているか、またはチェック解除されていることを確認します。そうでない場合、このメソッドはエラーをスローします。

使用方法

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

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
checkedState bool #

チェックボックスをチェックするか、チェック解除するか。
options FrameSetCheckedOptions? (オプション)
- Force bool? (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (オプション)#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用する点。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (オプション)#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (オプション)#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。

戻り値

void #

SetInputFilesAsync

v1.9より前に追加

frame.SetInputFilesAsync

推奨しません

代わりにロケーターベースの Locator.SetInputFilesAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

ファイル入力の値をこれらのファイルパスまたはファイルに設定します。一部の`filePaths`が相対パスの場合、それらは現在の作業ディレクトリを基準に解決されます。空の配列の場合、選択されたファイルをクリアします。

このメソッドは、セレクターがinput要素を指すことを想定しています。ただし、要素が関連するcontrolを持つ`<label>`要素内にある場合は、代わりにそのコントロールをターゲットとします。

使用方法

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

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#
- Name string
  
  ファイル名
- MimeType string
  
  ファイルタイプ
- Buffer byte[]
  
  ファイルの内容
options FrameSetInputFilesOptions? (オプション)
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

TapAsync

v1.9より前に追加

frame.TapAsync

推奨しません

代わりにロケーターベースの Locator.TapAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

このメソッドは、以下のステップを実行して、セレクターに一致する要素をタップします。

セレクターに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
Forceオプションが設定されていない限り、マッチした要素に対するアクション可能チェックを待機します。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて要素をビューにスクロールします。
要素の中心、または指定されたPositionをタップするには、Page.Touchscreenを使用します。

注意

`frame.tap()`を使用するには、ブラウザコンテキストの`hasTouch`オプションを`true`に設定する必要があります。

使用方法

await Frame.TapAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameTapOptions? (オプション)
- Force bool? (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (オプション)#
  
  押すモディファイアキー。操作中にこれらのモディファイアのみが押されていることを保証し、その後現在のモディファイアを元に戻します。指定しない場合、現在押されているモディファイアが使用されます。「ControlOrMeta」は、WindowsおよびLinuxでは「Control」に、macOSでは「Meta」に解決されます。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (オプション)#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用する点。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (任意)追加日: v1.11#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。キーボードのmodifiersは、trialに関係なく押され、これらのキーが押されている場合にのみ表示される要素をテストできることに注意してください。

戻り値

void #

TextContentAsync

v1.9より前に追加

frame.TextContentAsync

推奨しません

代わりにロケーターベースの Locator.TextContentAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

`element.textContent`を返します。

使用方法

await Frame.TextContentAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameTextContentOptions? (オプション)
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

string?#

TypeAsync

v1.9より前に追加

frame.TypeAsync

非推奨

ほとんどの場合、代わりにLocator.FillAsync()を使用すべきです。ページに特別なキーボード処理がある場合にのみ、キーを1つずつ押す必要があります。その場合はLocator.PressSequentiallyAsync()を使用してください。

テキスト内の各文字に対して、`keydown`、`keypress`/`input`、および`keyup`イベントを送信します。`frame.type`は、きめ細かいキーボードイベントを送信するために使用できます。フォームフィールドに値を入力するには、Frame.FillAsync()を使用してください。

`Control`や`ArrowDown`のような特殊キーを押すには、Keyboard.PressAsync()を使用してください。

使用方法

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
text string #

フォーカスされた要素に入力するテキスト。
options FrameTypeOptions? (オプション)
- Delay [float]? (オプション)#
  
  キー押下間の待機時間（ミリ秒単位）。デフォルトは0です。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

UncheckAsync

v1.9より前に追加

frame.UncheckAsync

推奨しません

代わりにロケーターベースの Locator.UncheckAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

このメソッドは、以下のステップを実行して、セレクターに一致する要素をアンチェックします。

セレクターに一致する要素を見つけます。見つからない場合、一致する要素がDOMにアタッチされるまで待機します。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはエラーをスローします。要素がすでにチェック解除されている場合、このメソッドはすぐに返します。
Forceオプションが設定されていない限り、マッチした要素に対するアクション可能チェックを待機します。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて要素をビューにスクロールします。
Page.Mouseを使用して要素の中央をクリックします。
要素が現在チェック解除されていることを確認します。そうでない場合、このメソッドはエラーをスローします。

使用方法

await Frame.UncheckAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。複数の要素がセレクターを満たす場合、最初に見つかったものが使用されます。
options FrameUncheckOptions? (オプション)
- Force bool? (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (任意)追加日: v1.11#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用する点。指定しない場合、要素の表示可能な点が使用されます。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Trial bool? (任意)追加日: v1.11#
  
  設定されている場合、このメソッドはアクション可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待つ場合に便利です。

戻り値

void #

WaitForSelectorAsync

v1.9より前に追加

frame.WaitForSelectorAsync

推奨しません

可視性をアサートするウェブアサーション、またはロケーターベースの Locator.WaitForAsync() を使用してください。ロケーターについて詳しくはこちらをご覧ください。locators。

セレクターで指定された要素がStateオプションを満たしたときに返します。`hidden`または`detached`を待機している場合、`null`を返します。

注意

Playwrightは、アクションを実行する前に要素が準備完了になるのを自動的に待機します。Locatorオブジェクトとウェブファーストのアサーションを使用することで、コードはセレクター待機不要になります。

セレクターがStateオプション（DOMに表示/非表示になる、または可視/非可視になる）を満たすまで待機します。メソッド呼び出し時にセレクターがすでに条件を満たしている場合、メソッドはすぐに返します。セレクターがTimeoutミリ秒間条件を満たさない場合、関数はエラーをスローします。

使用方法

このメソッドはナビゲーションをまたいで機能します。

using Microsoft.Playwright;
using System;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Chromium.LaunchAsync();
        var page = await browser.NewPageAsync();

        foreach (var currentUrl in new[] { "https://www.google.com", "https://bbc.com" })
        {
            await page.GotoAsync(currentUrl);
            element = await page.MainFrame.WaitForSelectorAsync("img");
            Console.WriteLine($"Loaded image: {await element.GetAttributeAsync("src")}");
        }
    }
}

引数

selector string #

クエリ対象のセレクター。
options FrameWaitForSelectorOptions? (オプション)
- State enum WaitForSelectorState { Attached, Detached, Visible, Hidden }? (オプション)#
  
  デフォルトは`'visible'`です。以下のいずれかになります。
  - 'attached' - DOMに要素が存在するのを待機します。
  - 'detached' - DOMに要素が存在しないのを待機します。
  - 'visible' - 要素が空でないバウンディングボックスを持ち、`visibility:hidden`でないのを待機します。コンテンツがない要素、または`display:none`の要素は空のバウンディングボックスを持ち、可視とは見なされないことに注意してください。
  - 'hidden' - 要素がDOMからデタッチされるか、空のバウンディングボックスを持つか、または`visibility:hidden`になるのを待機します。これは`'visible'`オプションの反対です。
- Strict bool? (任意)追加日: v1.14#
  
  trueの場合、呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは30000（30秒）です。0を渡すとタイムアウトが無効になります。デフォルト値はBrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

ElementHandle?#

WaitForTimeoutAsync

v1.9より前に追加

frame.WaitForTimeoutAsync

推奨しません

本番環境ではタイムアウトを待機しないでください。時間を待機するテストは本質的に不安定です。`Locator`アクションと自動的に待機するウェブアサーションを使用してください。

指定されたtimeout（ミリ秒単位）だけ待機します。

`frame.waitForTimeout()`はデバッグ目的でのみ使用すべきであることに注意してください。本番環境でタイマーを使用するテストは不安定になります。代わりに、ネットワークイベントやセレクターの可視化などのシグナルを使用してください。

使用方法

await Frame.WaitForTimeoutAsync(timeout);

引数

timeout [float]#

待機するタイムアウト値

戻り値

void #

メソッド​

AddScriptTagAsync​

AddStyleTagAsync​

ChildFrames​

ContentAsync​

DragAndDropAsync​

EvaluateAsync​

EvaluateHandleAsync​

FrameElementAsync​

FrameLocator​

GetByAltText​

GetByLabel​

GetByPlaceholder​

GetByRole​

GetByTestId​

GetByText​

GetByTitle​

GotoAsync​

IsDetached​

IsEnabledAsync​

Locator​

Name​

Page​

ParentFrame​

SetContentAsync​

TitleAsync​

Url​

WaitForFunctionAsync​

WaitForLoadStateAsync​

WaitForURLAsync​

非推奨​

CheckAsync​

ClickAsync​

DblClickAsync​

DispatchEventAsync​

EvalOnSelectorAsync​

EvalOnSelectorAllAsync​

FillAsync​

FocusAsync​

GetAttributeAsync​

HoverAsync​

InnerHTMLAsync​

InnerTextAsync​

InputValueAsync​

IsCheckedAsync​

IsDisabledAsync​

IsEditableAsync​

IsHiddenAsync​

IsVisibleAsync​

PressAsync​

QuerySelectorAsync​

QuerySelectorAllAsync​

RunAndWaitForNavigationAsync​

WaitForNavigationAsync​

SelectOptionAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

TypeAsync​

UncheckAsync​

WaitForSelectorAsync​

WaitForTimeoutAsync​

メソッド

AddScriptTagAsync

AddStyleTagAsync

ChildFrames

ContentAsync

DragAndDropAsync

EvaluateAsync

EvaluateHandleAsync

FrameElementAsync

FrameLocator

GetByAltText

GetByLabel

GetByPlaceholder

GetByRole

GetByTestId

GetByText

GetByTitle

GotoAsync

IsDetached

IsEnabledAsync

Locator

Name

Page

ParentFrame

SetContentAsync

TitleAsync

Url

WaitForFunctionAsync

WaitForLoadStateAsync

WaitForURLAsync

非推奨

CheckAsync

ClickAsync

DblClickAsync

DispatchEventAsync

EvalOnSelectorAsync

EvalOnSelectorAllAsync

FillAsync

FocusAsync

GetAttributeAsync

HoverAsync

InnerHTMLAsync

InnerTextAsync

InputValueAsync

IsCheckedAsync

IsDisabledAsync

IsEditableAsync

IsHiddenAsync

IsVisibleAsync

PressAsync

QuerySelectorAsync

QuerySelectorAllAsync

RunAndWaitForNavigationAsync

WaitForNavigationAsync

SelectOptionAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync

TypeAsync

UncheckAsync

WaitForSelectorAsync

WaitForTimeoutAsync