ObjectDescription 関数
この関数は、オブジェクトの説明を取得します。
オブジェクトの説明は、ObjectCreate関数で OBJ_TEXT や OBJ_LABEL タイプによって作成された場合、これらのテキスト内容が説明として取得されます。
データ型と構成・戻り値
string ObjectDescription(①);戻り値は、OBJ_TEXT や OBJ_LABEL タイプによって作成されたオブジェクトの場合、これらのテキスト内容が説明として返されます。テキストが無い場合は、何も返されません。
発生するエラーについては、GetLastError関数で取得することができます。
引数 [1]
ObjectDescription関数は 1個の引数で構成されます。
| 番 号 | 引数名 | データ型 | 単位 | 初期値 | 説明 |
|---|---|---|---|---|---|
| ① | object_name | string | － | － | チャート上に描画されているオブジェクト名を指定します。 |
使用例
ObjectDescription関数によるオブジェクトの説明の取得
ObjectCreate関数を用いて、ラベルオブジェクトと垂直線のオブジェクトを作成します。そして作成したオブジェクトの説明を ObjectDescription関数を使って取得します。
コード
// ObjectDescription関数によるオブジェクトの説明の取得
#property strict
void OnInit() {
int xpixcel = (int)(ChartGetInteger(0,CHART_WIDTH_IN_PIXELS));
int fontsize = 15; // フォントサイズ
int xWidth = xpixcel - 240; // 幅
int yHeight = 20; // 高さ
ObjectsDeleteAll(); // オブジェクト全削除
ObjectCreate("obj_t", OBJ_LABEL,0,0,0); // テキストラベルオブジェクト生成
ObjectSet("obj_t", OBJPROP_XDISTANCE,xWidth); // テキストラベルオブジェクトX軸位置設定
ObjectSet("obj_t", OBJPROP_YDISTANCE,yHeight); // テキストラベルオブジェクトY軸位置設定
ObjectSetText("obj_t", "オブジェクトのテキスト", fontsize, "ＭＳ ゴシック", clrYellow); // テキスト設定
ObjectCreate("obj_v", OBJ_VLINE, 0, Time[5], 0); // 垂直線
Print("ラベルオブジェクトの説明：", ObjectDescription("obj_t"));
Print("垂直線オブジェクトの説明：", ObjectDescription("obj_v"));
}
void OnDeinit(const int reason) {
ObjectsDeleteAll();
}コードをコンパイルして実行する方法はこちらを参考にしてください。(デモ口座でお試しください)
結果
ラベルオブジェクトの説明は、セットしたテキスト内容が取得されます。
垂直線オブジェクトの説明は、オブジェクトの中にテキストが無いため何も取得されません。
