WebForm
WebForm クラスには、Qodly の Web ページコンポーネントを処理するための関数とプロパティが含まれています。 4D.WebForm オブジェクトは webForm コマンドによってインスタンス化されます。
履歴
| リリース | 内容 |
|---|---|
| 20 R6 | enableState() と disableState() を追加 |
| 20 R2 | 追加 |
コマンドと関数
プロパティとして直接利用可能なオブジェクトです |
| .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 ページに送信します |
.componentName
.componentName : 4D.WebFormItem
説明
Web ページのコンポーネント (構成要素) とは、これらの Web ページのプロパティとして直接利用可能なオブジェクトです。
返されるオブジェクトは、4D.WebFormItem クラスのものです。 これらのオブジェクトは、コンポーネントを動的に管理するために使用できる関数を持っています。
例題
shared singleton Class constructor()
var myForm : 4D.WebForm
var component : 4D.WebFormItem
myForm:=webForm // Web ページをオブジェクト返し、各プロパティがコンポーネントを表す
component:=myForm.myImage // Web ページの myImage コンポーネントを返す
myForm はデバッガの中で調べる場合には一般的なオブジェクトのプロパティを表示しないかもしれませんが、実際のwebForm オブジェクトであるかのように振る舞います。 myForm を通して、下地となるwebForm オブジェクトのプロパティと関数を操作することができます。 例えば、ページのコンテンツを動的に操作したり、あるいは myForm.setMessage() のような特殊な関数を使用してWebページにメッセージを送信したりすることができます。
.disableState()
.disableState( state : string)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| state | string | -> | Web ページ上で無効化するstate の名前 |
説明
.disableState() 関数は、カレントのWeb ページ内の state の状態のレンダリングを無効化します。
この関数は、以下の場合には何もしません:
- state 引数のステートが現在Web ページ内で有効化されていない
- Web ページに対して state 引数のステートが存在しない。
同じユーザー関数内で複数の state を 有効化 または無効化した場合、すべての変更は関数の終了時に一括してクライアントに送信されます。
Web ページのステートについての詳細な情報については、Qodly ドキュメンテーションのStates の章 を参照してください。
.enableState()
.enableState( state : string )
| 引数 | 型 | 説明 | |
|---|---|---|---|
| state | string | -> | Web ページ上で有効化する state の名前 |
説明
.enableState() 関数は、カレントのWeb ページ内の state の状態のレンダリングを有効化します。
この関数は、以下の場合には何もしません:
- state 引数のステートが現在Web ページ内で有効化されている
- Web ページに対して state 引数のステートが存在しない。
同じユーザー関数内で複数の state を有効化または 無効化した場合、すべての変更は関数の終了時に一括してクライアントに送信されます。
Web ページのステートについての詳細な情報については、Qodly ドキュメンテーションのStates の章 を参照してください。
例題
ログインページでエラーが発生した場合に、"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 ページに送信します。
この関数は、__NOTIFICATION.message プロパティが msg に、そして __NOTIFICATION.type が "error" に設定されている __WEBFORM オブジェクトと、 200 OK ステータスが本文に含まれているレスポンスを返します。
例題
shared singleton Class constructor()
exposed function myError()
var myForm : 4D.WebForm
myForm:=web Form
myForm.setError("My error message")
イベントに対して Provide feedback 機能が有効化されていた場合、 message 引数のメッセージは自動的に赤い toast としてページ下部に表示され、5秒後に自動的に消滅します:
.setMessage()
.setMessage( msg : string)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| msg | string | -> | Web ページに表示する情報メッセージ |
説明
.setMessage() 関数は、msg を情報メッセージとしてWeb ページに送信します。
この関数は、__NOTIFICATION.message プロパティが msg に、そして __NOTIFICATION.type が "message" に設定されている __WEBFORM オブジェクトと、 200 OK ステータスが本文に含まれているレスポンスを返します。
例題
shared singleton Class constructor()
exposed function myMessage()
var myForm : 4D.WebForm
myForm:=web Form
myForm.setMessage("My information message")
イベントに対して Provide feedback 機能が有効化されていた場合、 message 引数のメッセージは自動的に緑の toast としてページ下部に表示され、5秒後に自動的に消滅します:
.setWarning()
.setWarning( msg : string)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| msg | string | -> | Web ページに表示する警告メッセージ |
説明
.setWarning() 関数は、msg 引数のメッセージを警告メッセージとしてWeb ページに送信します。
この関数は、__NOTIFICATION.message プロパティが msg に、そして __NOTIFICATION.type が "warning" に設定されている __WEBFORM オブジェクトと、 200 OK ステータスが本文に含まれているレスポンスを返します。
例題
shared singleton Class constructor()
exposed function myWarning()
var myForm : 4D.WebForm
myForm:=web Form
myForm.setWarning("My warning message")
イベントに対して Provide feedback 機能が有効化されていた場合、 message 引数のメッセージは自動的に黄色の toast としてページ下部に表示され、5秒後に自動的に消滅します:
