客户端 API 控件类型

本文列出了支持的控件类型。 所有控件都具有 通用的控件方法，但某些方法使用不同的值类型，而某些控件具有其他成员。

控件类型 Description
地址复合 提供具有多个子组件（如街道、城市和州）的地址输入字段。
Boolean 提供具有 true 或 false 选项的单选按钮字段。
DateTime 提供日期和时间输入字段。
Decimal 提供十进制数输入字段。
双 提供浮点数输入字段。
下拉列表查找 提供用于选择相关记录的非模式下拉列表。
电子邮件 提供电子邮件地址输入字段。
文件 允许某人为可编辑的表单选择文件。
带格式的整数 提供格式为值的整数字段，例如持续时间、语言和时区。
全名 提供具有多个组件的名称输入字段，例如名字和姓氏。
Image 允许某人为可编辑的表单选择图像。
整数 提供数值整数输入字段。
备注 提供多行文本输入字段。
模式查找 提供用于选择相关记录的模式对话框。
钱 提供货币输入字段。
单选题 提供复选框字段。
MultiSelect 选取列表 提供用于选择多个选项的字段。
选项列表 提供选项集字段，例如下拉列表和单选按钮。
Status 将表记录的当前状态作为只读值提供。
状态原因 将表记录的当前状态原因作为只读值提供。
字符串 提供单行文本输入字段。
股票代码 提供股票刻度符号输入字段。
网址 提供 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"
}

布尔

具有 true/false 选项的单选按钮字段使用布尔控件。

布尔属性和方法

使用这些成员设置和检索布尔字段值。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要对应于本地化 的 true 或 false 值的字符串值
getValue 方法 以字符串的形式返回所选选项值

日期和时间

日期和时间输入字段使用 DateTime 控件。

DateTime 属性和方法

使用这些成员管理和访问日期和时间值。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
isDisabled 财产 true如果字段已禁用，则返回 。否则false返回 。
dataType 财产 datetime 字段的数据类型
setValue 方法 需要采用适当格式的日期/时间字符串
getValue 方法 以字符串的形式返回日期/时间值。

Decimal

十进制数输入字段使用十进制控件。

十进制属性和方法

使用这些成员来处理十进制数输入。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要一个表示有效十进制数的字符串。
getValue 方法 以字符串形式返回十进制值。

Double

浮点数输入字段使用 Double 控件。

双精度属性和方法

使用这些成员处理浮点数值。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要一个表示有效浮点数的字符串。
getValue 方法 以字符串的形式返回数字值。

不模式的查找控件使用下拉列表查找控件。

使用这些成员与下拉列表查找选择进行交互。

成员 种类 Description
isDropdown 财产 始终 为 true。 使用此属性可区分 模式查找 和下拉列表查找。
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要一个表示要选择的选项 ID 的字符串参数。
getValue 方法 返回选定选项的窗体 { id: string, name: string } 对象，或者在未选择任何选项时 未定义 。

Email

电子邮件输入字段使用电子邮件控件。

电子邮件属性和方法

使用这些成员来验证和检索电子邮件地址值。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要一个表示有效电子邮件地址的字符串。
getValue 方法 以字符串的形式返回电子邮件值。

File

“文件”控件允许某人为可编辑表单选择文件。

文件属性和方法

使用这些成员选择、访问和删除文件。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
maxFileSizeInByte 财产 可以上传的文件的最大大小（以字节为单位）。
setValue 方法 需要一 个文件类型的对象 ，并设置它，就好像有人使用文件选取器选择了它一样。 当文件为空或超过 maxFileSizeInByte时，该方法将引发错误。
getValue 方法 返回在当前窗体会话期间选择或设置 的 File 对象。 它不会下载已存储在 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 方法 需要文件类型 的图像，并 设置它就像有人使用文件选取器选择了它一样。 当文件为空、超出 maxFileSizeInByte或没有图像 MIME 类型时，该方法将引发错误。
getValue 方法 返回在当前窗体会话期间选择或设置 的 File 对象。 它不会下载已存储在 Dataverse 中的映像。
removeFile 方法 删除集映像。

若要下载存储在 Dataverse 图像列中的图像，请使用 downloadFileFromColumn 此方法。

Integer

数值输入字段使用 Integer 控件。

整数属性和方法

使用这些成员设置和检索整数字段值。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要一个表示有效整数的字符串。
getValue 方法 以字符串的形式返回整数值。

备忘录

多行文本输入字段使用备注控件。

备注属性和方法

使用这些成员管理多行文本输入内容。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要字符串值。 当值超过字段配置的最大长度时，该方法将引发错误。
getValue 方法 以字符串的形式返回备注文本。

模式查找字段使用模式查找控件。

使用这些成员设置、获取和清除模式查找值。

成员 种类 Description
isModal 财产 始终为 True。 使用此属性可区分模式查找和下拉列表查找。
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要具有以下属性的对象：{ “id”： “record 的唯一标识符。”， “name”： “record 的主名称字段值”， “entityType”： “table 的实体类型名称值。” }
getValue 方法 返回同一对象。
clearValue 方法 清除字段中的设置值。

金钱

货币输入字段使用 Money 控件。

货币属性和方法

使用这些成员设置和检索货币金额。

成员 种类 Description
readOnly 财产 如果字段为只读字段，则为 ;否则 为 。
setValue 方法 需要表示有效货币金额的字符串。
getValue 方法 以字符串的形式返回货币值。

多选

复选框字段使用多选控件。

多种选择方法

使用这些方法来设置和读取复选框状态。

成员 种类 Description
setValue 方法 需要一个布尔值。
getValue 方法 将复选框状态返回为布尔值。

MultiSelect 选取列表

多选选项字段使用 MultiSelect 选取列表控件。

MultiSelect picklist 方法

使用这些方法来设置和读取所选选项。

成员 种类 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 控件。

Picklist 属性和方法

使用这些成员配置和读取选项集选择。

成员 种类 Description
subType 财产 picklist 控件的子类型。 可能的值包括：VerticalRadioButton、、HorizontalRadioButton、 MultipleChoiceMatrixDropdown
setValue 方法 需要一个表示要选择的选项值的字符串。
getValue 方法 以字符串的形式返回所选选项值。

Status

实体记录的当前状态使用状态控件。

注释

此控件不允许设置值。 值为只读。

状态原因

实体记录的当前状态原因使用状态原因控件。

注释

此控件不允许设置值。 值为只读。

String

文本输入字段使用字符串控件。

字符串属性和方法

使用这些成员管理单行文本输入值。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要字符串值。 当值超过字段配置的最大长度时，该方法将引发错误。
getValue 方法 返回字符串值。

Ticker 符号

股票刻度符号输入字段使用刻度符号控件。

Ticker 符号属性和方法

使用这些成员设置和检索股票刻度符号。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要一个表示有效刻度符号的字符串。
getValue 方法 以字符串的形式返回刻度符号。

URL

URL 输入字段使用 URL 控件。

URL 属性和方法

使用这些成员验证和检索 URL 值。

成员 种类 Description
isReadOnly 财产 true如果字段为只读，则返回;否则false返回 。
setValue 方法 需要一个表示有效 URL 的字符串。
getValue 方法 以字符串的形式返回 URL 值。
  • 上次更新时间为