ページを表すオブジェクトです。
イベント名 |
発生タイミング |
---|---|
loaded |
ページがロードされたとき。 |
.getCell( name )
名前を指定してセルを取得します。
パラメーター
name |
Type: String |
取得したいセルの名前。 |
戻り値
Cell
.getCellArray( name )
名前を指定してセル範囲を取得します。
パラメーター
name |
Type: String |
取得したいセル範囲の名前。 |
戻り値
Cell[]
.getListView( name )
名前を指定してリストビューを取得します。
パラメーター
name |
Type: String |
取得したいリストビューの名前。 |
戻り値
ListView
.getListViews()
ページ内のすべてのリストビューを取得します。
戻り値
ListView[]
.recalc()
ページ内に設定されているすべての数式を再計算させます。
戻り値
なし
.suspendCalc()
ページ内に設定されているすべての数式の計算を中止します。このメソッドを実行するとresumeCalcメソッドを実行するまでは、数式の計算は行われません。
戻り値
なし
.resumeCalc()
ページ内に設定されているすべての数式の計算を再開します。suspendCalcメソッドで数式の計算を中止している場合に、このメソッドを実行して数式の計算を再開させます。
戻り値
なし
.getUserName()
ログイン中のユーザー名を取得します。ログインしていない場合には空文字が返されます。
戻り値
String
.getPageName()
ページ名を取得します。
戻り値
String
.ready( handler )
ページの準備ができた時点で、指定したコールバック関数を実行します。
パラメーター
handler |
Type: Function() |
ページ読み込み完了時に実行するコールバック関数。 |
戻り値
なし
.bind( eventype [, eventData ], handler )
ページが持つイベントに対してイベントハンドラを紐づけます。
標準アクションの停止
紐づけたイベントの元々の動作をキャンセルするには、戻り値にfalseを返します。これにより、イベントバブリングも停止されるため、親要素が持つイベントの発生もキャンセルされます。
イベントへのデータの受け渡し
イベントハンドラにデータを受け渡すには、第2パラメーターに指定します。その場合、イベントハンドラは第3パラメーターに指定します。 受け渡されたデータは、イベントハンドラに渡されるjQueryイベントオブジェクトのdataプロパティから参照できます。
パラメーター
eventType |
Type: String |
紐づけするイベントを表す文字列。 |
eventData(オプション) |
Type: Anything |
イベントハンドラに渡すデータ。関数ではパラメーターであるjQueryイベントオブジェクトのdataプロパティから参照します。 |
handler |
Type: Function( Event eventObject ) |
イベント発生時に実行される関数。 |
戻り値
なし
.unbind( eventType [, handler ] )
指定したイベントハンドラの紐づけを削除します。第2パラメーターを省略した場合、指定イベントに紐づけされたすべてのイベントハンドラが削除されます。
パラメーター
eventType |
Type: String |
紐づけを削除するイベントを表す文字列。 |
handler(オプション) |
Type: Function( Event eventObject ) |
紐づけを削除するイベントハンドラの関数。 |
戻り値
なし
.unbindAll()
要素からすべてのイベントハンドラを削除します。
戻り値
なし
.AutoDisconnectTimeout
※ 本プロパティは、同時接続情報を表示する設定にした場合にのみ有効なAPIです。詳細については 同時接続情報を表示する を参照してください。
本プロパティを使用することで、特定のページだけタイムアウト値を変更できます。タイムアウト値とは、ユーザーが一定期間Forguncyアプリケーションを操作しなかった場合に、Forguncyアプリケーションが自動切断され、同時接続数としてカウントされなくなる場合の時間です。設定する数値の単位は分で、0を設定した場合タイムアウトによる切断は行われません。
サンプルコード
Forguncy.Page.AutoDisconnectTimeout = 60;