输入.选项集

注释

你是构建由自适应卡片提供支持的 Copilot、Teams 或 Outlook 方案吗? 访问 自适应卡片文档中心,这是所有自适应卡需求的新一站式商店! 它包含要查找的所有资源,包括许多新功能的完整文档,如 响应式布局图标锁屏提醒轮播图表等!

有关辅助功能的重要说明: 在架构版本 1.3 中,我们在输入中引入了一个 标签 属性以提高辅助功能。 如果你 面向的 Host 应用 支持 v1.3,则应使用 标签 而不是 TextBlock ,如以下示例所示。 大多数主机应用更新到最新版本后,我们将相应地更新示例。

输入.选项集

允许用户输入选项。

Input.ChoiceSet 属性

资产 类型 必选 Description 版本
类型 "Input.ChoiceSet" 是的 必须是 "Input.ChoiceSet" 1.0
id string 是的 值的唯一标识符。 用于标识执行“提交”作时收集的输入。 1.0
选项 Input.Choice[] Choice 选项。 1.0
choices.data Data.Query 允许在用户于输入字段中键入时,动态从机器人中获取选项,并将其显示为下拉菜单中的建议。 1.6
isMultiSelect boolean 允许选择多个选项。 1.0
style ChoiceInputStyle 1.0
value string 应选择的初始选项(或选项集)。 对于多选,请指定逗号分隔的值字符串。 1.0
占 位 符 string 所需输入的说明。 仅在未进行选择时可见,stylecompact,且isMultiSelectfalse 1.0
包装 boolean 如果 true,则允许文本换行。 否则,文本将被截断。 1.2

继承的属性

资产 类型 必选 Description 版本
errorMessage string 映示当输入无效时的错误信息 1.3
isRequired boolean 是否需要此输入 1.3
label string 此输入的标签 1.3
labelPosition InputLabelPosition [仅在 JAVASCRIPT SDK 中受支持]确定标签的位置。 它可以接受“内嵌”和“上方”值。 默认情况下,如果未指定标签位置,标签将置于“上方”。 1.6
labelWidth stringnumber [仅在 JAVASCRIPT SDK 中受支持] 确定标签的宽度,比如以百分比形式为 40% 或者以特定像素宽度形式为“40px”,当标签与输入内联时。 当标签显示在输入上方时,将忽略 labelWidth。 1.6
inputStyle InputStyle [仅在 JAVASCRIPT SDK 中受支持]输入字段的样式提示。 允许输入字段显示为只读字段,但当用户单击/关注字段时,它允许他们更新这些字段。 1.6
回退 ElementFallbackOption 描述当遇到未知元素或无法满足此元素或任何子元素的需求时要执行的措施。 1.2
height BlockElementHeight 指定元素的高度。 1.1
separator boolean true时,在元素顶部绘制一条分隔线。 1.0
间距 Spacing 控制此元素与上一个元素之间的间距量。 1.0
isVisible boolean 否,默认值: true 如果 false,将从可视化树中删除此项。 1.2
需要 Dictionary<string> 一系列键/值对,说明项目所需功能及其相应的最低版本。 当某个功能缺失或版本不够时,将触发降级。 1.2

Example

示例 1:演示 ChoiceSet 样式及其多选功能

JSON 自适应卡片
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.3", "body": [ { "type": "Input.ChoiceSet", "id": "myColor", "style": "compact", "label": "What color do you want? (isMultiSelect:false, style:compact)", "isMultiSelect": false, "value": "1", "choices": [ { "title": "Red", "value": "1" }, { "title": "Green", "value": "2" }, { "title": "Blue", "value": "3" } ] }, { "type": "Input.ChoiceSet", "id": "myColor2", "style": "expanded", "label": "What color do you want? (isMultiSelect:false, style:expanded)", "isMultiSelect": false, "value": "1", "choices": [ { "title": "Red", "value": "1" }, { "title": "Green", "value": "2" }, { "title": "Blue", "value": "3" } ] }, { "type": "Input.ChoiceSet", "id": "myColor3", "isMultiSelect": true, "value": "1,3", "style": "compact", "label": "What colors do you want? (isMultiSelect:true, style:compact)", "choices": [ { "title": "Red", "value": "1" }, { "title": "Green", "value": "2" }, { "title": "Blue", "value": "3" } ] }, { "type": "Input.ChoiceSet", "id": "myColor4", "isMultiSelect": true, "value": "1", "style": "expanded", "label": "What colors do you want? (isMultiSelect:true, style:expanded)", "choices": [ { "title": "Red", "value": "1" }, { "title": "Green", "value": "2" }, { "title": "Blue", "value": "3" } ] } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] }

属性

选项 (版本 1.0)

Choice 选项。

  • 类型Input.Choice[]
  • 必需:否
  • 允许的值
    • Input.Choice

choices.data (版本 1.6)

当用户在输入字段中键入时,允许动态从机器人中提取选项,并将其显示为下拉列表中的建议。

  • 类型Data.Query
  • 版本 :1.6
  • 必需:否
  • 允许的值
    • Data.Query

isMultiSelect (版本 1.0)

允许选择多个选项。

  • 类型boolean
  • 必需:否

style (版本 1.0)

  • 类型ChoiceInputStyle
  • 必需:否
  • 允许的值
    • "compact"
    • "expanded"
    • "filtered":在版本 1.5 中添加。 允许用户筛选选择集中的选项。

值 (版本 1.0)

应选择的初始选项(或选项集)。 对于多选,请指定逗号分隔的值字符串。

  • 类型string
  • 必需:否

占位符 (版本 1.0)

所需输入的说明。 仅当未进行选择时可见,stylecompact,而isMultiSelectfalse

  • 类型string
  • 必需:否
JSON 自适应卡片
json { "type": "AdaptiveCard", "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "version": "1.3", "body": [ { "type": "Input.ChoiceSet", "id": "CompactSelectVal", "label": "What color do you want? (compact)", "style": "compact", "isRequired": true, "errorMessage": "This is a required input", "placeholder": "Please choose", "choices": [ { "title": "Red", "value": "1" }, { "title": "Green", "value": "2" }, { "title": "Blue", "value": "3" } ] } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] }

wrap (版本 1.2)

如果 true,则允许文本换行。 否则,文本将被截断。

  • 类型boolean
  • 版本 :1.2
  • 必需:否

id (版本 1.0)

值的唯一标识符。 用于标识执行“提交”作时收集的输入。

  • 类型string
  • 必需:是

错误信息 (版本 1.3)

映示当输入无效时的错误信息

  • 类型string
  • 版本 :1.3
  • 必需:否

isRequired (版本 1.3)

是否需要此输入

  • 类型boolean
  • 版本 :1.3
  • 必需:否

label (版本 1.3)

此输入的标签

  • 类型string
  • 版本 :1.3
  • 必需:否

labelPosition (版本 1.6)

[仅在 JAVASCRIPT SDK 中受支持]确定标签的位置。 它可以使用“内联”和“上面”这两个值。 默认情况下,如果未指定标签位置,标签将置于“上方”。

  • 类型InputLabelPosition
  • 版本 :1.6
  • 必需:否
  • 允许的值
    • "inline"
    • "above"

labelWidth (版本 1.6)

仅在 JAVASCRIPT SDK 中受支持] 当标签与输入在同一行时,确定标签的宽度为百分比(如 40%)或具体的像素宽度(如“40px”)。 labelWidth 当标签显示在输入上方时,将被忽略。

  • 类型stringnumber
  • 版本 :1.6
  • 必需:否

inputStyle (版本 1.6)

[仅在 JAVASCRIPT SDK 中受支持]输入字段的样式提示。 允许输入字段显示为只读字段,但当用户单击/关注字段时,它允许他们更新这些字段。

  • 类型InputStyle
  • 版本 :1.6
  • 必需:否
  • 允许的值
    • "revealOnHover"
    • "default"

回退 (版本 1.2)

描述遇到未知元素时或无法满足该元素或任何子元素的要求时需要执行的操作。

  • 类型ElementFallbackOption
  • 版本 :1.2
  • 必需:否
  • 允许的值
    • ActionSet
    • ColumnSet
    • Container
    • FactSet
    • Image
    • ImageSet
    • Input.ChoiceSet
    • Input.Date
    • Input.Number
    • Input.Text
    • Input.Time
    • Input.Toggle
    • Media
    • RichTextBlock
    • Table
    • TextBlock
    • "drop":导致遇到未知元素时立即删除此元素。 未知元素不会进一步冒泡。

高度 (版本 1.1)

指定元素的高度。

  • 类型BlockElementHeight
  • 版本 :1.1
  • 必需:否
  • 允许的值
    • "auto":容器的高度由其内容的高度决定。
    • "stretch":容器将高度拉伸到父容器的可用剩余高度。

分隔符(版本 1.0)

true时,在元素顶部绘制一条分隔线。

  • 类型boolean
  • 必需:否

间距(版本 1.0)

控制此元素与上一个元素之间的间距量。

  • 类型Spacing
  • 必需:否
  • 允许的值
    • "default"
    • "none"
    • "small"
    • "medium"
    • "large"
    • "extraLarge"
    • "padding"

isVisible (版本 1.2)

如果 false,将从可视化树中删除此项。

  • 类型boolean
  • 版本 :1.2
  • 必需:否,默认值: true

需要【版本 1.2】

一系列键/值对,说明项目所需功能及其相应的最低版本。 当某个功能缺失或版本不够时,将触发降级。

  • 类型Dictionary<string>
  • 版本 :1.2
  • 必需:否