模型驱动应用中的列(客户端 API 参考)

列包含模型驱动应用窗体或网格中的数据。 使用 formContext.data.entity.attributes 集合或 formContext.getAttribute 快捷方法访问列集合。 有关集合的详细信息,请参阅集合(客户端 API 参考)。

若要访问集合中的列,请将列的名称(字符串)或索引值(数字)作为参数传递给方法。 例如: formContext.getAttribute(arg)。 如果未指定参数,该方法将返回窗体上所有属性的集合。

列按类型分类。 使用 getAttributeType 方法确定列的类型。 某些列方法仅适用于特定类型的列。

本文提供有关每种列类型可用的方法的信息。

所有列类型

Controls 属性提供与列关联的控件的集合。

以下方法适用于所有列类型:

Method Description
addOnChange 添加一个函数,用于在发生列 OnChange 的事件时运行。
fireOnChange 触发列 OnChange 的事件。
getAttributeType 返回列的类型。
getFormat 返回列的格式。
getIsDirty 返回列是否具有未保存的更改。
getName 返回列的逻辑名称。
getParent 返回父 formContext.data.entity 对象。
getRequiredLevel 返回是必需还是建议列值。
getSubmitMode 在保存时提交列的数据时返回。
getUserPrivilege 返回用户创建、读取或更新列值的权限。
getValue 返回列的数据值。
isValid 返回列的值是否有效。
removeOnChange 从列的 OnChange 事件处理程序中删除函数。
setIsValid 设置列的有效性和错误消息。
setRequiredLevel 设置在保存之前是必需还是建议列值。
setSubmitMode 设置是否在保存时提交列的数据。
setValue 设置列的数据值。

布尔列类型

除了可用于所有列类型的方法外, 布尔 列类型还提供以下方法:

Method Description
getInitialValue 打开窗体时返回列的值。

查找列类型

除了可用于所有列类型的方法外, 查找 列类型还提供以下方法:

Method Description
getIsPartyList 返回查找是否允许将多个记录作为参与方列表查找。

选项和选择列类型

除了可用于所有列类型的方法外, 选择 和 选择 列类型还提供以下方法:

Method Description
getInitialValue 打开窗体时返回列的值。
getOption 返回与指定标签或值匹配的选项。
getOptions 返回列的有效选项。
getSelectedOption 返回所选选项或选项。
getText 返回所选选项或选项的文本。

数字列类型(小数、双精度、整数、货币)

以下方法仅适用于 十进制、 双精度列和 整数 列:

Method Description
getMax 返回列允许的最大值。
getMin 返回列的最小允许值。
getPrecision 返回小数点之后允许的位数。
setPrecision 设置小数点之后允许的位数。

字符串列类型

除了前面介绍的所有列类型可用的方法外,以下方法仅适用于 字符串 列:

Method Description
getMaxLength 返回列的最大字符串长度。

了解 Xrm 对象模型
控件(客户端 API 参考)