コントロール (クライアント API 参照)

モデル駆動型アプリでは、コントロールはフォーム上の HTML 要素を表します。 特定の列にバインドされるコントロールもあれば、フォームに追加された IFRAME、Web リソース、サブグリッドなどの非連結コントロールを表すコントロールもあります。

コントロールオブジェクトには、コントロールの表示や動作を変更して、対応する列を指定する方法が用意されています。 次のいずれかのコレクションを使用してアクセス制御を行います。

• formContext.ui.controls
• formContext.ui Section.controls
• formContext.data.entityAttribute.controls

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

ヒント

列に関連付けられているコントロールに対してアクションを実行する場合は、そのコントロールがページに複数回表示される可能性があることを考慮してください。 一般に、列の各コントロールに対して同じアクションを実行する必要があります。 列 コントロール コレクション をループ処理し、各コントロールに対してアクションを実行できます。

コントロールは、種類によって分類されます。 getControlType メソッドを使用して、コントロールの型を決定します。 特定のコントロール メソッドは、特定の種類のコントロールでのみ使用できます。

この記事では、各コントロールの種類で使用できるメソッドに関する情報を提供します。

標準コントロール タイプ

これらのメソッドは、Standard コントロールで使用できます。

Method	Description
addNotification	オプションのアクションを含むエラーまたは推奨事項の通知を表示します。
clearNotification	コントロールから通知を削除します。
getAttribute	コントロールがバインドされている列を返します。
getControlType	コントロールの型を返します。
getDisabled	コントロールが無効かどうかを返します。
getLabel	コントロールのラベルを返します。
getName	コントロールの名前を返します。
getOutputs	コントロールの出力プロパティのディクショナリを返します。
getParent	コントロールを含むセクションを返します。
getVisible	コントロールが表示されるかどうかを返します。
setDisabled	コントロールを有効または無効にします。
setFocus	フォーカスをコントロールに移動します。
setLabel	コントロールのラベルを変更します。
setNotification	データが無効であることを示すエラー メッセージを表示します。
setVisible	コントロールを表示または非表示にします。

Standard コントロールの次のメソッドは 非推奨です: addOnKeyPress、 fireOnKeyPress、 removeOnKeyPress。

IFRAME コントロールタイプ

これらのメソッドは、IFRAME コントロールで使用可能です。

Method	Description
getContentWindow	IFRAME または Web リソースのコンテンツ ウィンドウを返します。
getControlType	コントロールの型を返します。
getDisabled	コントロールが無効かどうかを返します。
getInitialUrl	IFRAME 用に構成された既定の URL を返します。
getLabel	コントロールのラベルを返します。
getName	コントロールの名前を返します。
getObject	IFRAME または Web リソースを表すフォーム オブジェクトを返します。
getParent	コントロールを含むセクションを返します。
getSrc	IFRAME または Web リソースに現在表示されている URL を返します。
getVisible	コントロールが表示されるかどうかを返します。
setDisabled	コントロールを有効または無効にします。
setFocus	フォーカスをコントロールに移動します。
setLabel	コントロールのラベルを変更します。
setSrc	IFRAME または Web リソースに表示する URL を設定します。
setVisible	コントロールを表示または非表示にします。

Kbsearch (ナレッジ ベース検索) コントロールの種類

これらのメソッドは、ナレッジ ベースの検索コントロールで使用できます。

Method	Description
addOnPostSearch	検索の完了後に実行されるイベント ハンドラーを追加します。
addOnResultOpened	検索結果が開いたときに実行されるイベント ハンドラーを追加します。
addOnSelection	検索結果が選択されたときに実行されるイベント ハンドラーを追加します。
getControlType	コントロールの型を返します。
getDisabled	コントロールが無効かどうかを返します。
getLabel	コントロールのラベルを返します。
getName	コントロールの名前を返します。
getParent	コントロールを含むセクションを返します。
getSearchQuery	検索条件として使用されるテキストを返します。
getSelectedResults	現在選択されている検索結果を返します。
getTotalResultCount	検索結果の数を返します。
getVisible	コントロールが表示されるかどうかを返します。
openSearchResult	指定した検索結果を開きます。
removeOnPostSearch	検索完了のイベント ハンドラーを削除します。
removeOnResultOpened	検索結果を開くイベント ハンドラーを削除します。
removeOnSelection	検索結果を選択するためのイベント ハンドラーを削除します。
setFocus	フォーカスをコントロールに移動します。
setLabel	コントロールのラベルを変更します。
setSearchQuery	検索条件として使用するテキストを設定します。
setVisible	コントロールを表示または非表示にします。

ヒント

ナレッジ ベースの検索コントロールをソーシャル ウィンドウに追加すると、コントロール名は searchwidgetcontrol_notescontrol。 この名前は変えられない。

検索コントロール タイプ

これらのメソッドは、検索コントロールで使用可能です。

Method	Description
addCustomFilter	AND を使用して、既存のフィルターと組み合わせて、ルックアップ結果にフィルターを追加します。
addCustomView	参照ダイアログにビューを追加します。
addNotification	オプションのアクションを含むエラーまたは推奨事項の通知を表示します。
addOnLookupTagClick	参照タグがクリックされたときに実行されるイベント ハンドラーを追加します。
addPreSearch	検索検索の前に実行されるイベント ハンドラーを追加します。
clearNotification	コントロールから通知を削除します。
getAttribute	コントロールがバインドされている列を返します。
getControlType	コントロールの型を返します。
getDefaultView	既定の参照ビューの ID を返します。
getDisabled	コントロールが無効かどうかを返します。
getEntityTypes	参照で許可されているテーブルの種類を返します。
getLabel	コントロールのラベルを返します。
getName	コントロールの名前を返します。
getParent	コントロールを含むセクションを返します。
getVisible	コントロールが表示されるかどうかを返します。
removeOnLookupTagClick	参照タグのクリックのイベント ハンドラーを削除します。
removePreSearch	検索検索の前に実行されるイベント ハンドラーを削除します。
setDefaultView	ルックアップ ダイアログの既定のビューを設定します。
setDisabled	コントロールを有効または無効にします。
setEntityTypes	参照で許可されるテーブルの種類を設定します。
setFocus	フォーカスをコントロールに移動します。
setLabel	コントロールのラベルを変更します。
setNotification	データが無効であることを示すエラー メッセージを表示します。
setVisible	コントロールを表示または非表示にします。

選択および選択コントロールの種類

選択肢コントロールと選択肢コントロールには、同じ一連のメソッドを使用できます。

Method	Description
addNotification	オプションのアクションを含むエラーまたは推奨事項の通知を表示します。
addOption	コントロールにオプションを追加します。
clearNotification	コントロールから通知を削除します。
clearOptions	コントロールからすべてのオプションを削除します。
getAttribute	コントロールがバインドされている列を返します。
getControlType	コントロールの型を返します。
getDisabled	コントロールが無効かどうかを返します。
getLabel	コントロールのラベルを返します。
getName	コントロールの名前を返します。
getOptions	空のオプションや削除されたオプションを除く、使用可能なオプションを返します。
getParent	コントロールを含むセクションを返します。
getVisible	コントロールが表示されるかどうかを返します。
removeOption	コントロールからオプションを削除します。
setDisabled	コントロールを有効または無効にします。
setFocus	フォーカスをコントロールに移動します。
setLabel	コントロールのラベルを変更します。
setNotification	データが無効であることを示すエラー メッセージを表示します。
setVisible	コントロールを表示または非表示にします。

クイック フォーム コントロールの種類

このコントロールタイプでサポートされているメソッドの情報については、「 formContext.ui.quickForms 」を参照してください。

サブグリッド コントロール タイプ

このコントロールの種類でサポートされているメソッドについては、「 グリッドとサブグリッド 」を参照してください。

タイムラインの壁コントロールの種類

タイムライン コントロールは、投稿、アクティビティ、メモを統合ビューで表示します。 これらのメソッドは、このコントロール タイプに使用可能です。

Method	Description
getControlType	コントロールの型を返します。
getDisabled	コントロールが無効かどうかを返します。
getLabel	コントロールのラベルを返します。
getName	コントロールの名前を返します。
getParent	コントロールを含むセクションを返します。
getVisible	コントロールが表示されるかどうかを返します。
refresh	タイムラインに表示されるデータを更新します。
setDisabled	コントロールを有効または無効にします。
setFocus	フォーカスをコントロールに移動します。
setLabel	コントロールのラベルを変更します。
setVisible	コントロールを表示または非表示にします。

タイマー コントロール タイプ

これらのメソッドは、タイマー コントロールに使用可能です。

Method	Description
getControlType	コントロールの型を返します。
getDisabled	コントロールが無効かどうかを返します。
getLabel	コントロールのラベルを返します。
getName	コントロールの名前を返します。
getParent	コントロールを含むセクションを返します。
getState	タイマーの現在の状態を返します。
getVisible	コントロールが表示されるかどうかを返します。
refresh	タイマーに表示されるデータを更新します。
setDisabled	コントロールを有効または無効にします。
setFocus	フォーカスをコントロールに移動します。
setLabel	コントロールのラベルを変更します。
setVisible	コントロールを表示または非表示にします。

Web リソースのコントロール タイプ

Webリソース コントロールには、IFRAMEコントロールでも利用可能な同じメソッド セットがあります。 iframe コントロールの種類を参照してください。

Form Component コントロール タイプ

Form Component コントロール タイプは、メインフォームの formContext と同じメソッド セットを利用できます。 クライアント API のフォーム コンポーネントの動作>参照してください。

関連記事

列