|
|
||
|
[ トップ
| ヘルプ
] | ||
Sleipnir.API リファレンス †Sleipnir.API のリファレンスです。 Sleipnir.API は、 [JScript] pnir = new ActiveXObject("Sleipnir.API");
[VBScript] Set pnir = CreateObject("Sleipnir.API")
などとスクリプトのソースの最初の方で宣言し、 pnir.{Sleipnir.API}
のような書式で書いて使用します。 以下、 [JScript] pnir = new ActiveXObject("Sleipnir.API");
[VBScript] Set pnir = CreateObject("Sleipnir.API")
を宣言したものとして説明しています。 表の見方 †■プロパティ [string] AddressBarString アドレスバーの文字列を取得/設定する。 プロパティは、 [JScript] str = pnir.AddressBarString; pnir.AddressBarString = str; のような２通りの書式で使用します。（読み取り専用の API は前者のみ） さて、表の見方ですが、
右上の文字列は Sleipnir.API です。 ■メソッド [long] NewWindow(string strUrl, bool bActive) [説明] 新しくドキュメントを開く。 [引数] strUrl: 新しく開くドキュメントの Url bActive: 新しく開くウィンドウをアクティブにするか [戻り値] 開かれたドキュメント固有の ID メソッドは、 [JScript] id = pnir.NewWindow('http://www.google.co.jp/', true);
のような書式で使用します。プロパティと違い、１種類のみです。 最初の [] 内の文字列は戻り値の型を表し、それぞれ次のような種類があります。
その右の NewWindow は Sleipnir.API で、 なお、 [void] Beep(void) [説明] Beep 音を鳴らす。 [戻り値] なし のように引数が無く、表中の Sleipnir.API の右の()内の文字列が void と書かれているの場合は、 [JScript] pnir.Beep(); のように空の()を書いてください。
プロパティ †(R) … 読み取り専用です。値の設定はできません。 AddressBarString †[string] AddressBarString アドレスバーの文字列を取得/設定する。 SearchBarString †[string] SearchBarString 検索バーの文字列を取得/設定する。 PageSearchBarString †[string] PageSearchBarString アドバンスドページ検索バーの文字列を取得・設定する。 ※2.xx専用 URL †[string] URL アクティブなドキュメントの URL を取得/設定する。 ActiveIndex †[long] ActiveIndex アクティブなドキュメントのタブ位置を取得/設定する。 FavoriteFile †[string] FavoriteFile お気に入りファイルを取得/設定する。 ※Sleipnir 2.48 + test3 より実装。 AppPath(R) †[string] AppPath(R) Sleipnir.exe の存在するディレクトリを返す。 ScriptPath(R) †[string] ScriptPath(R) スクリプトの読み込まれるディレクトリを返す。 ResourcePath(R) †[string] ResourcePath(R) リソースの読み込まれるディレクトリ返す。 UserPath(R) †[string] UserPath(R) 各種設定の保存するディレクトリを返す。 UserAgent †[string] UserAgent UserAgent を取得/設定する。 ※未実装 Handle(R) †[long] Handle(R) Sleipnir のウィンドウハンドルを返す。 Result †[long] Result Sleipni API の結果を返す。 Version(R) †[long] Version(R) Sleipnir のバージョンを返す。 ShiftDown(R) †[bool] ShiftDown(R) Shift キーの状態を返す。 CtrlDown(R) †[bool] CtrlDown(R) Ctrl キーの状態を返す。 AltDown(R) †[bool] AltDown(R) Alt キーの状態を返す。 OutputVisible †[bool] OutputVisible アウトプットバーの可視状態を取得/設定する。 OutputCurSel †[long] OutputCurSel アウトプットバーの選択行を取得/設定する。 OutputScript †[string] OutputScript アウトプットでダブルクリックされた時に呼ばれるスクリ プトファイルを取得/設定する。このスクリプトは引数とし て /output:選択行 が渡される。 メソッド †GetCount †[long] GetCount [説明] 開かれているドキュメントの数を返す。 [引数] なし [戻り値] 開かれているドキュメントの数 GetDocumentID †[long] GetDocumentID(long index) [説明] ドキュメント固有の ID を取得する。 [引数] index: タブ位置( 0 ～ GetCount-1 ) [戻り値] ドキュメント固有の ID GetWindowObject †[IDispatch] GetWindowObject(long id) [説明] Window Object を取得する。 [引数] id: ドキュメント固有の ID [戻り値] Windows Object の IDispatch GetDocumentObject †[IDispatch] GetDocumentObject(long id) [説明] HTML Document Object を取得する。 [引数] id: ドキュメント固有の ID [戻り値] Document Object の IDispatch GetWebBrowserObject †[IDispatch] GetWebBrowserObject(long id) [説明] WebBrowser Object を取得する。 [引数] id: ドキュメント固有の ID [戻り値] WebBrowser Object の IDispatch NewWindow †[long] NewWindow(string strUrl, bool bActive) [説明] 新しくドキュメントを開く。 [引数] strUrl: 新しく開くドキュメントの Url bActive: 新しく開くウィンドウをアクティブにするか [戻り値] 開かれたドキュメント固有の ID Close †[void] Close(long id) [説明] 指定のドキュメントを閉じる。 [引数] id: ドキュメント固有の ID [戻り値] なし Navigate †[void] Navigate(long id, string strUrl) [説明] 現在のドキュメントで任意の URL にアクセスする。 [引数] id: ドキュメント固有の ID strUrl: ナビゲートする Url [戻り値] なし GetIndex †[long] GetIndex(long id) [説明] ドキュメント固有の ID からタブ位置を取得する。 [引数] id: ドキュメント固有の ID [戻り値] タブ位置 MessageBox †[void] MessageBox(string strMessage) [説明] Sleipnir のメッセージボックスを表示する。 [引数] strMessgae: 表示するメッセージ [戻り値] なし Beep †[void] Beep(void) [説明] Beep 音を鳴らす。 [戻り値] なし IsBusy †[BOOL] IsBusy(long id) [説明] ドキュメントが読み込み中か判断する。 [引数] id: ドキュメント固有の ID [戻り値] 読み込み中の場合は true SetSecurity †[void] SetSecurity(long id, BOOL bJavaScript, BOOL bJava, BOOL bRunActiveX,
BOOL bDownloadActiveX, BOOL bPicture, BOOL bSound,
BOOL bVideo)
[説明]
ドキュメントのセキュリティを設定する。
[引数]
id: ドキュメント固有の ID
各値: 各セキュリティ
IsJavaScriptEnabled †IsJavaEnabled †IsRunActiveXEnabled †IsDownloadActiveXEnabled †IsPictureEnabled †IsSoundEnabled †IsVideoEnabled †[BOOL] IsJavaScriptEnabled(long id) [BOOL] IsJavaEnabled(long id) [BOOL] IsRunActiveXEnabled(long id) [BOOL] IsDownloadActiveXEnabled(long id) [BOOL] IsPictureEnabled(long id) [BOOL] IsSoundEnabled(long id) [BOOL] IsVideoEnabled(long id) [説明] ドキュメントのセキュリティを取得する。 [引数] id: ドキュメント固有の ID [戻り値] 有効ならば true IsNavigateLock †[BOOL] IsNavigateLock(long id) [説明] ナビゲートロックが有効か取得する。 [引数] id: ドキュメント固有の ID [戻り値] 有効ならば true SetNavigateLock †[void] SetNavigateLock(long id, BOOL bEnable) [説明] ナビゲートロックを有効・無効にする。 [引数] id: ドキュメント固有の ID bEnable: 有効にするなら true [戻り値] なし SaveFavorite †[BOOL] SaveFavorite(string strFileName) [説明] お気に入りを保存する。 [引数] strFileName: 保存するファイル名（フルパスで指定） [戻り値] 成功なら true ※Sleipnir 2.48 正式版より実装。 Search †[BOOL] Search(long id, string strKeyword) [説明] ページ内検索を実行する。 [引数] strKeyword: キーワード [戻り値] キーワードが発見できない、または先頭のキーワードに戻ってきたら false ※未実装 Hilight †[void] Hilight(long id, string strKeyword) [説明] ハイライトを実行する。 [引数] strKeyword: キーワード [戻り値] なし ※未実装 WriteProfileInt †[void] WriteProfileInt(string strSection, string strKey, long nData) [説明] <ini_dir>\script.ini に long 型データを書き込む。 [引数] strSection: セクション strKey: キー nData: データ [戻り値] なし WriteProfileString †[void] WriteProfileString(string strSection, string strKey, string strData) [説明] <ini_dir>\script.ini に string 型データを書き込む。 [引数] strSection: セクション strKey: キー strData: データ [戻り値] なし GetProfileInt †[long] GetProfileInt(string strSection, string strKey, long nDefault) [説明] <ini_dir>\script.ini から long 型データを読み込む。 [引数] strSection: セクション strKey: キー nDefault: キーが存在しないときに返される値 [戻り値] データ GetProfileString †[string] GetProfileString(string strSection, string strKey, string strDefault) [説明] <ini_dir>\script.ini から string 型データを読み込む。 [引数] strSection: セクション strKey: キー strDefault: キーが存在しないときに返される値 [戻り値] データ WriteProfileIntCipher †[void] WriteProfileIntCipher(string strSection, string strKey, long nData) [説明] <ini_dir>\script.ini に long 型データを暗号化して書き込む。 [引数] strSection: セクション strKey: キー nData: データ [戻り値] なし WriteProfileStringCipher †[void] WriteProfileStringCipher(string strSection, string strKey,
string strData)
[説明]
<ini_dir>\script.ini に string 型データを暗号化して書き込む。
[引数]
strSection: セクション
strKey: キー
strData: データ
[戻り値]
なし
GetProfileIntCipher †[long] GetProfileIntCipher(string strSection, string strKey, long nDefault) [説明] <ini_dir>\script.ini から暗号化された long 型データを読み込む。 [引数] strSection: セクション strKey: キー nDefault: キーが存在しないときに返される値 [戻り値] データ GetProfileStringCipher †[string] GetProfileStringCipher(string strSection, string strKey,
string strDefault)
[説明]
<ini_dir>\script.ini から暗号化された string 型データを読み込む。
[引数]
strSection: セクション
strKey: キー
strDefault: キーが存在しないときに返される値
[戻り値]
データ
IsRead †[BOOL] IsRead(long id) [説明] ドキュメントが既読か判断する。 [引数] id: ドキュメント固有の ID [戻り値] 既読の場合は true ※Sleipnir 2.6.2 + test12 から実装 InputBox †[string] InputBox(string strPrompt, string strDefault) [説明] 文字列を入力するダイアログを表示する。 [引数] strPrompt: プロンプト strDefault: デフォルトの文字列 [戻り値] OK の場合は編集された文字列、Cancel の場合は strDefault ※Result プロパティに 1（OK）、0（Cancel）が設定される。 SetAutoRefresh †[void] SetAutoRefresh(long id, long nTime) [説明] 自動更新の時間を設定する。 [引数] id: ドキュメント固有の ID nTime: 更新時間（0 ～ 1000 秒） [戻り値] なし GetAutoRefresh †[long] GetAutoRefresh(long id) [説明] 自動更新の時間を取得する。 [引数] id: ドキュメント固有の ID [戻り値] 自動更新の時間（単位 = 秒） OutputGetCount †[long] OutputGetCount() [説明] アウトプットに出力されている文字列の行数を取得する。 [引数] なし [戻り値] 行数 OutputAddString †[void] OutputAddString(string str) [説明] アウトプットに文字列を追加する。 [引数] str: 出力する文字列 [戻り値] なし OutputInsertString †[void] OutputInsertString(long n, string str) [説明] アウトプットに文字列を挿入する。 [引数] n: 挿入する位置 str: 出力する文字列 [戻り値] なし OutputClear †[void] OutputClear() [説明] アウトプットをクリアする。 [引数] なし [戻り値] なし OutputGetString †[string] OutputGetString(long n) [説明] アウトプットから文字列を取得する。 [引数] n: 取得する行 [戻り値] 文字列 OutputDeleteString †[void] OutputDeleteString(long n) [説明] アウトプットから文字列を削除する。 [引数] n: 削除する行 [戻り値] なし MaskedInputBox †string MaskedInputBox(string strPrompt, string strDefault) [説明] マスクで保護された文字列を入力するダイアログを表示する。 [引数] strPrompt: プロンプト strDefault: デフォルトの文字列 [戻り値] OK の場合は編集された文字列、Cancel の場合は strDefault ※Result プロパティに 1（OK）、0（Cancel）が設定される。 GetProfileIntEx †[long] GetProfileIntEx(string strSection, string strKey, long nDefault,
string strFileName)
[説明]
strFileName で指定される INI ファイルから long 型データを読み込む。
[引数]
strSection: セクション
strKey: キー
nDefault: キーが存在しないときに返される値
strFileName: 設定を読み込むファイル
[戻り値]
データ
GetProfileStringEx †[string] GetProfileStringEx(string strSection, string strKey,
string strDefault, string strFileName)
[説明]
strFileName で指定される INI ファイルから string 型データを読み込む。一部のフ
ァイルでは "" で囲まれた文字列が返されることがあります。
[引数]
strSection: セクション
strKey: キー
strDefault: キーが存在しないときに返される値
strFileName: 設定を読み込むファイル
[戻り値]
データ
DeleteProfileKey †[void] DeleteProfileKey(string strSection, string strKey) [説明] <ini_dir>\script.ini から任意のキーを削除する。 [引数] strSection: セクション strKey: キー [戻り値] なし MsgBox †[long] MsgBox(string strPrompt, string strTitle, long lFlag) [説明] WinAPI::MessageBox を呼び出す。 [引数] strPrompt: メッセージボックスに表示する文字列 strTitle: メッセージボックスのタイトル lFlag: WinAPI::MessageBox の値と同じ [戻り値] WinAPI::MessageBox の戻り値と同じ AddSearchBarHistory †[void] AddSearchBarHistory(string ss) [説明] 検索バーの履歴に項目を追加する。文字列がすでに存在する場合は先頭に移動されます。 [引数] ss: 追加する文字列 [戻り値] なし ※未実装 GetUrlHash †[string] GetUrlHash(string strUrl, long nHashByte) [説明] URL のハッシュ値を求めます。 [引数] strUrl: 変換する URL nHashByte: 変換後の URL ハッシュ値のバイト数 [戻り値] データ ※Sleipnir 2.5.17 Release2 + test12 から実装 ExecuteAction †[string] ExecuteAction(string strAction) [説明] Sleipnir の任意のアクションを strAction で指定して実行。 [引数] strAction: アクション名 [戻り値] アクションの実行に成功した場合は true ※Sleipnir 2.6.2 + test12 から実装 |
公式関連サイト
Sleipnir 2.xxリソースコミュニティ
開発者向け情報
テスト版 ＆ 開発中のもの人気の10件 |
