D.1 関数一覧

Formcoordinatorで利用できるJavaScriptには、次に示す関数があります。

■ 関数の概要

カテゴリ	戻り値	関数名	説明
初期化	Object	fjxmlFcCreate	電子フォームが表示されているウィンドウオブジェクトを指定して電子フォーム操作オブジェクト（ブラウザに表示されている電子フォームを操作するためのJavaScriptオブジェクト）を使用するためのインスタンスを生成します。

■ メソッドの概要

カテゴリ	戻り値	関数名	説明
データ取得	Variant	getValue	指定した項目のデータを取得します。
データ取得	String	getXML	電子フォームに入力されているデータをXML形式で取得します。
データ設定	Boolean	setValue	指定した項目にデータを設定します。
属性	Boolean	setFocus	指定した項目にフォーカスを設定します。
エラー	String	getError	メソッドがエラー復帰した原因を示す文字列を取得します。
入力値チェック	Boolean	checkAll	電子フォームのすべての入力値チェック対象項目に対して入力値チェックを行います。
操作	Boolean	click	指定された項目のクリックを実行します。

■ 関数の詳細

fjxmlFcCreate

関数名：

オブジェクト作成関数

形式：

Object fjxmlFcCreate(Object obWin
                     String strClassName)

説明：

電子フォームが表示されているウィンドウ、またはフレームを指定して電子フォーム操作オブジェクトのインスタンスを作成します。

パラメタ：

obWin: 電子フォームが表示されているウィンドウ、またはフレームのウィンドウオブジェクトを指定します。

strClassName: "eform"を指定します。

戻り値：

Object：正常終了: 電子フォーム操作オブジェクトのインスタンスを返します。

null：異常終了

次に示すどれかの場合

パラメタ「obWin」が指定されていない場合
パラメタ「strClassName」が指定されていない場合
パラメタ「strClassName」に誤りがある場合

留意事項：

この関数が返すオブジェクトのインスタンスは電子フォームを表示するウィンドウごとに作成する必要があります。
この関数を必要以上の回数呼び出した場合、ブラウザのメモリを消費してしまうため電子フォームを表示するウィンドウごとに一度だけ呼び出すなど最小限の使用にする、またはこの関数で作成したオブジェクトをdeleteメソッドを使用して開放してください。

■ メソッドの詳細

getValue

メソッド名：

項目データ取得

形式：

Variant getValue(String strItem)

説明：

指定した項目に入力されているデータを通知します。

パラメタ：

strItem: 入力データを取得する項目名を指定します。

戻り値：

成功：Variant: 指定した項目に入力されているデータを返します。未入力の場合は空の文字列を返します。

失敗：null

次に示すどれかの場合

パラメタ「strItem」が指定されていない場合
パラメタ「strItem」に無効な項目名が指定された場合
電子フォームへのアクセスに失敗した場合
メソッドの呼び出しに失敗した場合
内部エラーが発生した場合

留意事項：

指定できる項目名の種類と戻り値を次に示します。

項目種	戻り値
スタティック/矩形スタティックテキスト	nullを返します（エラーコード ER_INVALIDITEM）。
数字/テキスト/矩形テキスト	入力されているデータを返します。
ラジオボタン/チェックボックス	選択されている場合は選択情報を返し、選択されていない場合は非選択情報を返します。
添付ファイル	入力されている添付ファイル名を返します。
メディア	メディアファイル名を返します。
バーコード	バーコードデータを返します。
コマンドボタン	ラベルを返します。ただし、簡易表示モードの場合、非表示属性が指定されている場合はnullを返します（エラーコード ER_INVALIDITEM）。
hidden	設定されている値を返します。
非出力項目	設定されている値を返します。

getXML

メソッド名：

XMLデータ取得

形式：

String getXML([String type])

説明：

電子フォームに入力されているデータをXML形式で通知します。

パラメタ：

type

取得するXMLデータの形式を指定します。このパラメタは省略可能です。
省略時は「SAVE」として動作します。

値	動作
SAVE	保存データ形式のXMLデータを生成します。生成されるXMLデータを次に示します。データルートをルートノードとするXMLを返します。 XML宣言は付加されません。「データを送信する」および「必ずタグを送信する」の指定に関係なく、すべての項目のデータがXMLデータに含まれます。
SUBMIT	送信データ形式のXMLデータを生成します。生成されるXMLデータを次に示します。データルートをルートノードとするXMLを返します。 XML宣言は付加されません。「データを送信する」が指定されていない項目のデータはXMLデータに含まれません。「必ずタグを送信する」が指定されておらず、データが未入力の項目のデータはXMLデータに含まれません。

値

動作

SAVE

保存データ形式のXMLデータを生成します。生成されるXMLデータを次に示します。

データルートをルートノードとするXMLを返します。
XML宣言は付加されません。
「データを送信する」および「必ずタグを送信する」の指定に関係なく、すべての項目のデータがXMLデータに含まれます。

SUBMIT

送信データ形式のXMLデータを生成します。生成されるXMLデータを次に示します。

データルートをルートノードとするXMLを返します。
XML宣言は付加されません。
「データを送信する」が指定されていない項目のデータはXMLデータに含まれません。
「必ずタグを送信する」が指定されておらず、データが未入力の項目のデータはXMLデータに含まれません。

戻り値：

String：正常終了: 電子フォームに入力されているデータをXML形式の文字列で返します。

null：異常終了

次に示すどれかの場合

電子フォームへのアクセスに失敗した場合
メソッドの呼び出しに失敗した場合
パラメタtypeにSAVE、SUBMIT以外の文字列が指定された場合
電子フォームのデータ送信形式に「CGIパラメタ形式で送信する」が指定されている場合
内部エラーが発生した場合

留意事項：

このメソッドが返すXMLデータは正規化処理が行われていません。
添付ファイル項目のデータはXMLデータに含まれません。
このメソッドがnullを返し、getErrorメソッドがエラーコードER_FORM_DATATYPEを返した場合は、データ送信形式に「CGIパラメタ形式で送信する」が指定されている電子フォームに対してgetXMLメソッドを呼び出したことを示します。データ送信形式に「XMLデータ形式で送信する」を指定してください。
typeパラメタにSAVE、SUBMIT以外の文字列が指定された場合、エラーコードにER_PARAMを設定してnullを返します。

setValue

メソッド名：

項目データ設定

形式：

Boolean setValue(String strItem,
                 Variant data)

説明：

指定した項目にデータを設定します。

パラメタ：

strItem: データを設定する項目名を指定します。

data: 項目に設定するデータを指定します。

戻り値：

true：正常終了: 指定した項目にデータを設定した場合に返します。

false：異常終了

次に示すどれかの場合

パラメタ「strItem」が指定されていない場合
パラメタ「data」が指定されていない場合
パラメタ「strItem」に無効な項目名が指定された場合
電子フォームへのアクセスに失敗した場合
メソッドの呼び出しに失敗した場合
内部エラーが発生した場合

留意事項：

指定した項目に非表示または読み取り専用属性が指定されていても値が設定されます。
指定できる項目の一覧を次に示します。失敗の場合、エラーコードはER_INVALIDITEMになります。

項目種	指定可否	備考
スタティック/矩形スタティックテキスト	×	失敗
数字/テキスト/矩形テキスト	○	（注1）（注2）
ラジオボタン/チェックボックス	○	（注3）
添付ファイル	×	失敗
メディア	○	（注1）（注4）
バーコード	○	（注1）（注5）
コマンドボタン	×	失敗
hidden	○	（注6）
非出力項目	○	（注1）

○：指定できます。
×：指定できません。

（注1）	指定したデータがエラーとなる値であっても設定されます。データを設定する項目種、およびその項目の入力値チェックの条件を考慮して値を指定してください。
（注2）	指定した項目の入力種別がドロップダウンリストの場合はリストの値を指定してください。
（注3）	trueまたは"true"、falseまたは"false"を指定します。trueを指定した項目が選択され、falseを指定した項目が非選択になります。また、これら以外を指定した場合、trueを指定した場合と同様に項目が選択されます。
（注4）	簡易表示モードでは、値は設定されますが表示は更新されません。
（注5）	値は設定されますが表示は更新されません。
（注6）	標準表示モードおよび汎用表示モードでは、「キャンセル」ボタンの送信データは更新されません。

setFocus

メソッド名：

フォーカス設定

形式：

Boolean setFocus(String stItem)

説明：

指定した項目にフォーカスを設定します。

パラメタ：

stItem: フォーカスを設定する項目名を指定します。

戻り値：

true：正常終了 false：異常終了

次に示すどれかの場合

パラメタ「stItem」が指定されていない場合
パラメタ「stItem」に無効な項目名が指定された場合
電子フォームへのアクセスに失敗
メソッドの呼び出しに失敗した場合
内部エラーが発生した場合

留意事項：

パラメタ「stItem」に指定した項目が指定できない項目の場合（非表示/読み取り専用を含む）はフォーカスが設定されません。
指定できる項目の一覧を次に示します。失敗の場合、エラーコードはER_INVALIDITEMになります。

項目種	指定可否	備考
スタティック/矩形スタティックテキスト	×	失敗
数字/テキスト/矩形テキスト	○	非表示または読み取り専用属性が指定されている場合は設定されずtrueで復帰します。
ラジオボタン/チェックボックス	○	非表示または読み取り専用属性が指定されている場合は設定されずtrueで復帰します。
添付ファイル	○	非表示または読み取り専用属性が指定されている場合は設定されずtrueで復帰します。
メディア	×	失敗
バーコード	×	失敗
コマンドボタン	×	失敗
hidden	×	失敗
非出力項目	×	失敗

○：指定できます。
×：指定できません。

getError

メソッド名：

エラー通知

形式：

String getError()

説明：

電子フォーム操作オブジェクトのメソッドの呼び出しで最後に発生したエラーの原因を示すエラーコードを通知します。

パラメタ：

なし

戻り値：

戻り値として次に示す値を返します。

String: エラーとなった原因を示すエラーコードを返します。
エラーコードの詳細については「■ エラーコード一覧」を参照してください。

留意事項：

エラーがない場合はER_SUCCESSを返します。
エラーが発生したメソッドの直後で呼び出しを行い、エラーの原因を特定してください。
メソッドが正常に終了した場合は、エラーコードの設定は行なわれません。このため、たとえば3つの処理を行う場合に、最初の処理が失敗して残りの2つの処理が正常に終了したとき、最初の処理により格納されたエラーコードは、残りの2つの処理の正常終了の後も有効になります。

checkAll

メソッド名：

入力値チェック

形式：

Boolean checkAll()

説明：

電子フォームのすべての入力値チェック対象項目に対して入力値チェックを行います。

パラメタ：

なし

戻り値：

true：正常終了: すべての項目に正しい値が入力されている場合にtrueを返します。

false：異常終了

次に示すどれかの場合

電子フォームへのアクセスに失敗した場合
電子フォームに入力エラー項目が存在した場合
メソッドの呼び出しに失敗した場合
内部エラーが発生した場合

留意事項：

このメソッドの呼び出しで入力エラーとなる項目が存在した場合、エラーメッセージが表示されます。標準表示モードの場合は、入力エラーとなった項目のエラー強調（強調が指定されている場合）およびカーソル設定が行われます。このメソッドがfalseを返し、getErrorメソッドがエラーコードER_INPUTDATAを返した場合は入力エラー項目が存在することを示します。

click

メソッド名：

項目クリック

形式：

Boolean click(String stItem)

説明：

指定した項目のクリックを実行します。

パラメタ：

stItem: クリックを実行する項目名を指定します。

戻り値：

true：正常終了 false：異常終了

次に示すどれかの場合

パラメタ「stItem」が指定されていない場合
パラメタ「stItem」に存在しない項目名が指定された場合
ボタン項目以外が指定された場合
電子フォームへのアクセスに失敗した場合
メソッドの呼び出しに失敗した場合
内部エラーが発生した場合

留意事項：

項目名に指定できるのはボタン項目のみです。ボタン項目以外を指定した場合、エラーコードにER_INVALIDITEMを設定し、falseで復帰します。
簡易表示モードでこのメソッドを使用する場合、コマンドボタン項目の項目名は、英数字のみで指定してください。コマンドボタンの項目名に日本語を指定した場合、動作は保証できません。
パラメタに非表示に設定したボタン項目を指定した場合、標準表示モードまたは汎用表示モードの場合は正しく動作しますが、簡易表示モードでは動作しません。

■ エラーコード一覧

電子フォーム操作クラスのgetErrorメソッドが通知するエラーコードの一覧を次に示します。

エラーコード	原因
ER_SUCCESS	成功しました。エラーはありません。
ER_PARAM	パラメタが指定されていません、または指定に誤りがあります。必要なパラメタが指定されていないことを示します。必須パラメタを正しく指定しているか確認してください。 getXMLメソッドを使用している場合はパラメタに「SAVE」、「SUBMIT」以外の文字列が指定されていないか確認してください。
ER_FORMACCESS	電子フォームのアクセスに失敗しました。ページの遷移などが行われ、fjxmlFcCreate関数パラメタに指定したウィンドウに電子フォームが表示されていないことを示します。 fjxmlFcCreate関数に指定したウィンドウに電子フォームが表示されているか確認してください。環境設定の［ジェネレータ］タブで「拡張機能を使用する」が選択されているか確認してください。
ER_INVALIDITEM	無効な項目名が指定されました。処理対象外の項目名を指定したことを示します。項目名を正しく指定しているか確認してください。 clickメソッドを使用している場合はパラメタに指定した項目が読み取り専用になっていないか確認してください。
ER_INPUTDATA	入力エラー項目が存在します。 checkAllメソッドの入力値チェックでエラー項目が存在したことを示します。
ER_FUNC_NOTFOUND	メソッドの呼び出しに失敗しました。表示中の電子フォームでは扱えない関数の呼び出しが行われたことを示します。Formcoordinatorのバージョンが正しいか、環境設定が正しく行われているか確認してください。
ER_INTERNAL	内部エラーが発生しました。処理中に予期せぬエラーが発生したことを示します。Webブラウザをすべて閉じて、電子フォームを再度表示してください。
ER_FORM_DATATYPE	未サポートのデータ送信形式が指定されています。データ送信形式に「CGIパラメタ形式で送信する」が指定されている電子フォームに対してgetXMLメソッドを呼び出したことを示します。