クライアント API コントロールの種類

この記事では、サポートされているコントロールの種類の一覧を示します。 すべてのコントロールには共通の コントロール メソッドがありますが、一部のメソッドでは異なる値型が使用され、一部のコントロールには追加のメンバーがあります。

コントロールの種類 Description
アドレス複合 住所入力フィールドに、道路、市区町村、都道府県などの複数のサブコンポーネントを提供します。
Boolean オプションが true または false のラジオ ボタン フィールドを提供します。
DateTime 日付と時刻の入力フィールドを提供します。
Decimal 10 進数の入力フィールドを提供します。
Double 浮動小数点数入力フィールドを提供します。
ドロップダウン検索 関連するレコードを選択するための非変更ドロップダウンを提供します。
電子メール 電子メール アドレスの入力フィールドを提供します。
File 編集可能なフォームのファイルを他のユーザーが選択できるようにします。
書式設定された整数 期間、言語、タイム ゾーンなどの値として書式設定された整数フィールドを提供します。
氏名 名前入力フィールドに、名や姓などの複数のコンポーネントを提供します。
イメージ 編集可能なフォームの画像を他のユーザーが選択できるようにします。
整数 数値整数入力フィールドを提供します。
メモ 複数行テキスト入力フィールドを提供します。
モーダル検索 関連するレコードを選択するためのモーダル ダイアログを提供します。
お金 通貨入力フィールドを提供します。
複数の選択列 チェック ボックス フィールドを提供します。
複数選択リスト 複数のオプションを選択するためのフィールドを提供します。
選択リスト ドロップダウンやラジオ ボタンなどのオプション セット フィールドを提供します。
ステータス テーブル レコードの現在の状態を読み取り専用の値として提供します。
ステータスの理由 テーブル レコードの現在の状態の理由を読み取り専用の値として提供します。
ストリング 1 行のテキスト入力フィールドを提供します。
ティッカー シンボル ストック ティッカー シンボルの入力フィールドを提供します。
URL URL 入力フィールドを提供します。

アドレス複合

道路、市区町村、都道府県など、複数のサブコンポーネントを含む住所入力フィールドは、住所複合コントロールを使用します。

複合プロパティとメソッドに対処する

これらのメンバーを使用して、アドレス複合値を構成および読み取ります。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method setValue メソッド パラメーターを参照してください。
getValue Method 同じオブジェクトを返します。

setValue メソッド パラメーター

次のプロパティを持つオブジェクトが必要です。

{
    "line1": "address line one value",
    "line2": "address line two value",
    "line3": "address line three value",
    "city": "address city value",
    "state": "address state value",
    "postalCode": "address postalCode value",
    "country": "address country value"
}

ブール値

true/false オプションを持つラジオ ボタン フィールドでは、ブール型コントロールを使用します。

ブール型のプロパティとメソッド

これらのメンバーを使用して、ブール型のフィールド値を設定および取得します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method ローカライズされた true または false 値に対応する文字列値が必要です
getValue Method 選択したオプション値を文字列として返します。

DateTime

日付と時刻の入力フィールドは、DateTime コントロールを使用します。

DateTime のプロパティとメソッド

これらのメンバーを使用して、日付と時刻の値を管理およびアクセスします。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
isDisabled Property フィールドが無効になっている場合は true を返します。それ以外の場合は false。
dataType Property datetime フィールドのデータ型
setValue Method 適切な形式の datetime 文字列が必要です
getValue Method datetime 値を文字列として返します。

Decimal

10 進数の入力フィールドでは、Decimal コントロールを使用します。

10 進数のプロパティとメソッド

これらのメンバーを使用して、10 進数の入力を操作します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 有効な 10 進数を表す文字列が必要です。
getValue Method 10 進値を文字列として返します。

Double

浮動小数点数入力フィールドでは、Double コントロールを使用します。

Double プロパティとメソッド

これらのメンバーを使用して、浮動小数点数値を処理します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 有効な浮動小数点数を表す文字列が必要です。
getValue Method 数値を文字列として返します。

モーダルではないルックアップ コントロールでは、ドロップダウン ルックアップ コントロールが使用されます。

これらのメンバーを使用して、ドロップダウン検索の選択を操作します。

メンバー サブタイプ Description
isDropdown Property 常に true です。 このプロパティを使用して、 モーダル参照 とドロップダウン検索を区別します。
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 選択するオプションの ID を表す文字列パラメーターが必要です。
getValue Method 選択したオプションのフォーム { id: string, name: string } のオブジェクトを返します。オプションが選択されていない場合は 未定義 です。

Email

電子メール入力フィールドでは、電子メール コントロールを使用します。

電子メールのプロパティとメソッド

これらのメンバーを使用して、電子メール アドレスの値を検証および取得します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 有効なメール アドレスを表す文字列が必要です。
getValue Method 電子メール値を文字列として返します。

File

[ファイル] コントロールを使用すると、誰かが編集可能なフォームのファイルを選択できます。

ファイルのプロパティとメソッド

これらのメンバーを使用して、ファイルを選択、アクセス、および削除します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
maxFileSizeInByte Property アップロードできるファイルの最大サイズ (バイト単位)。
setValue Method File 型のオブジェクトを受け取り、ファイル ピッカーで選択したかのように設定します。 このメソッドは、ファイルが空であるか、 maxFileSizeInByteを超えたときにエラーをスローします。
getValue Method 現在のフォーム セッション中に選択または設定した File オブジェクトを返します。 Dataverse に既に格納されているファイルはダウンロードされません。
removeFile Method セット ファイルを削除します。

Dataverse ファイル列に格納されているファイルをダウンロードするには、 downloadFileFromColumn メソッドを使用します。

書式設定された整数

期間、言語、タイムゾーンなどの特定の書式設定要件を持つ整数フィールドでは、書式設定された整数コントロールが使用されます。

書式設定された整数のプロパティとメソッド

これらのメンバーを使用して、特殊な書式設定を使用して整数を管理します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 有効な書式設定された整数を表す文字列が必要です。
getValue Method 書式設定された整数値を文字列として返します。

氏名

複数のコンポーネント (名、姓など) を含む可能性がある名前入力フィールドには、フル ネーム コントロールを使用します。

フル ネーム メソッド

これらのメンバーを使用して、フル ネーム コンポーネントの構成と読み取りを行います。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 次のプロパティを持つオブジェクトが必要です: { "firstName": "first name value", "middleName": "middle name value", "lastName": "last name value" }。
getValue Method 同じオブジェクトを返します。

Image

画像コントロールを使用すると、編集可能なフォームの画像を選択できます。

イメージのプロパティとメソッド

これらのメンバーを使用して、イメージを選択、アクセス、および削除します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
maxFileSizeInByte Property アップロードできるイメージの最大サイズ (バイト単位)。
setValue Method ファイル型のイメージを想定し、ファイル ピッカーで選択したかのように設定します。 このメソッドは、ファイルが空であるか、 maxFileSizeInByteを超えているか、イメージ MIME の種類がない場合にエラーをスローします。
getValue Method 現在のフォーム セッション中に選択または設定した File オブジェクトを返します。 Dataverse に既に格納されているイメージはダウンロードされません。
removeFile Method 設定されたイメージを削除します。

Dataverse イメージ列に格納されているイメージをダウンロードするには、 downloadFileFromColumn メソッドを使用します。

Integer

数値入力フィールドでは、整数コントロールを使用します。

整数のプロパティとメソッド

これらのメンバーを使用して、整数フィールド値を設定および取得します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 有効な整数を表す文字列が必要です。
getValue Method 整数値を文字列として返します。

メモ

複数行テキスト入力フィールドでは、メモ コントロールを使用します。

メモ型のプロパティとメソッド

これらのメンバーを使用して、複数行テキスト入力コンテンツを管理します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 文字列値が必要です。 このメソッドは、値がフィールドの構成された最大長を超えるとエラーをスローします。
getValue Method メモテキストを文字列として返します。

モーダルルックアップフィールドはモーダルルックアップコントロールを使用します。

これらのメンバーを使用して、モーダル参照値の設定、取得、クリアを行います。

メンバー サブタイプ Description
isModal Property 常に true。 このプロパティを使用して、モーダル参照とドロップダウン検索を区別します。
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 次のプロパティを持つオブジェクトが必要です: { "id": "レコードの一意識別子"、"name": "レコードのプライマリ名フィールド値"、"entityType": "The entity type name value of the table." }
getValue Method 同じオブジェクトを返します。
clearValue Method フィールドから設定値をクリアします。

通貨

通貨入力フィールドでは、Money コントロールが使用されます。

Money のプロパティとメソッド

これらのメンバーを使用して、通貨金額を設定および取得します。

メンバー サブタイプ Description
readOnly Property true フィールドが読み取り専用フィールドの場合は '、それ以外の場合は false。
setValue Method 有効な金額を表す文字列が必要です。
getValue Method は、金額を文字列として返します。

多項選択式

チェックボックス フィールドでは、複数選択コントロールが使用されます。

複数の選択方法

これらのメソッドを使用して、チェック ボックスの状態を設定および読み取ります。

メンバー サブタイプ Description
setValue Method ブール値が必要です。
getValue Method は、チェック ボックスの状態をブール値として返します。

複数選択リスト

複数選択オプション・フィールドは、複数選択リスト・コントロールを使用します。

MultiSelect picklist メソッド

これらのメソッドを使用して、選択したオプションを設定および読み取ります。

メンバー サブタイプ Description
setValue Method 選択するオプション値を表す数値の配列が必要です。 値が使用可能なオプションの 1 つでない場合は、エラーを返します。
getValue Method 選択したオプション値を数値の配列として返します。
setDisabled Method コントロールがサーバー上でロックされているため、フォームまたはフィールドが読み取り専用の場合は効果がありません。

次の例では、選択したオプションを読み取って設定します。

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let control = form && form.controls.find(c => c.getType() === 'MultiSelectPicklist');

    if (!control) {
        return;
    }

    // Get the selected values.
    let selectedValues = control.getValue(); // For example, [740740000, 740740001]

    // Set the selected values.
    control.setValue([740740000, 740740001]);
});

ピックリスト

オプション セット フィールド (ドロップダウン、ラジオ ボタンなど) は、候補リスト コントロールを使用します。

Picklist のプロパティとメソッド

これらのメンバーを使用して、オプション セットの選択を構成および読み取ります。

メンバー サブタイプ Description
subType Property 候補リスト コントロールのサブタイプ。 使用できる値は、 VerticalRadioButton、 HorizontalRadioButton、 MultipleChoiceMatrix、 Dropdown
setValue Method 選択するオプションの値を表す文字列が必要です。
getValue Method 選択したオプション値を文字列として返します。

地位

エンティティ レコードの現在の状態では、Status コントロールを使用します。

Note

このコントロールでは、値の設定は許可されません。 この値は読み取り専用です。

ステータスの理由

エンティティ レコードの現在の状態の理由では、状態理由コントロールが使用されます。

Note

このコントロールでは、値の設定は許可されません。 この値は読み取り専用です。

String

テキスト入力フィールドでは、文字列コントロールを使用します。

文字列のプロパティとメソッド

これらのメンバーを使用して、1 行のテキスト入力値を管理します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 文字列値が必要です。 このメソッドは、値がフィールドの構成された最大長を超えるとエラーをスローします。
getValue Method 文字列値を返します。

ティッカー記号

ストック ティッカー シンボル入力フィールドでは、ティッカー シンボル コントロールが使用されます。

ティッカー シンボルのプロパティとメソッド

これらのメンバーを使用して、株式ティッカー シンボルを設定および取得します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 有効なティッカー 記号を表す文字列を指定します。
getValue Method ティッカー記号を文字列として返します。

URL

URL 入力フィールドは URL コントロールを使用します。

URL のプロパティとメソッド

これらのメンバーを使用して、URL 値を検証および取得します。

メンバー サブタイプ Description
isReadOnly Property フィールドが読み取り専用の場合は true を返します。それ以外の場合は false。
setValue Method 有効な URL を表す文字列が必要です。
getValue Method URL 値を文字列として返します。
  • 最終更新: