スクリプトのサンプル
ScriptingCommands の一覧
Scripting オブジェクト
QTTabBar スクリプティングのルートオブジェクトへのアクセスを提供します。
(js) var qs = new ActiveXObject( "QTTabBarLib.Scripting" );
(vbs) Set qs = CreateObject("QTTabBarLib.Scripting")
プロパティ
ActiveWindow
最後にユーザーがアクティブにしたエクスプローラ ウィンドウを表現する Window オブジェクト を返します。
Arguments
実行されたスクリプトのコマンドライン文字列を格納した QCollection オブジェクト を返します。
(New in 1024)
CurrentDirectory
現在の作業フォルダのパスを返します。
(New in 1025)
FocusedWindow
キーボードフォーカスを持った Window オブジェクト または Desktop オブジェクト を返します。
他のアプリケーションやウィンドウがフォーカスを持っている場合、null を返します。
(New in 261)
DesktopWindow
デスクトップのビューを表現する Desktop オブジェクト を返します。
(New in 261)
Windows
すべてのエクスプローラ ウィンドウを Window オブジェクト として含む QCollection オブジェクト を返します。
メソッド
Alert( object, [window] )
メッセージ ボックスにテキストを表示します。
| object | 表示するテキスト。 |
| window | (省略可能) メッセージボックスをその上に表示する Window オブジェクト を指定します。そのウィンドウに対してモーダルになります。 |
MessageBox( text, [buttons], [icon], [window] )
ボタンやアイコンを指定できるメッセージ ボックスにテキストを表示します。
| text | 表示するテキスト。 |
| buttons | (省略可能) 表示されるボタンを指定する MessageBoxButton の値です。 これは "OK" のような文字列か、またはその番号で指定します。 |
| icon | (省略可能) 表示されるアイコンを指定する MessageBoxIcon の値です。 これは "Error" のような文字列か、またはその番号で指定します。 |
| window | (省略可能) メッセージボックスをその上に表示する Window オブジェクト。そのウィンドウに対してモーダルになります。 |
| 戻り値 | DialogResult の値。 |
InputBox( text, [defaultText], [fPassword], [window] )
ユーザーが入力した文字列を取得できるメッセージ ボックスにテキストを表示します。
| text | 表示するテキスト。 |
| defaultText | (省略可能) テキストボックスに設定する文字列。 |
| fPassword | (省略可能) テキストがパスワード文字列で表示されるかを示すブール値。 |
| window | (省略可能) メッセージボックスをその上に表示する Window オブジェクト。そのウィンドウに対してモーダルになります。 |
| 戻り値 | ユーザーがOKボタンを押した場合はユーザーが入力した文字列。そうでなければnull。 |
MessageForm( text, [duration], [icon], [window] )
指定した時間だけ表示されるメッセージ ボックスです。
| text | 表示するテキスト。 |
| duration | (省略可能) このメッセージボックスが表示される時間をミリ秒で指定します。デフォルト値は10000 (10秒)です。 |
| icon | (省略可能) 表示されるアイコンを指定する MessageBoxIcon の価。 これは "Error" のような文字列か、またはその番号で指定します。 |
| window | (省略可能) メッセージボックスをその上に表示する Window オブジェクト。そのウィンドウに対してモーダルになります。 |
GetFolderPath( folder )
システムフォルダーのパス文字列を取得します。
| folder | 取得するシステムフォルダを指定する定数値。 MSDN を参照してください。 これは "ApplicationData" のような文字列か, またはその整数値(この場合は26)で指定します。 |
| 戻り値 | システムフォルダーへのパス文字列。 |
GetSystemInformation( name )
現在のシステム環境に関する情報を提供します。
| name | 取得するシステム情報の名前。 MSDN を参照してください。 これは "ActiveWindowTrackingDelay" のように有効なプロパティ名を表す文字列である必要があります。 |
InvokeCommand( command, [arg1], [arg2]… )
QTTabBar のコマンドを実行します。
| command | ScriptingCommands の値です。 コマンドは "NewWindow" のような文字列か、またはその番号で指定します。(この場合は5) このメソッドは非ウィンドウ依存のコマンドを受け入れます。 特定のウィンドウへのコマンドは Window.InvokeCommand を参照してください。 |
| arg | コマンドごとの引数。詳細は各コマンドを参照してください。 |
| 戻り値 | コマンドごとの戻り値。 |
NewCollection()
新しい空の QCollection オブジェクト を作成します。
NewCollectionFromItems( obj1, obj2, … )
引数を要素とする QCollection オブジェクト を作成します。
Open( path, [view] )
新しいタブを開きます。
| path | フォルダーを指定するパス文字列。 |
| view | タブが開かれる ビュー を指定します。(1024) |
| 戻り値 | Window オブジェクト |
OpenWindow( path, [view] )
新しいウィンドウを開きます。
| path | フォルダーを指定するパス文字列。 |
| view | タブが開かれる ビュー を指定します。(1024) |
| 戻り値 | Window オブジェクト |
OpenGroup( group, [view] )
QTTabBar のグループを開きます。
| group | グループ名を指定する文字列、またはグループ名をメンバーとして含んだQCollection オブジェクト。 |
| view | タブが開かれる ビュー を指定します。(1024) |
| 戻り値 | Window オブジェクト |
OpenGroupWindow( group, [view] )
QTTabBar のグループを新しいウィンドウで開きます。
| group | グループ名を指定する文字列、またはグループ名をメンバーとして含んだQCollection オブジェクト。 |
| view | タブが開かれる ビュー を指定します。(1024) |
| 戻り値 | Window オブジェクト |
CloseAllWindows()
すべてのフォルダーウィンドウを閉じます。
Sleep( msec )
指定したミリ秒数の間現在のスレッドをブロックします。
| msec | スレッドがブロックされるミリ秒数。1000ミリ秒が1秒です！ |
GetEventData( eventDataKey )
イベントによってスクリプトが起動されたときに、そのイベントに関連するデータを取得します.
| eventDataKey | コマンドとしてスクリプトファイルが実行されたときに、実行環境に渡された引数のうち %eventdata_key% というトークンによって置き換えられたもの． |
| 戻り値 | イベントデータ．イベントの種類によって、Tab オブジェクトや文字列など. |
GetEventSource( eventDataKey )
イベントによってスクリプトが起動されたときに、そのイベントのソースを取得します.
| eventDataKey | コマンドとしてスクリプトファイルが実行されたときに、実行環境に渡された引数のうち %eventdata_key% というトークンによって置き換えられたもの． |
| 戻り値 | イベントのソースを示す EventSource 列挙値. |
GetEventTargetView( eventDataKey )
イベントによってスクリプトが起動されたとき、そのイベントの発生したビューを取得します．
| eventDataKey | コマンドとしてスクリプトファイルが実行されたときに、実行環境に渡された引数のうち %eventdata_key% というトークンによって置き換えられたもの． |
| 戻り値 | イベントの発生した ビュー. |
GetEventSourceString( eventDataKey )
GetEventKeyState( eventDataKey )
SetReturn( value )
スクリプトの実行後、スクリプトの呼び出し元に結果を返します.
| value | 呼び出し元に返すオブジェクト． |
Window オブジェクト
エクスプローラウィンドウを表現します。
プロパティ
Active
このウィンドウがフォアグラウンドであるかどうかを示す値を取得・設定します。
(New in 261)
ActiveTab
このウィンドウでアクティブなタブを示す Tab オブジェクト を返します。
どのタブバーも有効にされていなとき、デフォルトビューを表現する仮想的なタブが返されます。(1024)
返されたタブはエクストラビューに含まれている場合があります。(1024)
ActiveView
このウィンドウで現在フォーカスをもっているアクティブな ビュー を返します。
(New in 1024)
Tabs
このウィンドウのデフォルトビューのタブをすべて含む QCollection オブジェクト を返します。
返されたタブはデフォルトビューのタブです。エクストラビューのタブを取得したいときは、GetTabs メソッドを使用します。(1024)
AllTabs
このウィンドウのタブをすべて含む QCollection オブジェクト を返します。
返されたタブはデフォルトビューに加えて有効になっているエクストラビューのタブを含みます。
(New in 1024)
Text
このウィンドウのタイトルテキストを返します。
SelectedItems
.ActiveTab.SelectedItems プロパティのエイリアスです。
(New in 261)
Path
.ActiveTab.Path プロパティのエイリアスです。
(New in 512)
メソッド
InvokeCommand( command, [arg1], [arg2], [arg3]… )
QTTabBar のコマンドを実行します。
| command | ScriptingCommands の値です。 これは "GoBack" のような文字列か、またはその番号で指定します。(この場合は0) |
| arg1, arg2, arg3 | コマンドごとの引数。 |
| 戻り値 | コマンドごとの返り値。 |
Add( path, [view] )
このウィンドウに新しいタブを追加します。
| path | フォルダーを指定するパス文字列。 |
| view | (省略可能) タブが開かれる ビュー列挙値 を指定します。 |
| 戻り値 | Tab オブジェクト。 |
Insert( path, [index], [activate], [new], [view] )
新しいタブを挿入します。
| path | フォルダーを指定するパス文字列。 |
| index | (省略可能) 0から始まる挿入位置を示す値。 |
| activate | (省略可能) 新しいタブをアクティブにするかどうか指定するブール値。 |
| new | (省略可能) すでに同じフォルダーが存在していても挿入するかどうかを示すブール値。 |
| view | (省略可能) タブが開かれる ビュー列挙値 を指定します。 |
| 戻り値 | Tab オブジェクト。 |
IndexOfID( id )
ID値からタブの位置を取得します。
| id | 位置を取得する Tab object. のID値。 |
| 戻り値 | みつかった場合はそのインデックス。見つからなかった場合は-1。 |
TabFromID( id )
ID値からタブを取得します。
| id | タブのID値。 |
| 戻り値 | Tab オブジェクト。 |
Close()
ウィンドウを閉じます。
GetTabs( view )
このウィンドウの指定されたビューのタブをすべて含む QCollection オブジェクト を返します。
| view | タブが開かれる ビュー列挙値 を指定します。 |
| 戻り値 | QCollection オブジェクト。 |
GetData( [slot] )
事前に設定したデータを取得します。これはWindow.InvokeCommand( "GetData" ) と同じです。
| slot | 取得するデータの入っているスロット番号。省略した場合は0。 |
| 戻り値 | 事前に設定されたデータ。 |
SetData( data, [slot] )
データをスロットに設定します。これはWindow.InvokeCommand( "SetData" ) と同じです。
| data | 設定するデータ。 |
| slot | データを設定するスロット番号。省略した場合は0。 |
Tab オブジェクト
タブを表現します。
プロパティ
Active
このタブがアクティブであるかどうかを示すブール値を取得・設定します。
ID
タブを一意に識別する値を取得します。
Locked
このタブがロックされているかを示すブール値を取得・設定します。
Path
このタブのパス文字列を取得・設定します。
SelectedItems
このタブのフォルダのビューで選択されているアイテムを QCollection オブジェクト として取得・設定します。
var newSel = qs.NewCollection();
newSel.Push( "Program Files" );
newSel.Push( "Windows" );
tab.SelectedItems = newSel;
ver 1026から、単独ファイルの場合は以下のように直接ファイル名を設定できるようになりました。
tab.SelectedItems = "Windows"; // "C:\\Windows" のようにフルパスも可
SelectedFolders
このタブのフォルダのビューで選択されているアイテムのうちフォルダーを QCollection オブジェクト として取得します。
(New in 1024)
SelectedFiles
このタブのフォルダのビューで選択されているアイテムのうちファイルを QCollection オブジェクト として取得します。
(New in 1024)
Text
タブのテキストを取得します。
View
このタブを所有しているビュー を取得します。
(New in 1024)
Window
このタブを所有している Window オブジェクト を取得します。
メソッド
Close()
このタブを閉じます。
GoBack()
このタブでひとつ戻ります。
GoForward()
このタブでひとつ進みます。
NavigateTo( path )
このタブを指定されたパスにナビゲートします。
| path | フォルダーを指定するパス文字列。 |
| 戻り値 | 成功した場合 True。 |
QCollection オブジェクト
オブジェクトのコレクションです。
プロパティ
Count
コレクション内のオブジェクトの数を取得します。
Length
Count プロパティのエイリアスです。 (New in 261)
メソッド
Item( index )
インデックスを指定してオブジェクトを取得します。
| index | 0から始まるインデックス値。省略された場合は0とみなします。 |
| 戻り値 | オブジェクト。 |
IndexOf( object )
コレクション内でオブジェクトを検索し、最初にみつかったインデックスを返します。
| object | オブジェクト。 |
| 戻り値 | オブジェクトがみつかった場合はそのインデックス値。そうでない場合は -1。 |
LastIndexOf( object )
コレクション内でオブジェクトを検索し、最後にみつかったインデックスを返します。
| object | オブジェクト。 |
| 戻り値 | オブジェクトがみつかった場合はそのインデックス値。そうでない場合は -1。 |
Push( object )
新しい項目をコレクションに追加し、新しいオブジェクト数を返します。
| object | 追加するオブジェクト。 |
| 戻り値 | コレクション内のオブジェクトの数。 |
Add( object )
Push メソッドのエイリアスです。 (New in 261)
Pop()
コレクション内から最後の項目を取り除いて、それを返します。
| 戻り値 | コレクションの最後の位置にあったオブジェクト。 |
Shift()
コレクション内から最初の項目を取り除いて、それを返します。
| 戻り値 | コレクションの最初の位置にあったオブジェクト。 |
Unshift( object )
新しいオブジェクトをコレクションの先頭に挿入し、新しいコレクションの項目数を返します。
| object | 挿入するオブジェクト。 |
| 戻り値 | コレクション内のオブジェクトの数。 |
Concat( qcollection )
指定された QCollections が末尾に追加された新しい QCollections オブジェクトを返します。
| qcollection | 追加される QCollections オブジェクト。 |
| 戻り値 | 新しい QCollection オブジェクト。 |
Join( delimiter )
コレクションのすべての要素を文字列として連結します。各要素の間には、指定した区切り記号が挿入されます。
| delimiter | 区切り記号として使用する文字列。 nullの場合はコンマが使用されます。 |
| 戻り値 | 連結された文字列。 |
Reverse()
コレクションの順番を反転させます。
| 戻り値 | 反転したこのコレクション自身。 |
Slice( start, [end] )
コレクションの部分を取得します。
| start | コレクション内の開始位置。 |
| end | (省略可能) コレクション内の部分の終了位置。 |
| 戻り値 | 新しい QCollection オブジェクト。start で指定される項目から、endで指定される項目の前までを含みます。 |
Sort()
コレクションをソートします。
| 戻り値 | ソートされたこのコレクション自身。 |
Expand( mode )
Join() メソッドのように、項目を指定された方式で連結した文字列を返します。
| mode | どのように連結するかを指定する値。 |
| 0 - ダブルクオーテーションで囲み、半角空白で連結します。(例) "a" "b" "c"…. | |
| 1 - シングルクオーテーションで囲み、半角空白で連結します。(例) 'a' 'b' 'c'…. | |
| 戻り値 | 連結された文字列。 |
Desktop オブジェクト
デスクトップのビューを表現します。 (New in 261)
プロパティ
Active
デスクトップ ウィンドウがフォーカスを持っているかを示すブール値を取得・設定します。
SelectedItems
デスクトップのビューで選択されているアイテムを含む QCollection オブジェクト を返します。
Text
デスクトップを示す文字列を取得します。
メソッド
InvokeCommand( command, [arg1], [arg2], [arg3] )
QTTabBar のコマンドをデスクトップに対して実行します。
| command | ScriptingCommands の値です。 これは "SetClipboardSelectionPaths" のような文字列か、またはその番号で指定します。(この場合は59) |
| arg1, arg2, arg3 | コマンドごとの引数。 |
| 戻り値 | コマンドごとの戻り値。 |