クライアント API コントロール

Power Pagesクライアント API コントロールは、フォーム値、状態、可視性、要件、検証を管理するための一般的なメソッドを提供するControl インターフェイスを実装します。 この参照を使用して、使用可能なメソッドと戻り値の型を識別します。 コントロール固有の値型と追加のメンバーについては、 クライアント API コントロールの型に関するページを参照してください。

Method 返品 Description
getDisabled() boolean コントロールが無効になっている場合は true を返します。それ以外の場合は、 falseを返します。
getRequired() boolean コントロールが必要な場合は true を返し、それ以外の場合は falseを返します。
getVisible() boolean コントロールが表示されている場合は true を返し、それ以外の場合は falseを返します。
getName() string コントロールの名前を返します。
getType() string | undefined MultiSelectPicklistなどのコントロール型、または型が使用できない場合にundefinedを返します。 クライアント API コントロールの種類に関するページを参照してください。
getLogicalName() string | undefined 論理名が使用できない場合は、コントロールの論理名または undefined を返します。
getValue() Varies 現在の値を取得します。 戻り値の型は 、コントロールの型によって異なります。
setDisabled(isDisabled: boolean) void コントロールの無効な状態を設定します。
setRequired(isRequired: boolean, errorMessage?: string) void コントロールの必要な状態を設定します。 詳細については、「 setRequired メソッドのパラメーター」を参照してください。
setVisible(isVisible: boolean) void コントロールの可視性を設定します。
setValue(value) void 新しい値を設定します。 予期される値の型は 、コントロールの種類によって異なります。
addValidator(id: string, evaluationFn: function, errorMessage: string) void このコントロール インスタンスにカスタム クライアント側検証コントロールを登録します。 詳細については、「 addValidator メソッドのパラメーター」を参照してください。
removeValidator(id: string) void このコントロール インスタンスから ID によってカスタム検証コントロールを削除します。 ID が存在しない場合は何も行われません。
clearValidators() void addValidatorを使用して、このコントロール インスタンスに追加されたすべてのカスタム 検証コントロールを削除します。 setRequiredが管理する必要な検証コントロールには影響しません。

setRequired メソッドのパラメーター

パラメーター タイプ Description
isRequired boolean コントロールが必要かどうかを指定します。
errorMessage string (省略可能) ローカライズされた検証メッセージ。 既定値は <field name> is a required field. です

isRequiredが true の場合、クライアント API はフォームの送信時に実行される検証コントロールを登録します。 false の場合、バリデーターは削除されます。 サーバーで必須としてマークされている場合、コントロールを省略可能にすることはできません。

addValidator メソッドのパラメーター

パラメーター タイプ Description
id 文字列 現在のコントロール インスタンスの一意の識別子。 同じ ID を持つ新しい検証コントロールによって、既存の検証コントロールが置き換えられます。
evaluationFn 関数 コントロール値を受け取り、値が有効な場合は true を返します。
errorMessage 文字列 検証が失敗したときに検証の概要に表示されるメッセージ。

重要

バリデーターを置き換えたり削除したりするときは、同じ Control オブジェクト インスタンスを保持して再利用します。 form.controlsへのアクセスとgetControlByLogicalNameの呼び出しごとに、新しいコントロール ファサードが返されます。

評価関数または getValue メソッドがエラーをスローした場合、検証は失敗し、ブラウザー コンソールによってエラーが記録されます。

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    const form = $pages.currentPage.forms.getFormById('form_#1');
    const control = form.getControlByLogicalName('new_keyword');

    control.setRequired(true, 'This field is mandatory.');
    control.addValidator(
        'keywordCheck',
        (value) => ['alpha', 'beta', 'gamma'].includes(value),
        'Value must be one of: alpha, beta, gamma.'
    );
});
  • 最終更新: