OBJECT Get format
OBJECT Get format ( {* ;} object ) : Text
| 引数 | 型 | 説明 | |
|---|---|---|---|
| * | 演算子 | → | 指定時, Objectはオブジェクト名 (文字列) 省略時, Objectはフィールドまたは変数 |
| object | any | → | オブジェクト名 (* 指定時), または フィールドまたは変数 (* 省略時) |
| 戻り値 | Text | ← | オブジェクト表示フォーマット |
このコマンドはスレッドセーフではないため、プリエンプティブなコードには使えません。
説明
OBJECT Get format コマンドは、object引数で指定されたオブジェクトに適用された現在の表示フォーマットを返します。
オプションの * 引数を指定した場合、objectはオブジェクト名です (文字列) 。オプションの * 引数を省略すると、objectはフィールドまたは変数です。この場合、文字列ではなくフィールドまたは変数参照 (フィールドまたは変数のみ) を指定します。
このコマンドはオブジェクトの現在の表示フォーマット、つまりデザインモードやOBJECT SET FORMAT コマンドで定義されたフォーマットを返します。OBJECT Get format は、 表示フォーマットを受け入れるあらゆるタイプのフォームオブジェクト (フィールドや変数) に対して使用することができます (ブール、日付、時間、ピクチャ、文字列、数値、ボタングリッド、ダイヤル、サーモメータ、ルーラ、ピクチャポップアップメニュー、ピクチャボタン、3D ボタン、リストボックスヘッダー)。これらのオブジェクトの表示フォーマットに関する詳細は、OBJECT SET FORMAT コマンドの説明を参照してください。
注: コマンドを一連のオブジェクトに対して適用した場合、最後に選択されたオブジェクトのフォーマットが返されます。
OBJECT Get format コマンドを日付、時間、ピクチャタイプのオブジェクト (定数で定義されたフォーマット) に対して適用すると、定数の文字コードに相当する文字列が返されます。定数の値を取得するには、この戻り値に対してCharacter code コマンドを適用してください(後述)。
例題 1
この例は、“myphoto”という名前のピクチャ変数に対して適用されたフォーマット定数の値を取得します:
C_STRING(2;$format)
OBJECT SET FORMAT(*;"myphoto";Char(On background))
//背景フォーマットを適用する (value = 3)
$format:=OBJECT Get format(*;"myphoto")
ALERT("フォーマット番号:"+String(Character code($format)))
//"3"が表示される
例題 2
この例は、ブールフィールド“[Members]Marital_status”に対して適用されたフォーマットを取得することができます:
C_STRING(30;$format)
$format:=OBJECT Get format([Members]Marital_status)
ALERT($format) //表示フォーマット, 例えば"Married;Single"
例題 3
カスタマイズされたフォーマットは、そのまま返されます:
var $format : Text
OBJECT SET FORMAT(*;"timeinput";":m") //":" は1文字パターンを表すには必要
$format:=OBJECT Get format(*;"timeinput") // 返される値は":m"