ObjectSetText()関数は、オブジェクトの説明文として表示させる文字列を設定するために使用します。
ObjectSetText()関数は、以下のように定義されています。
bool ObjectSetText(
string object_name,
string text,
int font_size=0,
string font_name=NULL,
color text_color=clrNONE
);
各引数の意味は、以下のとおりです。
- string object_name
文字列を表示させるオブジェクトの名前を指定します。 - string text
オブジェクトの説明文として表示させる文字列を指定します。 - int font_size=0
表示させる文字列のフォントサイズをポイント単位で指定します。 - string font_name=NULL
表示させる文字列のフォント名を指定します。 - color text_color=clrNONE
表示させる文字列の表示色を指定します。
戻り値
ObjectSetText()関数が正常に実行された場合は、「true」を返し、エラーが生じた場合は「false」を返します。
より詳細なエラーに関する情報を取得したい場合は、GetLastError()関数(詳細は「こちら」を参照してください。)を使用する必要があります。
注意点
ObjectSetText()関数で設定した文字列は、テキストオブジェクトとラベルオブジェクトのためには、テキスト行としてチャートウィンドウ上に表示されます。
「font_size」、「font_name」、「text_color」を指定する引数は、テキストオブジェクトとラベルオブジェクトに対してのみ使用することができます。他の種類のオブジェクトに対しては、これらの引数による設定は無視されます。
具体例
チャートウィンドウの左上隅に「Hello World!」という文字列を、
- フォントサイズ:10ポイント
- フォント:MS ゴシック
- 色:SpringGreen
で表示させるためには、以下のように記述します。
#property indicator_chart_window
int init()
{
ObjectCreate(“Hello”,OBJ_LABEL,0,0,0);
ObjectSet(“Hello”,OBJPROP_CORNER,0);
ObjectSet(“Hello”,OBJPROP_XDISTANCE,5);
ObjectSet(“Hello”,OBJPROP_YDISTANCE,18);
return(0);
}
int deinit()
{
ObjectDelete(“Hello”);
return(0);
}
int start()
{
//Hello World !とひょうじされます。
ObjectSetText(“Hello”,”Hello World !”,10,
“MS ゴシック”,SpringGreen);
return(0);
}