列にはモデル駆動型アプリのフォームまたはグリッドのデータが含まれます。
formContext.data.entity.attributes のコレクションまたは formContext.getAttribute のショートカット メソッドを使用して、列のコレクションにアクセスします。 コレクションの詳細については、「コレクション (クライアント API 参照)」を参照してください。
コレクション内の列にアクセスするには、メソッドに引数として列の名前 (文字列) またはインデックス値 (数値) を渡します。 例: formContext.getAttribute(arg)。 引数を指定しない場合、メソッドはフォーム上のすべての属性のコレクションを返します。
列は、種類によって分類されます。 getAttributeType メソッドを使用して、列の型を決定します。 特定の列のメソッドは、特定の種類の列でのみ利用できます。
この記事では、各列の種類で使用できるメソッドについて説明します。
すべての列の種類
controls プロパティは、列に関連付けられたコントロールのコレクションを提供します。
すべての列の種類に対して、次のメソッドを使用できます。
| Method | Description |
|---|---|
| addOnChange | 列の OnChange イベントが発生したときに実行する関数を追加します。 |
| fireOnChange | 列の OnChange イベントをトリガーします。 |
| getAttributeType | 列の型を返します。 |
| getFormat | 列の形式を返します。 |
| getIsDirty | 列に未保存の変更があるかどうかを返します。 |
| getName | 列の論理名を返します。 |
| getParent | 親オブジェクト formContext.data.entity 返します。 |
| getRequiredLevel | 列の値が必須か推奨かを返します。 |
| getSubmitMode | 保存時に列のデータが送信されたときに返されます。 |
| getUserPrivilege | 列の値を作成、読み取り、または更新するためのユーザーの権限を返します。 |
| getValue | 列のデータ値を返します。 |
| isValid | 列の値が有効かどうかを返します。 |
| removeOnChange | 列の OnChange イベント ハンドラーから関数を削除します。 |
| setIsValid | 列の有効性とエラー メッセージを設定します。 |
| setRequiredLevel | 保存する前に列の値を必須にするか推奨するかを設定します。 |
| setSubmitMode | 保存時に列のデータを送信するかどうかを設定します。 |
| setValue | 列のデータ値を設定します。 |
ブール型の列の種類
すべての列型で使用できるメソッドに加えて、 ブール 型の列には次のメソッドが用意されています。
| Method | Description |
|---|---|
| getInitialValue | フォームを開いたときに列の値を返します。 |
検索列の種類
参照列の型には、すべての列の種類で使用できるメソッドに加えて、次のメソッドが用意されています。
| Method | Description |
|---|---|
| getIsPartyList | ルックアップで複数のレコードをパーティ リスト参照として許可するかどうかを返します。 |
選択 (複数) と選択 (単数) 列の種類
すべての列の種類で使用できるメソッドに加えて、 選択肢 と 選択肢 の列の種類には、次のメソッドが用意されています。
| Method | Description |
|---|---|
| getInitialValue | フォームを開いたときに列の値を返します。 |
| getOption | 指定したラベルまたは値に一致するオプションを返します。 |
| getOptions | 列の有効なオプションを返します。 |
| getSelectedOption | 選択したオプションを返します。 |
| getText | 選択したオプションのテキストを返します。 |
列の種類の数字 (小数、二重、整数、通貨)
次のメソッドは、小数、二重、および整数列でのみ利用できます:
| Method | Description |
|---|---|
| getMax | 列の最大値を返します。 |
| getMin | 列の最小値を返します。 |
| getPrecision | 小数点の後に使用できる桁数を返します。 |
| setPrecision | 小数点の後に使用できる桁数を設定します。 |
文字型列の種類
前述のすべての列タイプで利用可能なメソッドに加えて、文字列列でのみ利用可能な以下のメソッドがあります:
| Method | Description |
|---|---|
| getMaxLength | 列の最大文字列長を返します。 |