iftc.cwf.api.FormObject クラス

クラス

iftc.cwf.api.FormObject

iftc.cwf.api.FormObject

入力フォーム上のオブジェクトの値や設定を制御するためのクラスです。

コンストラクタ

No コンストラクタ パラメータ詳細
1 FormObject(name)
パラメータ 型 説明
name String Formエディターのオブジェクトのプロパティで設定したオブジェクト名
2 FormObject(name, formKey, page)
パラメータ 型 説明
name String Formエディターのオブジェクトのプロパティで設定したオブジェクト名
formKey String Formエディターの[フォーム設定]で設定したフォーム識別子
page Number 取得対象のオブジェクトが存在するページ
3 FormObject(element)
パラメータ 型 説明
element Element オブジェクトの要素

  • No1とNo2のコンストラクタ実行時に同名オブジェクトが存在する場合、オブジェクト番号の若いオブジェクトの
    FormObjectインスタンスが作成されます。

  • No3で受け取ることのできる要素は、以下の入力フォームオブジェクトのみです。

    • 入力テキスト
    • コンボボックス
    • リストボックス
    • チェックボックス
    • ラジオボタン
    • 情報表示フィールド
    • コメントフィールド
    • 自動採番フィールド

    以下のオブジェクトは動作保証外です。

    • 印影フィールド
    • 手動印影フィールド
    • 日付印フィールド
    • 画像フレーム
    • PDFオブジェクト（V5.2以降のバージョンで利用可能なオブジェクト）

  • name に存在しないオブジェクト名が指定されている場合など、正常に FormObjectインスタンスが作成できない場合、
    空のオブジェクトを返します。

メソッド一覧

メソッド 概要 導入バージョン
getMultiFormProperty マルチフォームが設定されたフォーム でオブジェクトが配置されているページのフォーム識別子およびマルチフォームの中で何ページ目なのかを取得します。 V5.2
getOriginElement FormObjectオプジェクトをインスタンス化したオブジェクト要素を取得します。 V5.2
getRawValue オブジェクトの [フォーマット]タブ で指定したフォーマット（桁区切りや通貨記号など）を除いた値を取得します。 V5.2
invokeEvent オブジェクトの [HTML]タブ - [JavaScript] に設定したイベントを強制的に実行します。 V5.2
setChecked チェックボックス・ラジオボタンのチェック状態を変更します。 V5.2
setReadOnly オブジェクトの読取専用設定を切り替えます。 V5.2
setRequired オブジェクトの必須入力設定を切り替えます。 V5.2
setSelected コンボボックス・リストボックスの選択項目を変更します。 V5.2
updateValue 入力テキストの値を更新します。 V5.2

メソッド詳細

getMultiFormProperty

getMultiFormProperty()

マルチフォームが設定されたフォーム でオブジェクトが配置されているページのフォーム識別子およびマルチフォームの中で何ページ目なのかを取得します。

パラメータ

なし

戻り値

MultiFormPropertyオブジェクト。
マルチフォームでページごとに区別しないオブジェクトの場合、「undefined」。
getOriginElement

getOriginElement()

FormObjectオプジェクトをインスタンス化したオブジェクトの要素を取得します。

パラメータ

なし

戻り値

オブジェクトの要素
getRawValue

getRawValue()

オブジェクトの [フォーマット]タブ で指定したフォーマット（桁区切りや通貨記号など）を除いた値を取得します。

iftc.cwf.api.Forms.getRawValue(target) と同じ動作です。

パラメータ

なし

戻り値

指定した要素のフォーマットされていない値（桁区切りや通貨記号などを除いた値）
invokeEvent

invokeEvent(eventType)

オブジェクトの [HTML]タブ - [JavaScript] に設定したイベントを強制的に実行します。

iftc.cwf.api.Forms.invokeEvent(target, eventType) と同じ動作です。

パラメータ

パラメータ 型 説明
eventType String 実行するイベントの種類（onChange, onBlur など）

戻り値

なし
setChecked

setChecked(checked)

チェックボックス・ラジオボタンのチェック状態を変更します。

パラメータ

パラメータ 型 説明
checked Bool
値 説明
true チェックを入れる
false チェックを外す

戻り値

なし

同名オブジェクトのチェック状態を切り替える処理の実装方法がチェックボックスとラジオボタンで異なります。

  • チェックボックス

1つの処理ですべての同名オブジェクトのチェック状態を一括で切り替えることが可能です。
例）オブジェクト名が「ICHECK000」のチェックボックスが2つ以上フォーム上に配置されているとき、
　　「ICHECK000」のチェックボックスのチェックを一括でクリアする方法

// 同名オブジェクトのチェック状態を一括で変更可能
new iftc.cwf.api.FormObject("ICHECK000").setChecked(false);
  • ラジオボタン

同名オブジェクトの数分、チェック状態を切り替える処理を実装する必要があります。
例）オブジェクト名が「IRADIO000」のラジオボタンが2つ以上フォーム上に配置されているとき、
　　「IRADIO000」のラジオボタンのチェックを一括でクリアする方法

// APIをインスタンス化
const forms = new iftc.cwf.api.Forms();

const formObject = forms.getFormObjectsByName("IRADIO000");
// 同名オブジェクトの数分、チェックをクリア
for(let i=0 ; i < formObject.length ; i++){
    formObject[i].setChecked(false);
}
setReadOnly

setReadOnly(readonly)

オブジェクトの読取専用設定を切り替えます。
同名オブジェクトの読取専用は切り替えません。

パラメータ

パラメータ 型 説明
readonly Bool
値 説明
true オブジェクトを読取専用にします
false オブジェクトを入力可能にする

戻り値

なし

imgwarn 注意

  • 日付フォーマットの入力テキストの場合、読取専用にしてもカレンダーからは入力が可能です。
  • 以下の場合、変更したオブジェクトの状態は保持されません。必要に応じて、入力フォーム表示時のJavaScript にも同様の処理を実装してください。
    • ユーザーがF5キー押下などで入力フォーム画面を更新した場合
    • 次の操作で入力フォームが再表示された場合
      • 下書き案件を開く
      • ルート変更後、入力フォームに戻る
      • マルチフォームページ追加/削除


同名オブジェクトの読取専用を切り替える場合、同名オブジェクトの数分、読取専用を切り替える処理を実装する必要があります。
例）ラジオボタンオブジェクト「IRADIO000」の読取専用を設定する場合

// APIをインスタンス化
const forms = new iftc.cwf.api.Forms();

const formObject = forms.getFormObjectsByName("IRADIO000");
// 同名オブジェクトの数分、読取専用に変更
for(let i=0 ; i < formObject.length ; i++){
    formObject[i].setReadOnly(true);
}
setRequired

setRequired(required)

オブジェクトの必須入力設定を切り替えます。
同名オブジェクトの必須入力設定も切り替えることができます。

パラメータ

パラメータ 型 説明
required Bool
値 説明
true オブジェクトを必須入力にします
false オブジェクトの必須入力を解除します

戻り値

なし

imgwarn 注意

  • ユーザーがF5キー押下などで入力フォーム画面を更新した場合、変更したオブジェクトの状態は保持されません。
  • 以下の場合、変更したオブジェクトの状態は保持されません。必要に応じて、入力フォーム表示時のJavaScript にも同様の処理を実装してください。
    • ユーザーがF5キー押下などで入力フォーム画面を更新した場合
    • 次の操作で入力フォームが再表示された場合
      • 下書き案件を開く
      • ルート変更後、入力フォームに戻る
      • マルチフォームページ追加/削除
setSelected

setSelected(value)

コンボボックス・リストボックスの選択項目を変更します。
同名オブジェクトの選択項目も変更することができます。

パラメータ

パラメータ 型 説明
value String 変更する項目の書き出し値

戻り値

なし
updateValue

updateValue(value)

入力テキストの値を更新します。
同名オブジェクトの値も更新することができます。

iftc.cwf.api.Forms.updateValue(target, value) と同じ動作です。

パラメータ

パラメータ 型 説明
value String 更新後のオブジェクトの値

戻り値

なし
imggotop ページTOPへ