Index
イベント
イベント発生時に実行できる操作
- フィールドの値を書き換える
- フィールドの編集可／不可を設定する
- フィールドにエラーを表示する
- レコードにエラーを表示する
- ルックアップの取得を自動で行う
- フィールドの表示非表示を切り替える
- 変更されたフィールド、テーブル内の行オブジェクトを取得する
その他
イベント
レコード編集画面が表示された時のイベント
レコードの編集画面を表示した時に発生するイベントです。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
関数
| 環境 | 関数 | イベントが発生するタイミング |
|---|---|---|
| PC用 | app.record.edit.show |
|
| スマートフォン用 | mobile.app.record.edit.show |
|
eventオブジェクトのプロパティ
PC用、スマートフォン用で同一の内容となります。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| appId | 数値 | アプリID |
| record | オブジェクト | レコードオブジェクト |
| recordId | 数値 | レコードID |
フィールドの値に応じた制御
- フィールドの値を書き換える をご参照ください。
- フィールドの編集可／不可を設定する をご参照ください。
- フィールドにエラーを表示する をご参照ください。
- 画面の上部にエラーを表示する をご参照ください。
- ルックアップの取得を自動で行う をご参照ください。
- フィールドの表示／非表示を切り替えるをご参照ください。
制限事項
以下のイベントでは、添付ファイルフィールドの情報が取得できません。
- mobile.app.record.edit.show
※app.record.edit.showでは取得可能です。
レコード編集画面の保存実行前イベント
- PC用とスマートフォン用で利用できるイベントです。
- スペースに貼りつけたアプリには利用できません。
- kintone.Promiseオブジェクトをreturnすると、非同期処理の実行を待ってイベントの処理を開始します。
関数
| 環境 | 関数 | イベントが発生するタイミング |
|---|---|---|
| PC用 | app.record.edit.submit |
|
|
スマートフォン用
|
mobile.app.record.edit.submit |
|
eventオブジェクトのプロパティ
PC用、スマートフォン用で同一の内容となります。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| appId | 数値 | アプリID |
| recordId | 数値 | レコードID |
| record | オブジェクト | ユーザー入力のデータを保持したレコードオブジェクト |
フィールドの値に応じた制御
- フィールドの値を書き換える をご参照ください。
- フィールドにエラーを表示する をご参照ください。
- 画面の上部にエラーを表示する をご参照ください。
- フィールドの表示／非表示を切り替えるをご参照ください。
非同期処理の実行を待ってフィールドの値に応じた制御を行う
kintone.Promiseオブジェクトをreturnすることにより、非同期処理の実行を待ってからフィールドの値に応じた制御を実行することができます。
記述方法はレコード追加画面の保存実行前イベントを参考にしてください。
注意事項
イベント処理の記述方法の注意事項をご確認下さい。
制限事項
以下のイベントでは、添付ファイルフィールドの情報が取得できません。
- app.record.edit.submit
- mobile.app.record.edit.submit
レコード編集画面の保存成功後イベント
- PC用とスマートフォン用で利用できるイベントです。
- スペースに貼りつけたアプリには利用できません。
- kintone.Promiseオブジェクトをreturnすると、非同期処理の実行を待つことができます。
- 保存が失敗した場合にはイベントが実行されません。
関数
| 環境 | 関数 | イベントが発生するタイミング |
|---|---|---|
| PC用 | app.record.edit.submit.success |
|
|
スマートフォン用
|
mobile.app.record.edit.submit.success |
|
eventオブジェクトのプロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| appId | 数値 | アプリID |
| recordId | 数値 | レコードID |
| record | オブジェクト | ユーザー入力のデータを保持したレコードオブジェクト |
urlプロパティの指定
eventオブジェクトにurlプロパティを指定してeventをreturnすると、イベント処理後にそのURLに遷移します。
url プロパティの指定なし、またはnullを指定した場合は、通常通りレコード詳細画面に遷移します。
例えば、次のように記載すると、保存成功後に画面が「http://cybozu.co.jp/」に遷移します。
フィールドの値に応じた制御
ありません。
サンプル
レコード編集画面のフィールド値変更時イベント
- PC用とスマートフォン用で利用できるイベントです。
- スペースに貼りつけたアプリには利用できません。
関数
| 環境 | 関数 | イベントが発生するタイミング |
|---|---|---|
| PC用 | app.record.edit.change.<フィールドコード> |
|
|
スマートフォン用
|
mobile.app.record.edit.change.<フィールドコード> |
|
フィールドコードに指定可能なフィールド
<フィールドコード>に存在するフィールドコード、かつ次の種類のフィールドを指定した場合のみハンドラーが実行されます。 存在しないフィールドコード、または下記の種類以外のフィールドを指定した場合は何も発生しません。
- ラジオボタン
- ドロップダウン
- チェックボックス
- 複数選択
- ユーザー選択
- 組織選択
- グループ選択
- 日付
- 時刻
- 日時
- 文字列(1行)
- 数値
- テーブル
※文字列(1行)と数値フィールドに関して、イベントが発生するタイミングは以下の通りです。ブラウザによって少し挙動が異なります。
- コントロールからフォーカスが外れたタイミング
- ルックアップで値がコピーされたタイミング
- 文字列(1行)フィールドで「自動計算する」設定になっている場合は、自動計算が反映されたタイミング（レコード一覧画面の編集時は、自動計算処理自体が無効なため対象外）
※テーブルフィールドに関して、イベントが発生するタイミングは以下の通りです。
- テーブルの行追加、行削除ボタンがクリックされたタイミング
eventオブジェクトのプロパティ
PC用、スマートフォン用で同一の内容となります。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| appId | 数値 | アプリID |
| record | オブジェクト | イベント発生時点のユーザー入力のデータを保持したレコードオブジェクト |
| recordId | 数値 | レコードID |
| changes | オブジェクト | 変更されたオブジェクト |
| changes.field | オブジェクト | 変更されたフィールドのオブジェクト |
| changes.row | オブジェクト | 変更されたテーブル行のオブジェクト
|
フィールドの値に応じた制御
- フィールドの値を書き換える をご参照ください。
- フィールドの編集可／不可を設定する をご参照ください。
- フィールドにエラーを表示する をご参照ください。
- 画面の上部にエラーを表示する をご参照ください。
- ルックアップの取得を自動で行う をご参照ください。
- フィールドの表示／非表示を切り替えるをご参照ください。
- 変更されたフィールドやテーブル内の行オブジェクトを取得するをご参照ください。
注意事項
イベント処理の記述方法の注意事項をご確認下さい。
制限事項
以下のイベントでは、添付ファイルフィールドの情報が取得できません。
- app.record.edit.change.<フィールドコード>
- mobile.app.record.edit.change.<フィールドコード>
イベント発生時に実行できる操作
フィールドの値を書き換える
ハンドラーが record オブジェクトのフィールドの値を書き換えて event オブジェクトを return した場合、その値でフィールドの値を更新します。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
- ラジオボタンフィールドで空文字列を指定した場合、初期値の選択肢となります。
- フィールドの編集を不可にしても、値を書き換えることができます。
- 編集権限のないフィールドの値を書き換えた場合はフォームには反映されません。
- 最後のハンドラーが return しない場合、フィールドの値を更新しません。
- 複数のハンドラーが登録されている場合、最後のハンドラーが return した戻り値を基準に反映されます。
サンプル
レコード編集画面を開いた時に「文字列_0」 フィールド、テーブル「Table」の1行目の「文字列_1」フィールドに初期値をセットし、さらにテーブルの末尾に行を追加します。
※テーブルの行追加にはフィールドタイプの指定が必要です。PC用とスマートフォン用で利用できます。
書き換えできないフィールド
以下のフィールドは、保存実行前イベントのハンドラーでフィールドの値を書き換えて return しても、フォームには反映されません。
- レコード番号
- 作成者
- 作成日時
- 更新者
- 更新日時
- ステータス
- 作業者
- 計算
- 自動計算にした文字列1行
- 添付ファイル
- ルックアップ
- ルックアップコピー先フィールド
フィールドの編集可／不可を設定する
ハンドラーが record オブジェクトのフィールドの disabled に true/falseを代入して event オブジェクトを return した場合は、そのフィールドは編集不可／可になります。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
- 編集権限のないフィールドを編集可能（disabled を false）にしても反映されません。
サンプル
「ドロップダウン_0」フィールドの値が変更になった時に、「文字列_0」 フィールドを編集不可にします。
編集可／不可にできないフィールド
以下のフィールドの値を編集可／不可を設定して return しても、フォームには反映されません。
- 計算
- ルックアップコピー先フィールド（旧デザインのみ）
フィールドにエラーを表示する
ハンドラーが record オブジェクトのフィールドの error にエラーメッセージを代入して event オブジェクトを return した場合、 フォームの値の書き換えと編集可／不可の設定はキャンセルされ、フィールドにエラーメッセージが表示されます。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
- フィールドの error に null を代入し event オブジェクトを return した場合、そのフィールドに表示されていたエラーを消すことができます。
サンプル
「文字列_0」フィールドとテーブル「Table」の1行目の「文字列_1」フィールドにエラーを表示します。
以下のフィールドは、エラー値を設定してもエラーは発生しません。
- レコード番号
- 作成者
- 作成日時
- 更新者
- 更新日時
- ステータス
- 作業者
レコードにエラーを表示する
ハンドラーが event オブジェクトの error にエラーメッセージを代入して event オブジェクトを return した場合、フィールドの値の書き換えと編集可／不可の設定はキャンセルされ、画面の上部にエラーメッセージが表示されます。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
ルックアップの取得を自動で行う
ルックアップフィールドの lookupプロパティを trueにすると、レコードに値をセットする時にルックアップの取得を実行します。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
サンプル
レコード編集画面を開いた時に「ルックアップ」フィールドに値を入れてデータを取得します。
フィールドの表示／非表示を切り替える
- PC用とスマートフォン用で利用できます。
関数
| 環境 | 関数 | 説明 |
|---|---|---|
| PC用 | kintone.app.record.setFieldShown('フィールドコード', true/false) |
|
|
スマートフォン用
|
kintone.mobile.app.record.setFieldShown('フィールドコード', true/false) |
|
サンプル
レコード編集画面の表示時に、フィールドコード「文字列__1行」を非表示にする例：
以下のフィールドは非表示にできません。
- ラベル
- 罫線
- スペース
- テーブル内のフィールド
変更されたフィールドやテーブル内の行オブジェクトを取得する
変更のあったテーブル内の行オブジェクト、テーブル外のフィールドを取得できます。
- PC用とスマートフォン用で利用できます。
- スペースに貼りつけたアプリには利用できません。
- rowオブジェクトは、テーブル内のイベント時のみ取得できます。
- テーブル内の行を削除した際には、rowオブジェクトは null になります。
その他
関連Tips
レコード編集画面で保存ボタンをクリックした時の関数はapp.record.edit.submitとありますが、
キャンセルボタンをクリックしたときの関数は何になりますでしょうか?
app.record.edit.showイベントでメニュー上側の空白部分にユーザー向けの注意書きを表示して、保存またはキャンセル押下でその注意書きを非表示にしたいと思います。
保存ボタン押下時はapp.record.edit.submitで処理できましたが、キャンセルボタン押下時にボタンを非表示にする方法がわかりません。
よろしくお願いします。
EJM様
キャンセルボタンをクリックした時のイベントはありません。
お手数ですが、要件の実現方法について、cybozu developer コミュニティで相談いただければと存じます。
その際、どういう目的でキャンセル押下時に注意書きを非常時にしたいのかもあわせて記述いただけると回答者が回答しやすいかと思います。
よろしくお願いいたします。
cybozu Development team様
承知しました。必要が生じたら、コミュニティで相談してみます。
ただ、キャンセルボタン押下時のイベントもあると便利なので、今後のVer.UPの際に追加を検討いただけると、ありがたいです。
EJM様
ご確認ありがとうございます。
製品のご要望については、ヘルプの？マークから「kintoneの改善に協力」から送信ができます。
開発者が確認しておりますので、ぜひご活用ください。
cybozu Development team様
「レコード編集画面のフィールド値変更時イベント」の発火タイミングについて教えてください。
こちらのイベントですが、画面での値変更だけではなく、スクリプト内での値変更でも発火するのでしょうか。
また、このイベントで変更前の値を取得することは可能でしょうか。
ご教授ください。
mharum 様
お世話になっております。developer network事務局です。
changeイベントはJavaScriptカスタマイズによる値変更でも発火いたします。
しかし、変更前の値につきましては、現状取得することができません。
変更前の値を取得する場合は、
等のプログラムを記述する必要があるかと思われます。
よろしくお願いいたします。