DocumentWindow オブジェクト

プロパティ

2列目の項目は、読み込み専用の場合 'R' (Read) 、読み書き可能な場合は 'RW'(Read/Write)です。

ActiveFrameDocument R フレームを使用しているページで、現在アクティブなフレームの Document オブジェクト(HTMLページ内のJava Script等で使用する document オブジェクトと同じもの)を返します。
ActiveFrameDocument_ R 次の点を除いて ActiveFrameDocument と同じです。ActiveFrameDocument はページの読み込み完了まで待ってから値を返しますが、ActiveFrameDocument_ は待つことなく直ぐに値を返します。
AllowActiveX RW

[セキュリティ]-[タブセキュリティ]-[ActiveX]メニューの状態を表します。

sbkConst.sbj
(sbv)での定義
意味
sbkAmTabGrp0タブグループの設定に従う
sbkAmAllow1許可
sbkAmDisallow2禁止
AllowImage RW

[セキュリティ]-[タブセキュリティ]-[画像の表示]メニューの状態を表します。

sbkConst.sbj
(sbv)での定義
意味
sbkAmTabGrp 0 タブグループの設定に従う
sbkAmAllow 1 許可
sbkAmDisallow 2 禁止
AllowJava RW

[セキュリティ]-[タブセキュリティ]-[JAVA]メニューの状態を表します。

sbkConst.sbj
(sbv)での定義
意味
sbkAmTabGrp 0 タブグループの設定に従う
sbkAmAllow 1 許可
sbkAmDisallow 2 禁止
AllowScript RW

[セキュリティ]-[タブセキュリティ]-[スクリプト]メニューの状態を表します。

sbkConst.sbj
(sbv)での定義
意味
sbkAmTabGrp 0 タブグループの設定に従う
sbkAmAllow 1 許可
sbkAmDisallow 2 禁止
AllowSound RW

[セキュリティ]-[タブセキュリティ]-[サウンドの再生]メニューの状態を表します。

sbkConst.sbj
(sbv)での定義
意味
sbkAmTabGrp 0 タブグループの設定に従う
sbkAmAllow 1 許可
sbkAmDisallow 2 禁止
AllowVideo RW

[セキュリティ]-[タブセキュリティ]-[ビデオの再生]メニューの状態を表します。

sbkConst.sbj
(sbv)での定義
意味
sbkAmTabGrp 0 タブグループの設定に従う
sbkAmAllow 1 許可
sbkAmDisallow 2 禁止
CloseLock RW クローズロック状態のときTRUE、そうでないときFALSEになります。
DefaultTimeOutSecond RW

ドキュメント読み込み完了待ちのタイムアウト時間を秒単位で指定します。初期値は 120秒です。

DocumentWindow のメソッドの幾つかは、ドキュメントの読み込み完了を待ってから処理を実行します。読み込みが遅いページや、Webページ内のスクリプトが動的にページを更新するようなWebページに対しては、この値を小さくすることでスクリプトが一時的に固まってしまうのを防ぐことができます。

スクリプト実行後の動作にも影響しますので、必要な処理が終了したら、初期値の 120 に戻しておくのがお勧めです。

Document R 表示しているWebページの Document オブジェクト(HTMLページ内のJava Script等で使用する document オブジェクトと同じもの)を返します。
Document_   次の点を除いて Document と同じです。Document はページの読み込み完了まで待ってから値を返しますが、Document_ は待つことなく直ぐに値を返します。
DocumentBusy R Webページを読み込み中のとき TRUE を返します。それ以外はFALSE になります。
EditMode RW [編集]-[HTML編集]-[編集モード]メニューに対応します。TRUEのときWebページの編集状態です。
FloatingMode RW

DocumentWindow のフローティング状態です。

sbkConst.sbj
(sbv)での定義
意味
sbkFmNone 0 フローティングしていません。
sbkFmFloating 1 フローティングしています。
sbkFmTop 2 フローティングして、常に手前に表示します。
sbkFmAppTop 3 フローティングして、常にメインウィンドウの手前に表示します。

(参照)[ページ]-[フローティング]メニュー

FontSize RW Webページの文字のサイズを表します。下の値を使用します。
0:最小
1:小
2:中
3:大
4:最大
(参照)[表示]-[文字のサイズ]メニュー
FrameCount R Webページ内の frame, iframe の数を返します。
フレームが入れ子になっている場合は、全てのフレームを列挙した数になります。
FrameDocuments R

書式:FrameDocuments(Index)

Webページ内の frame, iframe の document オブジェクトを返します。
フレームが入れ子になっている場合は、全てのフレームを列挙します。

Index 引数には、何番目のフレームの document を返すかを指定します。指定できる範囲は「0 〜 FrameCountプロパティの値 - 1」です。

セキュリティ上の問題で DHTML の frames プロパティが動作しないときに使用します。

HTMLTagVisible RW [編集]-[HTML編集]-[HTMLタグの 表示]メニューに対応します。TRUEのときHTMLタグを表示します。
ID R DocumentWindow オブジェクト固有の ID 番号を返します。ID番号は、実行中の ScriptBrowserK 内で固有の値を示します。
InheritHilight RW [ページ]メニューの[ハイライトの継続]の状態を表します。
TRUEのとき継続され、FALSEのとき継続されません。
InheritSecurity RW

[セキュリティ]メニューの[タブのセキュリティ継承]のチェック状態を表します。チェックのときTRUE、非チェックのときFALSEになります。

LoginMode RW

ログインモードの設定を行います。下の値を指定できます。

sbkConst.sbj
(sbv)での定義
意味
sbkLmOff0通常の状態です。
sbkLmOn-1:画像、サウンドの読み込みを行いません。また、Java、ActiveX を実行しません。
sbkLmNoScript1 上の(-1)の状態に加えて、Webページ内のスクリプトの実行を禁止します。

※スクリプトの実行を終了後に自動的に LoginMode は 0 に設定されますが、他のURLを表示するなどしないと画像等は表示されません。

LinkWindowName RW リンク先表示ウィンドウを表示します。
(参照)[ページ]-[リンク先表示ウィンドウの設定]コマンド
NavigateLock RW ナビゲートロック状態のときTRUE、そうでないときFALSEになります。
ReloadInterval RW

自動更新の間隔を秒単位で指定します。0(ゼロ)を指定すると、自動更新を行いません。

15秒単位で指定してください。15秒未満の値は切り上げて使用されます。例えば25を指定すると30秒間隔で更新されます。

(参照)[ページ]-[自動更新]メニュー

StatusBarText(ID) RW

ID で指定したステータスバーのパネルに表示するテキストを指定します。
ID のパネルが存在しない場合は自動的に作成されます。

ここで指定したテキストは、このタブがアクティブな場合のみステータスバーに表示されます。

アクティブなタブに関係なく表示するテキストは、StatusBar オブジェクトの PanelText で設定してください。

例)
ActiveDocWin.StatusBar.PanelText("Panel1")="テスト"

TabGroup RW 所属するTabGroup オブジェクトを取得、設定します。 このプロパティに代入した場合は、代入したタブグループの末尾に移動します。
TabIndex RW 所属するTabGroup オブジェクト内のタブの位置です。先頭(一番左)のタブが0(ゼロ)になります。
TabName RW タブ名を読み書きします。
TabState R

タブの状態(Webページの読み込み状態)を表します。下の値を返します。

sbkConst.sbj
(sbv)での定義
意味
sbkTsUninitialized0未初期化状態(スクリプト内ではこの値が返ることは、多分無いです)
sbkTsNavigating1ナビゲート中(タブに黄色の■が表示されている状態)
sbkTsNavComplete2ナビゲート完了(タブに黄色の■が表示されている状態)
sbkTsDLComplete3読み込み完了で未読状態(タブに水色の■が表示されている状態)
sbkTsShown4読み込み完了で既読(読み込み完了後にタブを1回でもアクティブにした)状態
Title R 表示しているWebページのタイトルを返します。
URL R 表示しているWebページのURLを返します。
WindowLeft
WindowTop
WindowWidth
WindowHeight
RW ウィンドウの左端の位置、上端の位置、幅、高さです。代入することも可能です。
Zoom RW 現在のページの表示倍率です。単位は%(パーセント)です。100のとき1倍となります。
[表示]メニューの[ズーム]-[ユーザ指定]の機能に相当します。
ZoomFixed RW [表示]メニューの[ズーム]-[ズームを維持]の状態を表します。
TRUEのときズームを維持状態で、FALSEのとき非ズームを維持状態です。

メソッド

AddFavoriteDialog 書式:AddFavoriteDialog
[お気に入り]-[お気に入りに追加]コマンドを実行します。
Close 書式:Close
ブラウザウィンドウを閉じます。
Copy 書式:Copy
[編集]-[コピー]コマンドを実行します。
CopyTitle 書式:CopyTitle
表示しているWebページのタイトルをクリップボードにコピーします。
CopyTitleAndURL 表示しているWebページのタイトルとURLの2行をクリップボードにコピーします。
CopyURL 書式:CopyURL
表示しているWebページのURLをクリップボードにコピーします。
Cut 書式:Cut
[編集]-[カット]コマンドを実行します。
EventSrcDocument 書式:EventSrcDocument
Webページ上のショートカットメニュー[ScriptBrowserKオプション]-[ブラウザの動作]-[マウス操作]ページ-[Webページ]で指定したコマンドが実行された場合に、クリックされた Document オブジェクト(HTMLページ内のJava Script等で使用する document オブジェクトと同じもの)を返します。それ以外のときは、アクティブなフレームの document オブジェクトを返します。
ExtractLink

書式:ExtractLink(Flag)

リンクの抽出を行います。リンクの抽出画面が表示されます。

Flag:取得条件を指定します。下記の値を指定します。

sbkConst.sbj
(sbv)での定義
意味
sbkElAll0Webページ全体から抽出
sbkElRange1選択範囲内のリンクを抽出
sbkElArray $8000
(16進数)
リンクを配列として取得。 このときリンクの抽出画面は表示されない。上の sbkElAll または sbkElRange と組み合わせて(加算して)使用する。

例)選択範囲内のリンクのURLを順次画面に表示します。

[VBScript]

a=ActiveDocWin.ExtractLink(&h8001)
for each c in a
ShowMessage(c)
next

[JScript]

var b = ActiveDocWin.ExtractLink(0x8001)
var a = new VBArray(b)
a=a.toArray()
for (var i = 0; i < a.length; i ++) {
ShowMessage(a[i]);
}

GetWindowHandle 書式:GetWindowHandle
DocumentWindow を表示している。MDIウィンドウのウィンドウハンドルを返します。
GoBack 書式:GoBack
[表示]-[移動]-[戻る]コマンドを実行します。
GoForward 書式:GoForward
[表示]-[移動]-[進む]コマンドを実行します。
GoHome 書式:GoHome
[表示]-[移動]-[ホーム]コマンドを実行します。
GoLast 書式:GoLast
[表示]-[移動]-[最後まで進む]コマンドを実行します。
GoTop 書式:GoTop
[表示]-[移動]-[先頭に戻る]コマンドを実行します。
Grep

書式:Grep(Text, Flag, AddSrchPanel)
ページ内検索パネルの検索を実行します。

Text : 検索する文字列を指定します。

GrepFlag :下の値の組み合わせ(足し算します)を指定します。
  2:単語単位で検索。
  4:大文字、小文字を区別する。

AddSrchPanel : TRUEを指定すると、ページ内検索パネルに項目を追加します。FALSEを指定するとハイライト表示するだけで、ページ内検索パネルに項目を追加しません。省略可能で省略するとTRUEとみなされます。

HighlightDiff

書式:HighlightDiff(document)

document 引数で指定したドキュメントと比較して、異なる部分をハイライト表示します。

ScriptBrowserK 内部では、更新チェック機能で更新部分をハイライト表示するのに使用されています。

例)アクティブなドキュメントと先頭のタブを比較してハイライト表示する
ActiveDocWin.HighlightDiff(TabGroups(0)(0).document_)

LinkSendMail 書式:LinkSendMail
表示中のWebページのURLをメールで送信します。システム標準のメールソフトが起動します。
MakeShortCutOnDesktop 書式:MakeShortCutOnDesktop
表示中のWebページのURLへのショートカットをデスクトップに作成します。
ManualDock

書式:ManualDock(DockSite, Align)

ウィンドウを ScriptBrowserK の本体のウィンドウの上下左右の辺にドッキングさせます。

DockSite:どの辺にドッキングさせるかを下表の値で指定します。

Align:既にパネルや他のウィンドウがドッキングしている辺にドッキングする場合、どちら側にドッキングさせるかを下表の値で指定します。

●DockSite 引数と、Align 引数に指定する値の一覧表

sbkConst.sbj
(sbv)での定義
意味
sbkDkpTop 1 上辺
sbkDkpBttom 2 下辺
sbkDkpLeft 3 左辺
sbkDkpRight 4 右辺
ManualFloat 書式:ManualFloat(Left, Top, Width, Height)

ScriptBrowserK の本体のウィンドウの上下左右の辺のいずれかにドッキングしている場合、ドッキングを解除してフローティング状態にします。Left, Top, Width, Height の各引数にはフローティング後のウィンドウの位置とサイズを指定します。

MoveParentDir 書式:MoveParentDir
[表示]-[移動]-[親ディレクトリ]コマンドを実行します。
Navigate

書式:Navigate(URL, [TargetFrameName], [PostData], [Headers])
指定した URL を表示します。新しくブラウザウィンドウが作成された場合は、そのDocumentWindow オブジェクトを返します。

URL  表示するURLを指定します。

TargetFrameName 表示するフレーム名またはウィンドウ名を指定します。省略可能なパラメータです。

PostData  Post 形式で送信するデータを指定します。省略可能なパラメータです。

Headers  送信するHeaderを指定します。省略可能なパラメータです。

OpenSelectionAsURL [ファイル]メニューの[開く]-[選択範囲をURLとみなして開く]を実行します。
PageSetupDialog 書式:PageSetupDialog
[ファイル]-[ページ設定]コマンドを実行します。
Paste 書式:Paste
[編集]-[貼り付け]コマンドを実行します。
PrintDialog 書式:PrintDialog
[ファイル]-[印刷]コマンドを実行します。
PrintDialogWithParam

書式:PrintDialogWithParam(PrintSetting)

印刷先のプリンタなどの項目を設定した状態で[ファイル]-[印刷メニューを実行できます。

PrintSetting 引数には、PrintSetting オブジェクトを渡します。PrintSetting オブジェクトは、ScriptBrowserK オブジェクトの NewPrintSetting メソッドで取得します。

PrintPaperSetup

書式:PrintPaperSetup(PaperSize, Orientation, PaperSource)

[ファイル]-[ページ設定]メニューで設定できる項目の一部を設定できます。ここで設定できない項目は、ScriptBrowserK オブジェクトの SetPrintPageSetting メソッドで設定できます。

各引数は、数値で指定することも可能です。その場合、[ファイル]-[ページ設定]メニューの設定画面の各項目の一覧内の上からの番号(先頭が 0で、2番目が 1)を指定します。例えば、PaperSize に 1 を指定した場合は、用紙サイズの上から2番目の項目を選択します。

PaperSize :用紙サイズを指定します。例)"A3", "A4"
省略可能なパラメータで省略した場合は、現在の設定を変更しません。

Orientation :用紙方向を指定します。0 または "portrate" を指定した場合は縦長、1 または "landscape" を指定した場合は横長を表します。
それ以外の値を渡した場合は、縦長に設定されますので注意して下さい。
省略可能なパラメータで省略した場合は、現在の設定を変更しません。
sbkConst.sbj(.sbv)には下記の値が定義されています。

sbkConst.sbj
(sbv)での定義
意味
sbkPoriPortrait 0縦長
sbkPoriLandscape 1横長

PaperSource: 給紙方法を指定します。 Internet Explorer 8 では使用できません。
[ファイル]-[ページ設定]メニューの設定画面に表示される項目名を指定します。
省略可能なパラメータで省略した場合は、現在の設定を変更しません。

戻り値

設定に成功した場合は 0 を返します。

一覧にない用紙を指定したなどで用紙サイズの設定に失敗した場合は 1 を、用紙方向の設定に失敗した場合は 2 を、給紙方法に失敗した場合は 3 を返します。

PrintPreviewDialog 書式:PrintPreviewDialog
[ファイル]-[印刷プレビュー]コマンドを実行します。
PropertyDialog 書式:PropertyDialog
[ファイル]-[プロパティ]コマンドを実行します。
Refresh

書式:Refresh(Flag)
現在表示しているWebページを再読み込みします。
Flag:下の値を指定します。

sbkConst.sbj
(sbv)での定義
意味
sbkRfNormal 0 サーバに HTTP 「 pragma:nocache 」ヘッダーを送らない
sbkRfIfExpired 1 ページが期限が切れたなら、再読み込みする
sbkRfCompletely 3 サーバに「 pragma:nocache 」ヘッダーを送る
RemoveCell 書式:RemoveCell
選択範囲を含むセルを削除します。
RemoveRow 書式:RemoveRow
選択範囲を含むテーブルの行を削除します。
Save 書式:Save(Filename)
Filename のファイルに表示中のWebページを保存します。
SaveBySBK 書式:SaveBySBK(Filename, Flag, [Encode])

[ファイル]メニューの[保存]-[ページを保存(ScriptBrowserKで) ]に相当する機能を実行します。
Filename にはファイル名を指定します。拡張子によって保存されるファイル形式が決まります。mht, txt, htm, html のいずれかの拡張子を指定してください。
Flag は、拡張子に mht を指定した場合のみ有効で、保存する項目を下の数値の和(もしくは OR )で指定します。

sbkConst.sbj
(sbv)での定義
意味
sbkSfImage1画像
sbkSfSound2 BGM サウンド
sbkSfFrame4フレーム内のページ
sbkSfObject8オブジェクト(Flash等)
sbkSfCss16スタイルシート
sbkSfScript32スクリプト

Encode は文字エンコードを指定して保存したい場合に、下の中から指定します。Encode は省略可能です。

sbkConst.sbj
(sbv)での定義
意味
sbkCsNoConv0オリジナルのままなにもしない
sbkCsUtf81UTF-8
sbkCsEuc2EUC
sbkCsSJis3Shift JIS
sbkCsJis4JIS
SaveDialog 書式:SaveDialog
名前を付けて保存ダイアログボックスを表示します。
SaveSelectionToFile 書式:SaveSelectionToFile(Filename, Flag, [Encode])

[ファイル]メニューの[保存]-[選択範囲を保存]に相当する機能を実行します。
Filename にはファイル名を指定します。拡張子によって保存されるファイル形式が決まります。mht, txt, htm, html のいずれかの拡張子を指定してください。

Flag 引数と Encode 引数の指定方法は SaveBySBK メソッドと同じです。SaveBySBK メソッドの解説を参照してください。

ScrollBottom [表示]メニューの[スクロール]-[ページ末尾へ]を実行します。
ScrollPageDown [表示]メニューの[スクロール]-[1ページ下に]を実行します。
ScrollPageUp [表示]メニューの[スクロール]-[1ページ上に]を実行します。
ScrollTop [表示]メニューの[スクロール]-[ページ先頭へ]を実行します。
SearchDialog 書式:SearchDialog
[編集]-[このページの検索]コマンドを実行します。
SearchSelectedText 書式:SearchSelectedText(SearchName)

選択範囲内の文字列を、SearchName引数で指定した検索サイトで検索します。

SelectAll 書式:SelectAll
[編集]-[全て選択]コマンドを実行します。
SetBounds 書式:SetDesktopSetting(Left, Top, Width, Height)
ウィンドウを指定した座標に移動します。
SetFocus 書式:SetFocus
ブラウザウィンドウを最前面に表示します。
SetUserCSS 書式:SetUserCSS(Name)
ユーザスタイルを Name で指定したものに設定します。解除するには空文字列("")を指定します。
Stop 書式:Stop
[表示]-[中止]コマンドを実行します。
TableToText 書式:TableToText

[編集]メニューの[HTML編集]-[テーブルの解除]を実行します。

ViewSource

書式:ViewSource(Flag)
表示中のWebページのHTMLソースを表示します。
Flag:ソースを表示する範囲を指定します。下記値で指定します。

sbkConst.sbj
(sbv)での定義
意味
sbkVsAll0Web ページ全体のソースを表示
sbkVsSel1選択範囲のソースを表示
WaitForDocumentComplete

書式:WaitForDocumentComplete(TimeoutSecond)
ドキュメントの読み込みが完了するまで待ちます。ScriptBrowserK は DocumentWindow オブジェクトのメソッドやプロパティを呼び出す前にドキュメントの読み込みが終了するのを待つので、通常はこのメソッドを呼び出す必要はありません。他のオブジェクトと連携するときなどにこのメソッドを使用してください。

TimeoutSecond 秒後にタイムアウトして処理が戻ります。他のメソッドと異なりタイムアウトエラーは発生しません。注意して下さい。TimeoutSecond は省略可能な引数で省略した場合は DefaultTimeOutSecond プロパティの値が使用されます。

WaitForDocumentInteractive 書式:WaitForDocumentInteractive(TimeoutSecond)

Webページを読み込み中の場合、(スクロール操作が行える等)Webページが操作可能になるまで待ちます。この状態でもWebページの読み込みが全て完了していない場合もあります。

TimeoutSecond 秒後にタイムアウトエラーが発生します。TimeoutSecond は省略可能な引数で省略した場合は DefaultTimeOutSecond プロパティの値が使用されます。

WaitForNavigate

書式:WaitForNavigate(Count, TimeoutSecond)

指定した回数ナビゲート動作が行われるまで待機します。

TimeoutSecond 秒後にタイムアウトエラーが発生します。TimeoutSecond は省略可能な引数で省略した場合は DefaultTimeOutSecond プロパティの値が使用されます。

WaitForRedirect

書式:WaitForRedirect(URL, TimeoutSecond)

URL引数で指定した文字列をURLかタイトルが含むWebページが表示されるまで待機します。

Timeout秒後にタイムアウトエラーが発生します。TimeoutSecond は省略可能な引数で省略した場合は DefaultTimeOutSecond プロパティの値が使用されます。

ZoomByUser [表示]メニューの[ズーム]-[ユーザ指定]を実行します。
ZoomIn [表示]メニューの[ズーム]-[ズームイン]を実行します。
ZoomInPage [表示]メニューの[ズーム]-[ページ全体を表示]を実行します。
ZoomInPageWidth [表示]メニューの[ズーム]-[ページ幅に合わせて縮小]を実行します。
ZoomOut [表示]メニューの[ズーム]-[ズームアウト]を実行します。

 


Copyright (c) 2002-2011 Akiyoshi Kozuka (http://www.scriptbrowserk.com/)