控件(客户端 API 参考)

在模型驱动应用中,控件表示窗体上的 HTML 元素。 某些控件绑定到特定列,而另一些控件则表示未绑定的控件,例如添加到窗体中的 IFRAME、Web 资源或子网格。

控件对象提供更改控件的呈现或行为并标识相应列的方法。 使用以下集合之一进行访问控制:

  • formContext.ui.controls
  • formContext.ui Section.controls
  • formContext.data.entityAttribute.controls

formContext。getControl 方法是用于访问 formContext.ui.controls.get 的快捷方式方法。

注释

对绑定到列的控件执行操作时,请考虑该控件可能多次出现在页面上。 通常,应对列的每个控件执行相同的操作。 可以循环访问列 控件集合 ,并在每个控件上执行操作。

控件按类型分类。 使用 getControlType 方法确定控件的类型。 某些控件方法仅适用于特定类型的控件。

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

标准控件类型

这些方法可用于标准控件。

Method Description
addNotification 显示包含可选操作的错误或建议通知。
clearNotification 从控件中删除通知。
getAttribute 返回控件绑定到的列。
getControlType 返回控件的类型。
getDisabled 返回控件是否已禁用。
getLabel 返回控件的标签。
getName 返回控件的名称。
getOutputs 返回控件的输出属性的字典。
getParent 返回包含控件的节。
getVisible 返回控件是否可见。
setDisabled 启用或禁用控件。
setFocus 将焦点移动到控件。
setLabel 更改控件的标签。
setNotification 显示一条错误消息,指示数据无效。
setVisible 显示或隐藏控件。

标准控件的以下方法已弃用:addOnKeyPress、fireOnKeyPress 和 removeOnKeyPress。

IFRAME 控件类型

这些方法可用于 IFRAME 控件。

Method Description
getContentWindow 返回 IFRAME 或 Web 资源的内容窗口。
getControlType 返回控件的类型。
getDisabled 返回控件是否已禁用。
getInitialUrl 返回为 IFRAME 配置的默认 URL。
getLabel 返回控件的标签。
getName 返回控件的名称。
getObject 返回表示 IFRAME 或 Web 资源的窗体对象。
getParent 返回包含控件的节。
getSrc 返回 IFRAME 或 Web 资源中当前显示的 URL。
getVisible 返回控件是否可见。
setDisabled 启用或禁用控件。
setFocus 将焦点移动到控件。
setLabel 更改控件的标签。
setSrc 设置在 IFRAME 或 Web 资源中显示的 URL。
setVisible 显示或隐藏控件。

Kbsearch (知识库搜索) 控件类型

这些方法可用于知识库搜索控件。

Method Description
addOnPostSearch 添加在搜索完成后运行的事件处理程序。
addOnResultOpened 添加在搜索结果打开时运行的事件处理程序。
addOnSelection 添加在选择搜索结果时运行的事件处理程序。
getControlType 返回控件的类型。
getDisabled 返回控件是否已禁用。
getLabel 返回控件的标签。
getName 返回控件的名称。
getParent 返回包含控件的节。
getSearchQuery 返回用作搜索条件的文本。
getSelectedResults 返回当前选定的搜索结果。
getTotalResultCount 返回搜索结果数。
getVisible 返回控件是否可见。
openSearchResult 打开指定的搜索结果。
removeOnPostSearch 删除用于搜索完成的事件处理程序。
removeOnResultOpened 删除用于打开搜索结果的事件处理程序。
removeOnSelection 删除用于选择搜索结果的事件处理程序。
setFocus 将焦点移动到控件。
setLabel 更改控件的标签。
setSearchQuery 设置用作搜索条件的文本。
setVisible 显示或隐藏控件。

注释

将知识库搜索控件添加到社交窗格时,控件名称为 searchwidgetcontrol_notescontrol。 你不能改这个名字。

查找控件类型

这些方法可用于查找控件。

Method Description
addCustomFilter 使用 AND 将筛选器添加到查找结果,并结合现有筛选器。
addCustomView 向查找对话框添加视图。
addNotification 显示包含可选操作的错误或建议通知。
addOnLookupTagClick 添加在单击查找标记时运行的事件处理程序。
addPreSearch 添加在查找搜索之前运行的事件处理程序。
clearNotification 从控件中删除通知。
getAttribute 返回控件绑定到的列。
getControlType 返回控件的类型。
getDefaultView 返回默认查找视图的 ID。
getDisabled 返回控件是否已禁用。
getEntityTypes 返回查找中允许的表类型。
getLabel 返回控件的标签。
getName 返回控件的名称。
getParent 返回包含控件的节。
getVisible 返回控件是否可见。
removeOnLookupTagClick 删除查找标记单击的事件处理程序。
removePreSearch 删除在查找搜索之前运行的事件处理程序。
setDefaultView 设置查找对话框中的默认视图。
setDisabled 启用或禁用控件。
setEntityTypes 设置查找中允许的表类型。
setFocus 将焦点移动到控件。
setLabel 更改控件的标签。
setNotification 显示一条错误消息,指示数据无效。
setVisible 显示或隐藏控件。

选项和选择控件类型

选项和选择控件具有相同的方法集。

Method Description
addNotification 显示包含可选操作的错误或建议通知。
addOption 向控件添加选项。
clearNotification 从控件中删除通知。
clearOptions 从控件中删除所有选项。
getAttribute 返回控件绑定到的列。
getControlType 返回控件的类型。
getDisabled 返回控件是否已禁用。
getLabel 返回控件的标签。
getName 返回控件的名称。
getOptions 返回可用选项,包括空白选项和排除已删除的选项。
getParent 返回包含控件的节。
getVisible 返回控件是否可见。
removeOption 从控件中删除选项。
setDisabled 启用或禁用控件。
setFocus 将焦点移动到控件。
setLabel 更改控件的标签。
setNotification 显示一条错误消息,指示数据无效。
setVisible 显示或隐藏控件。

快速窗体控件类型

有关此控件类型支持的方法的信息,请参阅 formContext.ui.quickForms 。

子网格控件类型

有关此控件类型支持的方法的信息,请参阅 网格和子网格 。

时间线墙控件类型

时间线控件在统一视图中显示帖子、活动和备注。 这些方法可用于此控件类型。

Method Description
getControlType 返回控件的类型。
getDisabled 返回控件是否已禁用。
getLabel 返回控件的标签。
getName 返回控件的名称。
getParent 返回包含控件的节。
getVisible 返回控件是否可见。
刷新 刷新时间线中显示的数据。
setDisabled 启用或禁用控件。
setFocus 将焦点移动到控件。
setLabel 更改控件的标签。
setVisible 显示或隐藏控件。

计时器控件类型

这些方法可用于计时器控件。

Method Description
getControlType 返回控件的类型。
getDisabled 返回控件是否已禁用。
getLabel 返回控件的标签。
getName 返回控件的名称。
getParent 返回包含控件的节。
getState 返回计时器的当前状态。
getVisible 返回控件是否可见。
刷新 刷新计时器中显示的数据。
setDisabled 启用或禁用控件。
setFocus 将焦点移动到控件。
setLabel 更改控件的标签。
setVisible 显示或隐藏控件。

Web 资源控制类型

Web 资源控件具有与 iframe 控件相同的方法集。 请参阅 iframe 控件类型。

窗体组件控件类型

窗体组件控件类型具有与主窗体上的 formContext 相同的方法集。 请参阅 表单组件行为 > 客户端 API。

Columns