formContext.getControl (クライアント API 参照)

フォーム上のコントロールを取得します。

注意

getControl はフォーム本体とヘッダー内のコントロールでのみ機能します。 同じ列を参照している場合でも、ページ上の他の場所にあるコントロールではサポートされません。

• ビジネス プロセス フロー内のコントロールについては、接頭辞 header_process_を使用して参照します。
• サブグリッド や タイムライン コントロール などの他のコントロール内のコントロールはサポートされていません。

構文

formContext.getControl(arg);

formContext.getControl(引数) メソッドは、formContext.ui.controls.get にアクセスするためのショートカット メソッドです。

パラメーター

arg: オプション。 フォーム上のコントロールの名前またはインデックス値として引数を渡すことで、フォーム上のコントロールにアクセスすることができます。 たとえば、formContext.getControl("firstname") や formContext.getControl(0)。 arg 名のスペルが間違っており、フォーム上にない場合、null 値を返します。

arg 値が指定されていない場合、フォーム上のすべてのコントロールの配列を返します。

戻り値

種類: Object コレクション、Object または null。

説明 : パラメーターなしでメソッドを使用する場合は、オブジェクト コレクションです。 パラメータ付きメソッドを使用する場合はオブジェクトまたは null です。 名前 をパラメーターとして使用し、同じ列に複数のコントロールがある場合は、最初のコントロールのみが返されます。

ヒント

フォームの列にバインドされているすべてのコントロールを変更する場合は、列タイプ内のコントロールのコレクションを使用します。 たとえば、name 列にバインドされた各コントロールに通知を追加するには、次のようにします :

 const notification = {
 messages: ['Sample Notification on Name Controls'],
 notificationLevel: 'RECOMMENDATION',
 uniqueId: 'my_unique_id'};
formContext.getAttribute("name").controls.forEach(control => control.addNotification(notification));

関連記事

formContext

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。