WebForm
WebForm クラスには、Qodly の Webフォームコンポーネント (Webフォームの構成要素) を処理するための関数とプロパティが含まれています。 このクラスについては、Qodly ドキュメンテーション (英語) で詳しく説明されています。
履歴
| リリース | 内容 |
|---|---|
| 20 R6 | enableState() と disableState() を追加 |
| 20 R2 | 追加 |
コマンドと関数
| [.componentName : 4D.WebFormItem](#componentname) プロパティとして直接利用可能なオブジェクトです |
| .disableState( state : string) カレントWeb |
| フォーム上の state のレンダリングを無効化します |
| .enableState( state : string ) カレントWeb |
| フォーム上の state のレンダリングを有効化します |
| .setError( msg : string) msg をエラーメッセージとして Webフォームに送信します |
| .setMessage( msg : string) msg を情報メッセージとして Webフォームに送信します |
| .setWarning( msg : string) msg を警告メッセージとして Webフォームに送信します |
| Web Form : 4D.WebForm Webフォームとの対話を可能にする 4D.WebForm プロキシオブジェクトを返します |
| Web Event : Object Webフォームコンポーネントにリンクして発生したイベントの情報を持つオブジェクトを返します |
.componentName
.componentName : 4D.WebFormItem
説明
Webフォームのコンポーネント (構成要素) とは、これらの Webフォームのプロパティとして直接利用可能なオブジェクトです。
詳細については、Qodly ドキュメンテーションの .componentName の説明 を参照ください。
.disableState()
.disableState( state : string)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| state | string | -> | Webフォーム上で無効化する state の名称 |
説明
.disableState() 関数は、カレントWeb
フォーム上の state のレンダリングを無効化します。
この関数は、以下の場合には何もしません:
- Webフォーム上で state が現在有効ではない。
- Webフォーム上で state が存在しない。
同じユーザー関数内で複数の state を 有効化 または無効化した場合、すべての変更は関数の終了時に一括してクライアントに送信されます。
Webフォームの state に関する詳細については、developer.qodly.com を参照ください。
.enableState()
.enableState( state : string )
| 引数 | 型 | 説明 | |
|---|---|---|---|
| state | string | -> | Webフォーム上で有効化する state の名称 |
説明
.enableState() 関数は、カレントWeb
フォーム上の state のレンダリングを有効化します。
この関数は、以下の場合には何もしません:
- Webフォーム上で state がすでに有効である。
- Webフォーム上で state が存在しない。
同じユーザー関数内で複数の state を有効化または 無効化した場合、すべての変更は関数の終了時に一括してクライアントに送信されます。
Webフォームの state に関する詳細については、developer.qodly.com を参照ください。
例題
ログインページでエラーが発生した場合に、"wrongCredentials" という専用の state を有効にします。
Function authenticationError()
If (Session.info.type#"remote")
Web Form.enableState("wrongCredentials")
End if
.setError()
.setError( msg : string)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| msg | string | -> | Webフォームに表示するエラーメッセージ |
説明
.setError() 関数は、msg をエラーメッセージとして Webフォームに送信します。
詳細については、Qodly ドキュメンテーションの .setError() の説明 を参照ください。
.setMessage()
.setMessage( msg : string)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| msg | string | -> | Webフォームに表示する情報メッセージ |
説明
.setMessage() 関数は、msg を情報メッセージとして Webフォームに送信します。
詳細については、Qodly ドキュメンテーションの .setMessage() の説明 を参照ください。
.setWarning()
.setWarning( msg : string)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| msg | string | -> | Webフォームに表示する警告メッセージ |
説明
.setWarning() 関数は、msg を警告メッセージとして Webフォームに送信します。
詳細については、Qodly ドキュメンテーションの .setWarning() の説明 を参照ください。
Web Form
Web Form : 4D.WebForm
| 引数 | 型 | 説明 | |
|---|---|---|---|
| 戻り値 | 4D.WebForm | <- | 新しい WebForm プロキシオブジェクト |
説明
Web Form コマンドは、Webフォームとの対話を可能にする 4D.WebForm プロキシオブジェクトを返します。
詳細については、Qodly ドキュメンテーションの webForm コマンドの説明 を参照ください。
Web Event
Web Event : Object
| 引数 | 型 | 説明 | |
|---|---|---|---|
| 戻り値 | object | <- | object |
説明
Web Event コマンドは、Webフォームコンポーネントにリンクして発生したイベントの情報を持つオブジェクトを返します。
詳細については、Qodly ドキュメンテーションの webEvent コマンドの説明 を参照ください。