iftc.cwf.api.Forms クラス

クラス

iftc.cwf.api.Forms

iftc.cwf.api.Forms

入力フォームの状態や表示しているユーザーの情報を取得するためのクラスです。

コンストラクタ

コンストラクタ
Forms()

メソッド一覧

メソッド 概要 導入バージョン
getElementsByName マルチフォームが設定されたフォーム の [ページごとに区別するオブジェクト] に設定されているオブジェクトの要素を取得します。 V5.0
getPageCount マルチフォームが設定されたフォーム の入力フォーム上に存在するページ数を取得します。 V5.0
getRawValue オブジェクトの [フォーマット]タブ で指定したフォーマット（桁区切りや通貨記号など）を除いた値を取得します。 V5.0
invokeEvent オブジェクトの [HTML]タブ - [JavaScript] に設定したイベントを強制的に実行します。 V5.0
updateValue オブジェクトの値を更新します。
[フォーマット]タブ でフォーマット（桁区切りや通貨記号など）を設定した入力テキスト、または、[計算]タブ の [計算に使用するカラム] に指定した入力テキストの更新に使用します。		 V5.0
getCurrentWorkFlowNode 現在処理中のユーザー情報を取得します。 V5.2
getFormObjectsByName パラメータで指定したオブジェクト名の FormObjectインスタンス を取得します。 V5.2
isDrafts 入力フォームが下書きした案件かどうかを取得します。 V5.2
isOperatedByProxyUser 入力フォームを表示しているユーザーが代理・代行者かどうかを取得します。 V5.2
isShownFirst 入力フォームの表示が初回表示かどうかを取得します。 V5.2

メソッド詳細

getElementsByName

getElementsByName(name, formKey, page)

マルチフォームが設定されたフォーム の [ページごとに区別するオブジェクト] に設定されているオブジェクトの要素を取得します。

パラメータ

パラメータ 型 説明
name String Formエディターのオブジェクトのプロパティで設定したオブジェクト名
formKey String Formエディターの[フォーム設定]で設定したフォーム識別子
page Number 取得対象のオブジェクトが存在するページ

戻り値

指定した条件に該当するオブジェクトの要素の配列
getPageCount

getPageCount(formkKey)

マルチフォームが設定されたフォーム の入力フォーム上に存在するページ数を取得します。

パラメータ

パラメータ 型 説明
formKey String Formエディターの[フォーム設定]で設定したフォーム識別子

戻り値

指定したフォーム識別子に該当するフォームの入力フォーム上に存在するページ数。
Formエディターで未設定のフォーム識別子を指定した場合は「 -1」。

HTMLプレビュー時の戻り値は、「Formエディターの[フォーム設定]で設定したマルチフォームの最小ページ数」固定です。
getRawValue

getRawValue(target)

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

iftc.cwf.api.FormObject.getRawValue() と同じ動作です。
V5.2以降のバージョンの場合、iftc.cwf.api.FormObject.getRawValue() の利用を推奨します。

パラメータ

パラメータ 型 説明
target Element フォーマットを除去する対象のオブジェクトの要素

戻り値

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

invokeEvent(target, eventType)

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

iftc.cwf.api.FormObject.invokeEvent(eventType) と同じ動作です。
V5.2以降のバージョンの場合、iftc.cwf.api.FormObject.invokeEvent(eventType) の利用を推奨します。

パラメータ

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

戻り値

なし
updateValue

updateValue(target, value)

オブジェクトの値を更新します。[フォーマット]タブ でフォーマット（桁区切りや通貨記号など）を設定した入力テキスト、または、[計算]タブ の [計算に使用するカラム] に指定した入力テキストの更新に使用します。
通常、value属性で値を変更しても、onChangeイベントは実行されませんが、このメソッドを利用して値を変更した場合は、API内部でイベントが実行されるため iftc.cwf.api.Forms.invokeEvent()の呼び出しは不要です。

iftc.cwf.api.FormObject.updateValue(value) と同じ動作です。
V5.2以降のバージョンの場合、iftc.cwf.api.FormObject.updateValue(value) の利用を推奨します。

パラメータ

パラメータ 型 説明
target Element 値を更新するオブジェクトの要素
value String 更新後の値

戻り値

なし
getCurrentWorkFlowNode

getCurrentWorkFlowNode()

現在処理中のユーザー情報を取得します。
代理・代行者による操作の場合、代理・代行依頼者の情報を取得します。

パラメータ

なし

戻り値

ユーザーの情報一式（WorkFlowNodeオブジェクト）

代理・代行者の情報は、WorkFlowNodeオブジェクト のproxyInfoプロパティから取得します。
getFormObjectsByName

getFormObjectsByName(name[, formKey, page])

パラメータ name で指定したオブジェクト名の FormObjectインスタンスを取得します。
パラメータ formKey や page を指定すると、マルチフォームが設定されたフォーム 上の FormObjectインスタンス を取得します。

パラメータ

パラメータ 型 説明
name * 必須 String Formエディターのオブジェクトのプロパティで設定したオブジェクト名
formKey String Formエディターの[フォーム設定]で設定したフォーム識別子
page Number 取得対象のオブジェクトが存在するページ

戻り値

パラメータ name で指定したオブジェクト名の入力フォームオブジェクトに対する FormObjectインスタンス の配列。
指定したオブジェクト名のオブジェクトが存在しない場合は、空の配列。

指定したパラメータによって、戻り値は以下の通りになります。

  • パラメータ name と formKey を指定した場合、formKey で指定したマルチフォーム上の全てのページにあるオブジェクトに対する FormObjectインスタンス の配列
    （例：formKey で指定したマルチフォームが3ページまで追加されていた場合、計3つのFormObjectインスタンスを配列として取得）
  • 全パラメータを指定した場合、formKey や page で指定したマルチフォーム・ページにあるオブジェクトに対する FormObjectインスタンス の配列
isDrafts

isDrafts()

入力フォームが下書きした案件かどうかを取得します。
申請フォームでのみ使用可能です。承認フォームでは使用できません。

パラメータ

なし

戻り値

下書きした案件かどうかのBool値

戻り値 説明
true 下書きした案件
false 下書きした案件ではない
HTMLプレビュー時の戻り値は、「false」固定です。
isOperatedByProxyUser

isOperatedByProxyUser()

入力フォームを表示しているユーザーが代理・代行者かどうかを取得します。

パラメータ

なし

戻り値

代理・代行者かどうかのBool値

戻り値 説明
true 代理・代行者
false 代理・代行者ではない（申請者・承認者本人）
HTMLプレビュー時の戻り値は、「false」固定です。
isShownFirst

isShownFirst()

入力フォームの表示が初回表示かどうかを取得します。

パラメータ

なし

戻り値

初回表示かどうかのBool値

戻り値 説明
true 初回表示
false

初回表示ではない

例)

HTMLプレビュー時の戻り値は、「true」固定です。
imggotop ページTOPへ