用戶端 API 控制類型

本文列出了支援的控制類型。 所有控制項都有 共同的控制方法，但有些方法使用不同的值類型，且有些控制項有額外的成員。

控制件類型 Description
位址複合 提供包含多個子元件的地址輸入欄位，如街道、城市和州。
布林值 提供帶有真或假選項的單選按鈕欄位。
DateTime 提供日期與時間輸入欄位。
Decimal 提供十進位輸入欄位。
Double 提供浮點數輸入欄位。
下拉式查詢 提供非模態下拉選單，方便選擇相關紀錄。
電子郵件 提供電子郵件地址輸入欄位。
File 讓使用者選擇可編輯表單的檔案。
格式化整數 提供整數欄位，格式化為時長、語言及時區等數值。
全名 提供包含多個元件的姓名輸入欄位，如名字與姓氏。
圖像 讓使用者選擇圖片作為可編輯表單。
整數 提供數值整數輸入欄位。
箋 提供多行文字輸入欄位。
模態查詢 提供一個模式對話框以選擇相關紀錄。
錢 提供貨幣輸入欄位。
選擇題 提供核取框欄位。
多選選擇清單 提供多個選項的欄位。
選項清單 提供選項集欄位，如下拉選單和單選按鈕。
現況 以唯讀值的形式提供資料表記錄的當前狀態。
狀態原因 提供資料表記錄的當前狀態原因，作為唯讀值。
String 提供單行文字輸入欄位。
股票代號 提供股票股票代號輸入欄位。
網址 提供 URL 輸入欄位。

位址複合

包含多個子元件（如街道、城市和州）的地址輸入欄位，則使用地址複合控制。

位址複合性質與方法

利用這些成員來設定和讀取位址複合值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 參見 setValue 方法參數。
getValue 方法 回傳相同的物件。

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"
}

布林值

帶有 真偽 選項的單選按鈕欄位使用布林控制。

布林性質與方法

利用這些成員來設定和檢索布林欄位值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 期望一個對應局部真值 或假 值的字串值
getValue 方法 會以字串形式回傳所選的期權值

約會時間

日期與時間輸入欄位使用日期時間控制項。

DateTime 屬性與方法

利用這些成員來管理及存取日期與時間值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
isDisabled 財產 若欄位被停用，則返回 true ，否則 false。
dataType 財產 datetime 欄位的資料型態
setValue 方法 期望以適當格式的 datetime 字串
getValue 方法 以字串形式回傳 datetime 值。

Decimal

十進位輸入欄位使用十進位控制。

十進位性質與方法

利用這些成員來處理小數輸入。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期會有一個代表有效十進位數的字串。
getValue 方法 以字串回傳小數值。

Double

浮點數輸入欄位使用雙重控制鍵。

雙重性質與方法

利用這些成員來處理浮點數值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期有代表有效浮點數的字串。
getValue 方法 回傳數字值為字串。

非模態的查找控制項使用下拉選單查找控制。

利用這些成員來互動下拉選單的查詢選項。

會員 種類 Description
isDropdown 財產 這永遠 都是真的。 利用此特性來區分 模態查找 與下拉查找。
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 它期望有一個字串參數代表要選擇的選項的 ID。
getValue 方法 會回傳所選選項的物件 { id: string, name: string } 形式，若未選取則為 未定義 物件。

Email

電子郵件輸入欄位使用電子郵件控制項。

電子郵件屬性與方法

利用這些成員來驗證並取得電子郵件地址的值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期會有代表有效電子郵件地址的字串。
getValue 方法 會以字串形式回傳電子郵件值。

檔案

檔案控制功能讓使用者選擇可編輯表單的檔案。

檔案屬性與方法

利用這些成員來選擇、存取及移除檔案。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
maxFileSizeInByte 財產 檔案的最大大小（以位元組為單位）是你可以上傳的。
setValue 方法 它預期一個類型為 File 的物件，並設定好像有人用檔案選擇器選取它。 當檔案為空或超過 maxFileSizeInByte時，該方法會拋出錯誤。
getValue 方法 回傳你在當前表單會話中選擇或設定的 檔案 物件。 它不會下載已經儲存在 Dataverse 裡的檔案。
removeFile 方法 移除設定檔。

要下載儲存在 Dataverse 檔案欄位中的檔案，請使用這個downloadFileFromColumn方法。

格式化整數

對於有特定格式要求的整數欄位，如時長、語言和時區，則使用格式化整數控制。

格式化整數性質與方法

利用這些成員管理具有專門格式的整數。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 期望一個字串代表有效格式化整數。
getValue 方法 回傳格式化整數值的字串。

完整名稱

可能包含多個元件（名字、姓氏等）的名稱輸入欄位會使用完整名稱控制項。

全名方法

利用這些成員來配置和讀取全名元件。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 期望一個具有以下性質的物件： { "firstName": "first name value", "middleName": "middle name value", "lastName": "last name value" }。
getValue 方法 回傳相同的物件。

影像

圖片控制讓使用者可以選擇圖片作為可編輯表單。

影像性質與方法

利用這些成員選擇、存取及移除圖片。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
maxFileSizeInByte 財產 圖片最大可上傳的位元組大小。
setValue 方法 它預期會有 File 類型的圖片，並設定成有人用檔案選擇器選取。 當檔案為空、超過 maxFileSizeInByte或沒有影像 MIME 類型時，該方法會拋出錯誤。
getValue 方法 回傳你在當前表單會話中選擇或設定的 檔案 物件。 它不會下載已經儲存在 Dataverse 裡的映像檔。
removeFile 方法 移除預設影像。

要下載儲存在 Dataverse 圖片欄位中的圖片，請使用此downloadFileFromColumn方法。

整數

數值輸入欄位使用整數控制。

整數性質與方法

利用這些成員來設定和檢索整數欄位值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 期望有代表有效整數的字串。
getValue 方法 以字串回傳整數值。

備忘錄

多行文字輸入欄位使用備忘錄控制。

備忘錄的特性與方法

利用這些成員來管理多行文字輸入內容。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期有字串值。 當值超過欄位設定的最大長度時，該方法會拋出錯誤。
getValue 方法 會以字串回傳備忘錄文字。

模態查詢欄位使用模態查詢控制。

利用這些成員來設定、取得並清除模態查詢值。

會員 種類 Description
isModal 財產 一律為 True。 利用此特性來區分模態查找與下拉查找。
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期物件具有以下屬性：{ “id”： “記錄的唯一識別碼.”、“name”： “記錄的主要名稱欄位值”、“entityType”： “資料表的實體類型名稱值。” }
getValue 方法 回傳相同的物件。
clearValue 方法 清除欄位中的設定值。

錢

貨幣輸入欄位使用貨幣控制。

貨幣特性與方法

利用這些成員設定和取回貨幣金額。

會員 種類 Description
readOnly 財產 true 若欄位為唯讀欄位，則 false。
setValue 方法 期望有一個代表有效金額的字串。
getValue 方法 以字串的形式回傳貨幣價值。

選擇題

勾選框欄位使用多項選擇控制。

多項選擇題方法

使用這些方法來設定和讀取核取方塊狀態。

會員 種類 Description
setValue 方法 預期會有一個布林值。
getValue 方法 勾選框狀態以布林值回傳。

多選選擇清單

多選選項欄位使用 MultiSelect 選擇清單控制。

MultiSelect 選擇清單方法

使用這些方法來設定並閱讀所選選項。

會員 種類 Description
setValue 方法 預期會有一個代表選項值的數字陣列。 如果某個值不是可用選項之一，則會回傳錯誤。
getValue 方法 會以數字陣列回傳選取的選項值。
setDisabled 方法 當表單或欄位為唯讀時，則無影響，因為控制項已鎖定在伺服器端。

以下範例將讀取並設定所選選項。

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 財產 選擇清單控制的子類型。 可能的值有： VerticalRadioButton， HorizontalRadioButton， MultipleChoiceMatrix， Dropdown
setValue 方法 預期有一個字串代表要選擇的選項值。
getValue 方法 會以字串形式回傳選中的期權值。

現況

實體紀錄的當前狀態使用狀態控制。

Note

這個控制不允許設定該數值。 該值為唯讀。

狀態原因

實體紀錄的當前狀態原因使用狀態原因控制。

Note

這個控制不允許設定該數值。 該值為唯讀。

String

文字輸入欄位使用字串控制項。

字串性質與方法

利用這些成員來管理單行文字輸入值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期有字串值。 當值超過欄位設定的最大長度時，該方法會拋出錯誤。
getValue 方法 回傳字串值。

股票代碼

股票股票代號輸入欄位使用行情代號控制。

股票代號屬性與方法

利用這些成員設定和檢索股票代號。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期有代表有效股票代號的字串。
getValue 方法 回傳跑馬燈符號為字串。

URL

URL 輸入欄位使用 URL 控制項。

URL 屬性與方法

利用這些成員來驗證並取得 URL 值。

會員 種類 Description
isReadOnly 財產 若欄位為唯讀，則回傳 true ，否則 false。
setValue 方法 預期會有代表有效 URL 的字串。
getValue 方法 會以字串形式回傳 URL 值。
  • 上次更新時間：