LunaItemXmlBuilder API リファレンス
ドキュメントバージョン:1.11 はじめに
LunaItemXmlBuider オブジェクトは、拡張サイドバープラグインから利用可能なスクリプティングオブジェクトです。 スクリプトはツリー構造で管理されているデ ータに対してアイテムの追加を行うことができます。
注意事項
プラグインや、Windows スクリプトを利用したスクリプトなどは便利な反面、悪意をもった作者が作成したプログラムを利用した場合、使用者の想定していない動作 を引き起こし、ウイルス感染やコンピュータのクラッシュなどにつながる可能性があります。 スクリプトやプラグインを利用する場合は、必ずそのスクリプトの安全 性を確認してから利用するようにしてください。
目次
[1] string GetRootItemID [2] string GetNextSiblingItemID [3] string GetPrevSiblingItemID [4] string GetChildItemID [5] string GetParentItemID [6] long ItemImageType [7] string ItemTitle
[8] string ItemURL [9] string ItemComment [10] string ItemType [11] string AppendChild
[12] string ConvertToSearchString [13] string ToString
関数詳細
[1] string GetRootItemID (void )
引数 なし
戻り値
string - ドキュメントのルートアイテム ID(GUID)
仕様
指定されたドキュメントのルートアイテムの ID(GUID)を取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
[2] string GetNextSiblingItemID (string id)
引数 id - アイテム ID
戻り値
string - 次にあるアイテムのアイテム ID(GUID) 仕様
指定されたアイテムの次の兄弟アイテムのアイテム ID(GUID)を取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idItem1
idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem1") Dim idItem2
idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2") Dim idNext
idNext = LunaItemXmlBuilder.GetNextSiblingItemID(idItem1) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem1"); var idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2"); var idNext = LunaItemXmlBuilder.GetNextSiblingItemID(idItem1);
[3] string GetPrevSiblingItemID (string id)
引数
id - アイテム ID(GUID)
戻り値
string - 前にあるアイテムのアイテム ID(GUID)
仕様
指定されたアイテムの前の兄弟アイテムのアイテム ID(GUID)を取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idItem1
idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem1") Dim idItem2
idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2") Dim idPrev
idPrev = LunaItemXmlBuilder.GetPrevSiblingItemID(idItem2) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem1"); var idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2"); var idPrev = LunaItemXmlBuilder.GetPrevSiblingItemID(idItem2);
[4] string GetChildItemID (string id)
引数
id - 親アイテムの ID(GUID)
戻り値
string - 子アイテムの ID(GUID)
仕様
指定されたアイテムの子アイテムの ID(GUID)を取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idItem1
idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_FOLDER", "NewItem1") Dim idItem2
idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2") Dim idChild
idChild = LunaItemXmlBuilder.GetChildItemID(idItem1) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_FOLDER", "NewItem1"); var idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2"); var idChild = LunaItemXmlBuilder.GetChildItemID(idItem1);
[5] string GetParentItemID (string id)
引数
id - アイテム ID(GUID)
戻り値
string - 親アイテムのアイテム ID(GUID)
仕様
指定されたアイテムの親アイテムのアイテム ID(GUID)を取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idItem1
idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_FOLDER", "NewItem1") Dim idItem2
idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2") Dim idParent
idParent = LunaItemXmlBuilder.GetParentItemID(idItem2) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idItem1 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_FOLDER", "NewItem1"); var idItem2 = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "NewItem2"); var idParent = LunaItemXmlBuilder.GetParentItemID(idItem2);
[6] long ItemImageType (string id)
引数
id - アイテム ID(GUID)
戻り値
long - イメージ番号(アイコンインデックス)
仕様
指定されたアイテムのイメージ番号(アイコンインデックス)を設定・取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idNewItem
idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム") LunaItemXmlBuilder.ItemImageType(idNewItem) = 1
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemImageType(idNewItem)) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム"); LunaItemXmlBuilder.ItemImageType(idNewItem) = 1;
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemImageType(idNewItem));
[7] string ItemTitle (string id)
引数
id - アイテム ID(GUID)
戻り値 string - タイトル
仕様
指定されたアイテムのタイトルを設定・取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idNewItem
idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム") LunaItemXmlBuilder.ItemTitle(idNewItem) = "アイテム"
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemTitle(idNewItem))
JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム"); LunaItemXmlBuilder.ItemTitle(idNewItem) = "アイテム";
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemTitle(idNewItem));
[8] string ItemURL (string id)
引数
id - アイテム ID(GUID)
戻り値 string - URL
仕様
指定されたアイテムの URL を取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idNewItem
idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム") LunaItemXmlBuilder.ItemTitle(idNewItem) = "http://www.luna.tv/"
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemURL(idNewItem)) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム"); LunaItemXmlBuilder.ItemTitle(idNewItem) = "http://www.luna.tv/";
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemURL(idNewItem));
[9] string ItemComment (string id)
引数
id - アイテム ID(GUID)
戻り値 string - コメント
仕様
指定されたアイテムのコメントを設定・取得します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idNewItem
idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム")
LunaItemXmlBuilder.ItemTitle(idNewItem) = "コメント"
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemComment(idNewItem)) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム"); LunaItemXmlBuilder.ItemTitle(idNewItem) = "コメント";
Lunascape.OutputAddString(LunaItemXmlBuilder.ItemComment(idNewItem));
[10] string ItemType (string id)
引数
id - アイテム ID(GUID)
戻り値
string - アイテムの種類(文字列)
仕様
指定されたアイテムの種類を取得します。戻り値には以下の物があります。FAVORITE_LINK - リンクであることを示します。 FAVORITE_FOLDER - フォルダであることを示します。 FAVORITE_ROOT - ルートフォルダであることを示します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idNewItem
idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム") Lunascape.OutputAddString(LunaItemXmlBuilder.ItemType(idNewItem))
JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム"); Lunascape.OutputAddString(LunaItemXmlBuilder.ItemType(idNewItem));
[11] string AppendChild (string id,string type,string title)
引数
id - 追加するアイテムの ID(GUID)type - 追加するアイテムの種類(文字列) type に指定できる値には以下の物があります。
・FAVORITE_LINK - リンクであることを示します。 ・FAVORITE_FOLDER - フォルダであることを示します。 title - 追加するアイテムのタイトル
戻り値
string - 追加されたアイテムの ID(GUID)
仕様
子アイテムを追加します。 使用例
VBScript
Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idNewItem
idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム") JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム");
[12] string ConvertToSearchString (string text,string type)
引数
text - エンコードする URLtype - エンコード方法
ConvertToSearchString でサポートしているエンコード方法 文字セット名 指定方法
Unicode(UTF-8): utf-8 日本語(EUC): euc 日本語(シフト JIS): s-jis
戻り値
string - エンコードされた URL
仕様
URL をエンコーディングします。
使用例 VBScript Dim strURL
strURL = "http://www.google.com/search?q=" & LunaItemXmlBuilder.ConvertToSearchString("タブブラウザ", "utf-8") JScript
var strURL = "http://www.google.com/search?q=" + LunaItemXmlBuilder.ConvertToSearchString("タブブラウザ", "utf-8");
[13] string ToString (void )
引数 なし
戻り値
string - XML データ
仕様
現在登録されているアイテムから<opml>形式の XML を作成します。
使用例 VBScript Dim idRoot
idRoot = LunaItemXmlBuilder.GetRootItemID() Dim idNewItem
idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム")
Lunascape.OutputAddString(LunaItemXmlBuilder.ToString()) JScript
var idRoot = LunaItemXmlBuilder.GetRootItemID();
var idNewItem = LunaItemXmlBuilder.AppendChild(idRoot, "FAVORITE_LINK", "新規アイテム"); Lunascape.OutputAddString(LunaItemXmlBuilder.ToString());
Copyright(c) 2011 - by Lunascape Corporation.