【SeleniumBasic】クラス、メソッド、プロパティ一覧表(日本語版)(Excel VBA)

VBAスクレイピング

こんにちは、blueです。

SeleniumBasicを扱う際に確認したくなるのがクラスに属するメソッドやプロパティです。

SeleniumBasicにはこれらの情報を知るためのヘルプとしてDocumentationが同封されています。

しかし、内容が英語の為理解がしにくくなっています。

その為今回はスクレピングの際によく使うメソッドやプロパティについて日本語訳したものを紹介します。


VBAを使ったものではありませんが、Seleniumを勉強する為の基本的な書籍です。各言語における基本的なコマンド一覧も記載されていますのでコードを書く際の参考になります。

スポンサーリンク

Selenium Documentationとは

Selenium DocumentaionとはSeleniumのライブラリ情報がまとめられている文書のことです。

この文書はSeleniumをインストールした際にできた以下のフォルダ内にSelenium.chmというファイル名で存在しています。

C:\Users\(ユーザー名)\AppData\Local\SeleniumBasic

クリックすると拡大します。

ちなみににファイルを開くと以下のような画面になっています。

この方法で各クラスに属するメソッドやプロパティを確認できますが内容は英語名となっています。

Selenium Documentation日本語版

次から各クラスに属するメソッドやプロパティについて日本語訳を記載します。

なおすべてのクラスを紹介するのは大変な量の為代表的なものから記載します。

訳については自動翻訳を利用していますので誤訳はご了承ください。

WebDriver Class

Methods

NameDescription
ActiveElementフォーカスを持つ要素、またはフォーカスを持つものがない場合はBODYを返します。
AddArgumentブラウザを起動するためのコマンドラインに付加する引数を追加します。
AddExtensionブラウザに拡張機能を追加する(Firefox、Chromeのみ)
CacheStatushtml5アプリケーションのキャッシュの状態を取得します。
Close現在のウィンドウを閉じる。
Disposeリソースを解放する。
ExecuteAsyncScript現在のフレームまたはウィンドウのコンテキストで、非同期のJavaScriptを実行します。
ExecuteScript現在選択されているフレームまたはウィンドウのコンテキストでJavaScriptの一部を実行する
FindElement指定されたメソッドを使用して、最初の WebElement を検索します。(SearchContextから継承)
FindElementBy指定された機構と値に一致する最初の子要素を検索します。(SearchContextから継承)
FindElementByClass指定された CSS クラスに合致する最初の要素を検索します。(SearchContextから継承)
FindElementByCss指定されたCSSセレクタに合致する最初の要素を検索します。(SearchContextから継承)
FindElementById指定されたidに合致する最初の要素を検索する。(SearchContextから継承)
FindElement
ByLinkText
指定されたリンクテキストに一致する最初の要素を検索します。(SearchContextから継承)
FindElement
ByName
指定された名前に一致する最初の要素を検索します。(SearchContextから継承)
FindElement
ByPartialLinkText
与えられたリンクテキストの部分に一致する要素のうち、最初のものを探す(SearchContextから継承)
FindElementByTag指定されたタグ名に合致する最初の要素を検索する。(SearchContextから継承)
FindElementByXPath指定されたXPathクエリにマッチする最初の要素を検索します。(SearchContextから継承)
FindElements与えられた機構を使用して、現在のコンテキスト内のすべての要素を検索します。(SearchContextから継承)
FindElementsBy指定された機構と値に一致する全ての子要素を検索します。(SearchContextから継承)
FindElementsByClass指定された CSS クラスに合致する要素を検索する。(SearchContextから継承)
FindElementsByCss指定されたCSSセレクタに合致する要素を検索します。(SearchContextから継承)
FindElementsById指定されたidに合致する要素を検索する。(SearchContextから継承)
FindElements
ByLinkText
指定されたリンクテキストに合致する要素を検索する。(SearchContextから継承)
FindElementsByName指定された名前に合致する要素を検索する。(SearchContextから継承)
FindElements
ByPartialLinkText
与えられたリンクテキストの部分に一致する要素のうち、最初のものを探す(SearchContextから継承)
FindElementsByTag指定されたタグの名前に合致する要素を検索する。(SearchContextから継承)
FindElementsByXPath指定されたXPathクエリに合致する要素を検索します。(SearchContextから継承)
Get現在のブラウザセッションでウェブページを読み込む。Openメソッドと同じです。
GetClipBoardクリップボードのテキストを返します。
GoBackブラウザの履歴を一歩さかのぼる。
GoForwardブラウザの履歴を一歩進める。
IsElementPresent“指定された要素がページのどこかにあるかどうかを確認します。”(SearchContextから継承)
PageSourceブラウザが最後に読み込んだページのソースを取得します。
PageSourceMatch正規表現にマッチする最初の出現箇所を返します。
PageSourceMatches正規表現に一致するすべての出現箇所を返します。
Quitブラウザを閉じ、WebDriverを破棄する
Refresh現在のページをリフレッシュする。
Sendカスタマイズされたコマンドを送信する
SendKeysキー操作のシーケンスをブラウザに送信します。
SetBinary使用するブラウザの実行ファイルへのパスを設定する
SetCapabilityWebdriverに特定のケイパビリティを設定する
SetClipBoardクリップボードのテキストを設定する
SetPreferenceFirefox Webdriverに特定のプリファレンスを設定する
SetProfileFirefox Webdriverに特定のプロファイルを設定する
Start新しいSeleniumテストセッションを開始します。
StartRemotely新しいSeleniumテストセッションをリモートで開始します。
SwitchToAlertページ上のアラートにフォーカスを移す。
SwitchTo
DefaultContent
iFrameを含むページでは、ページ上の最初のフレームかメインドキュメントを選択します。
SwitchToFrameインデックス(ゼロベース)、名前、またはWebElementで指定されたフレームにフォーカスを移します。
SwitchTo
NextWindow
次のウィンドウにフォーカスを移す。
SwitchTo
ParentFrame
現在選択されているフレームの親フレームを選択します。
SwitchTo
PreviousWindow
前のウィンドウにフォーカスを移す
SwitchTo
WindowByName
名前で指定されたウィンドウにフォーカスを移す。
SwitchTo
WindowByTitle
タイトルで指定されたウィンドウにフォーカスを移す。
TakeScreenshot現在のウィンドウのスクリーンショットを撮影します
Until< T> デリゲート関数がnot nullまたはtrueを返すのを待ちます。
Wait次のコマンドを実行する前に、指定された時間(ミリ秒単位)を待機する
WaitForScriptJavaScriptの一部がtrueまたはnullでないことを返すのを待ちます。
WaitNotElement要素が欠落するのを待つ。(SearchContextから継承)

Properties

NameDescription
Actionsアクションクラスの取得
BaseUrlGet で相対 URL を使用するためのベース URL
Keyboardキーボード
Keysキーポイント
Manageドライバに設定変更を指示する。
Mouseマウス
Proxy
Timeoutsブラウザの設定を管理します。ブラウザを起動する前に定義しておく必要がある
Title現在のブラウザウィンドウのタイトルを取得します。
TouchActionsタッチアクション
TouchScreenタッチスクリーン
Urlブラウザが現在表示しているURLを取得します。
Window現在フォーカスされているブラウザウィンドウを操作することができるオブジェクトを取得します。
Windows開いているブラウザウィンドウのウィンドウハンドルを取得します。

WebElement Class

Methods

NameDescription
AsSelectWebElementをSelect要素にキャストする
AsTableWebElementをTable要素にキャストする
Attribute属性値を取得する。
Clearテキスト入力要素の場合、テキストをクリアする。
Click要素をクリックします。
ClickAndHoldエレメントをクリックし、ホールドします。
ClickByOffset要素オフセットでクリックします。
ClickContextRigthは、エレメントをクリックします。
ClickDouble要素をダブルクリックします。
CssValueCSSプロパティの値を返す
DragAnd
DropToOffset
要素をオフセットにドラッグ&ドロップする
DragAndDropTo
WebElement
要素を他の要素にドラッグ&ドロップする
Equals(Object)指定されたインスタンスが等しいとみなされるかどうかを判定する。(Object.をオーバーライドします。Equals(Object)をオーバーライドしています)
Equals
(WebElement)
2つのWeb要素が等しいかどうかを比較する
Execute
AsyncScript
現在の要素のコンテキストで、非同期のJavaScriptを実行します。
ExecuteScript現在の要素のコンテキストで JavaScript を実行します。
FindElement指定されたメソッドを使用して、最初の WebElement を検索します。(SearchContextから継承)
FindElementBy指定された機構と値に一致する最初の子要素を検索します。(SearchContextから継承)
FindElement
ByClass
指定された CSS クラスに合致する最初の要素を検索します。(SearchContextから継承)
FindElementByCss指定されたCSSセレクタに合致する最初の要素を検索します。(SearchContextから継承)
FindElementById指定されたidに合致する最初の要素を検索する。(SearchContextから継承)
FindElement
ByLinkText
指定されたリンクテキストに一致する最初の要素を検索します。(SearchContextから継承)
FindElement
ByName
指定された名前に一致する最初の要素を検索します。(SearchContextから継承)
FindElement
ByPartialLinkText
与えられたリンクテキストの部分に一致する要素のうち、最初のものを探す(SearchContextから継承)
FindElement
ByTag
指定されたタグ名に合致する最初の要素を検索する。(SearchContextから継承)
FindElement
ByXPath
指定されたXPathクエリにマッチする最初の要素を検索します。(SearchContextから継承)
FindElements与えられた機構を使用して、現在のコンテキスト内のすべての要素を検索します。(SearchContextから継承)
FindElementsBy指定された機構と値に一致する全ての子要素を検索します。(SearchContextから継承)
FindElements
ByClass
指定された CSS クラスに合致する要素を検索する。(SearchContextから継承)
FindElements
ByCss
指定されたCSSセレクタに合致する要素を検索します。
FindElements
ById
指定されたidに合致する要素を検索する。
FindElements
ByLinkText
指定されたリンクテキストに合致する要素を検索する。(SearchContextから継承)
FindElements
ByName
指定された名前に合致する要素を検索する。(SearchContextから継承)
FindElements
ByPartialLinkText
与えられたリンクテキストの部分に一致する要素のうち、最初のものを探す(SearchContextから継承)
FindElements
ByTag
指定されたタグの名前に合致する要素を検索する。(SearchContextから継承)
FindElements
ByXPath
指定されたXPathクエリに合致する要素を検索します。
GetHashCodeこの要素のハッシュコードを返す(Objectをオーバーライドします。GetHashCode() .)
HoldKeysキーを押しながら
IsElement
Present
“指定された要素がページのどこかにあるかどうかを確認します。”(SearchContextから継承)
Locationレンダリング可能なキャンバス内の要素の位置を返します。
Location
InView
ビューポートの原点からの相対的な要素の位置を取得する。
ReleaseKeysキーを離す
ReleaseMouseクリックを解除する
ScrollIntoView現在の要素をブラウザウィンドウの可視領域までスクロールします。
SendKeys要素への入力をシミュレートします。
Size要素の大きさを返す
Submitフォームを送信します。
TakeScreenshot現在の要素のスクリーンショットを取得します
Text要素のテキストを取得します。
TextAsNumberテキストから解析された数値を返す
TextMatch指定された入力文字列を検索し、pattern パラメータで指定された正規表現に一致するものを探す。
TextMatches正規表現に一致するすべての出現箇所を返します。
Until< T> デリゲート関数がnot nullまたはtrueを返すのを待ちます。
Value値属性を返す
WaitAttribute属性待ち
WaitCssValueCSS プロパティを待ちます。
WaitDisplayed要素が表示されるのを待つ。
WaitEnabled要素が有効化されるのを待つ。
WaitForScriptスクリプトがtrueを返すか、nullでないかを待ちます。
WaitNot
Attribute
別の属性で待機する
WaitNot
CssValue
別の CSS プロパティを待ちます。
WaitNot
Element
要素が欠落するのを待つ。(SearchContextから継承)
WaitNotText別のテキストを待ちます
WaitRemovalWeb 要素が DOM から削除されるのを待ちます。
WaitSelection要素が選択されるかどうかを待機する。
WaitTextテキストを待ちます

Properties

IsDisplayedユーザから見える要素かどうか
IsEnabled要素が有効であるかどうか。
IsPresent要素が存在するかどうか
IsSelected要素が選択されているかどうか。
Rect要素の大きさを返す
TagName要素のtagNameプロパティを取得する。

WebElements Class

Methods

NameDescription
Add(Object)リスト内の値を追加する(リストより継承)
Add
(WebElement)
Web要素を追加する
AddRangeリスト内に複数の値を一度に追加する(リストより継承)
Attribute各要素に対応する属性をリストで返します。(リストより継承)
Clearリストをクリアする(リストより継承)
Containsリストが値を含む場合、true を返す。(リストより継承)
Convert< T> 各値を変換する。(リストより継承)
CopyTo値を配列にコピーします。(リストより継承)
Distinct重複を排除する(リストより継承)
Execute
AsyncScript
各Web要素に対して非同期でJavaScriptを実行し、すべての結果を返します。
ExecuteScript各Web要素に対してJavaScriptを実行し、その結果をすべて返します。
First最初の項目を返す
GetEnumeratorリスト列挙体を返します。(リストより継承)
IndexOf値のインデックスを返す(リストより継承)
Insertインデックスに値を挿入する(リストより継承)
Last最後の項目を返す
LastIndexOf末尾から始まる値のインデックス。(リストより継承)
Remove値を削除する(リストより継承)
RemoveAtインデックスにある値を削除する(リストより継承)
Sort要素をソートする(リストより継承)
Text各要素に対応するテキストを含むリストを返す
ToArrayの値を含む配列を返す。(リストより継承)
ToExcelExcelに値をコピーします。対象は、アドレス、ワークシート、範囲です。(リストより継承)
Values() の値を含む配列を返す。(リストより継承)
Values
(Object,

Int32, Int32)
各要素を数値に変換したテキストを含むリストを返します。

Properties

NameDescription
Count数を返す(リストより継承)
IsFixedSize使用不可(リストより継承)
IsReadOnly使用不可(リストより継承)
IsSynchronizedレチューン虚偽(リストより継承)
Item指定されたインデックスの WebElement を取得します。(リストより継承)
SyncRootRetuns null(リストより継承)

Window Class

Methods

NameDescription
Activateこのウィンドウにフォーカスを移す。
Close現在のウィンドウを閉じる。
Equals指定されたインスタンスが等しいとみなされるかどうかを判定する。(Object.をオーバーライドします。Equals(Object)をオーバーライドしています)
FullScreen現在のウィンドウをフルスクリーンにする。
GetHashCodeハッシュコードを返す(Objectをオーバーライドします。GetHashCode() .)
Maximize現在のウィンドウが最大化されていない場合、最大化する。
Position画面の左上隅を基準としたブラウザウィンドウの位置を取得します。
SetPosition画面の左上隅を基準とした、ブラウザウィンドウの位置を設定します。
SetSizeタイトルバーやウィンドウの境界線を含む、外側のブラウザウィンドウの大きさを設定します。
Sizeタイトルバーやウィンドウの境界線を含む、外側のブラウザウィンドウの大きさを取得します。
SwitchTo
NextWindow
次の利用可能なウィンドウに切り替える
SwitchTo
PreviousWindow
前にフォーカスしていたウィンドウに切り替える。
SwitchTo
WindowByName
他のウィンドウにフォーカスを移す。
SwitchTo
WindowByTitle
他のウィンドウにフォーカスを移す。

Properties

NameDescription
Handle現在のウィンドウのハンドルを返します。
Title現在のページタイトルを取得します。

SearchConText Class

Methods

NameDescription
FindElement指定されたメソッドを使用して、最初の WebElement を検索します。
FindElementBy指定された機構と値に一致する最初の子要素を検索します。
FindElement
ByClass
指定された CSS クラスに合致する最初の要素を検索します。
FindElement
ByCss
指定されたCSSセレクタに合致する最初の要素を検索します。
FindElement
ById
指定されたidに合致する最初の要素を検索する。
FindElement
ByLinkText
指定されたリンクテキストに一致する最初の要素を検索します。
FindElement
ByName
指定された名前に一致する最初の要素を検索します。
FindElement
ByPartial
LinkText
与えられたリンクテキストの部分に一致する要素のうち、最初のものを探す
FindElement
ByTag
指定されたタグ名に合致する最初の要素を検索する。
FindElement
ByXPath
指定されたXPathクエリにマッチする最初の要素を検索します。
FindElements与えられた機構を使用して、現在のコンテキスト内のすべての要素を検索します。
FindElementsBy指定された機構と値に一致する全ての子要素を検索します。
FindElements
ByClass
指定された CSS クラスに合致する要素を検索する。
FindElements
ByCss
指定されたCSSセレクタに合致する要素を検索します。
FindElementsById指定されたidに合致する要素を検索する。
FindElements
ByLinkText
指定されたリンクテキストに合致する要素を検索する。
FindElements
ByName
指定された名前に合致する要素を検索する。
FindElements
ByPartial
LinkText
与えられたリンクテキストの部分に一致する要素のうち、最初のものを探す
FindElements
ByTag
指定されたタグの名前に合致する要素を検索する。
FindElements
ByXPath
指定されたXPathクエリに合致する要素を検索します。
IsElement
Present
“指定された要素がページのどこかにあるかどうかを確認します。”
WaitNotElement要素が欠落するのを待つ。

SelectElement Class

Methods

NameDescription
DeselectAll選択された項目をすべてクリアします。SELECTが複数選択をサポートしている場合のみ有効です。
DeselectByIndex要素の “index “属性によって決定されるインデックスによって、オプションを選択解除する。
DeselectByText表示されているテキストで選択を解除します。
DeselectByValue指定されたテキストに一致する値を持つオプションの選択を解除します。
SelectByIndex要素の “index “属性で決定されるインデックスによってオプションを選択します。
SelectByText表示されているテキストですべてのオプションを選択します。
SelectByValue値でオプションを選択します。

Properties

NameDescription
AllSelectedOptionsselect要素内で選択されたすべてのオプションを取得します。
IsMultiple親要素が複数選択をサポートしているかどうかを示す値を取得する。
Optionsselect 要素のオプションのリストを取得します。
SelectedOptionselect 要素内で選択されている項目を取得します。

今回のまとめ

今回はSeleniumBasicのDocumentationを日本語版にしました。

Seleniumライブラリには多くのクラスや、メソッドやプロパティが存在します。

スクレイピングをする際にはどうしても必要になりますので参考にしていただければ幸いです。

VBAを使ったものではありませんが、Seleniumを勉強する為の基本的な書籍です。各言語における基本的なコマンド一覧も記載されていますのでコードを書く際の参考になります。

こちらもVBAに関してではないですがクローリング全般について書かれた書籍です。webAPIやOuAuth認証などについても書かれていますので長く勉強したい方は参考にしてください。


↓困ったときは以下が頼りになります。私も利用させてもらってます😊。

TVCMで話題のココナラ

SeleniumBasicでのWebスクレイピングに関する記事はこちらをどうぞ

Web-APIを用いたデータ取得に関する記事はこちらをどうぞ

【VBA】Web APIを使ってデータを取得する(OpenWeatherMap)1
【VBA】Web APIを使って時間別天気予報を取得する(気象庁API)
【VBA】Web APIを使ってLINE通知を行う(LINE Notify)1

コメント

タイトルとURLをコピーしました