输入文本

注释

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

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

输入文本

允许用户输入文本。

Input.Text 属性

资产 类型 必选 Description 版本
类型 "Input.Text" 是的 必须是 "Input.Text"。 1.0
id string 是的 值的唯一标识符。 用于标识执行“提交”作时收集的输入。 1.0
isMultiline boolean 否 如果 true允许多行输入。 1.0
maxLength number 否 关于收集最大字符长度的提示信息（某些客户端可能会忽略）。 1.0
占 位 符 string 否 所需输入的说明。 未输入文本时显示。 1.0
正则表达式 string 否 指示此文本输入所需格式的正则表达式。 1.3
style TextInputStyle 否 文本输入的样式提示。 1.0
inlineAction ISelectAction 否 输入的内联动作。 通常显示在输入右侧。 强烈建议在动作上提供一个图标（该图标将会显示，而不是动作的标题）。 1.2
value string 否 此字段的初始值。 1.0

继承的属性

资产 类型 必选 Description 版本
errorMessage string 否 映示当输入无效时的错误信息 1.3
isRequired boolean 否 是否需要此输入 1.3
label string 否 此输入的标签 1.3
标签位置 InputLabelPosition 否 [仅在 JAVASCRIPT SDK 中受支持]确定标签的位置。 它可以取“行内”和“上方”这两个值。 默认情况下，如果未指定标签位置，标签将置于“上方”。 1.6
labelWidth string、number 否 [仅在 JAVASCRIPT SDK 中受支持]确定标签在与输入内联时的宽度，可以是百分比（如 40%）或特定像素宽度（如“40px”）。 当标签显示在输入上方时，将忽略 labelWidth。 1.6
inputStyle InputStyle 否 [仅在 JAVASCRIPT SDK 中受支持]输入字段的样式提示。 允许输入字段显示为只读字段，但当用户单击/关注字段时，它允许他们更新这些字段。 1.6
回退 Element、FallbackOption 否 描述当遇到未知元素或无法满足此元素或任何子元素的需求时要执行的措施。 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：默认、多行和预先填充的文本输入

JSON 自适应卡片
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.0", "body": [ { "type": "TextBlock", "text": "Default text input" }, { "type": "Input.Text", "id": "defaultInputId", "placeholder": "enter comment", "maxLength": 500 }, { "type": "TextBlock", "text": "Multiline text input" }, { "type": "Input.Text", "id": "multilineInputId", "placeholder": "enter comment", "maxLength": 500, "isMultiline": true }, { "type": "TextBlock", "text": "Pre-filled value" }, { "type": "Input.Text", "id": "prefilledInputId", "placeholder": "enter comment", "maxLength": 500, "isMultiline": true, "value": "This value was pre-filled" } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] } [自适应卡片自己试一试 >]

属性

isMultiline （版本 1.0）

如果 true允许多行输入。

  • 类型：boolean
  • 必需：否

maxLength （版本 1.0）

要收集的最大长度字符的提示（某些客户端可能忽略）。

  • 类型：number
  • 必需：否

占位符 （版本 1.0）

所需输入的说明。 未输入文本时显示。

  • 类型：string
  • 必需：否

正则表达式 （版本 1.3）

指示此文本输入所需格式的正则表达式。

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

style （版本 1.0）

输入文本的样式提示

  • 类型：TextInputStyle
  • 必需：否
  • 允许的值：
    • "text"
    • "tel"
    • "url"
    • "email"
    • "password"：在版本 1.5 中添加。 显示带有密码掩码的输入文本。
JSON 自适应卡片
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.3", "body": [ { "type": "TextBlock", "text": "Specify the type of text being requested:", "style": "heading" }, { "type": "Input.Text", "id": "myComment", "label": "style: text", "style": "text" }, { "type": "Input.Text", "id": "myEmail", "label": "style: email", "style": "email" }, { "type": "Input.Text", "id": "myTel", "label": "style: tel", "style": "tel" }, { "type": "Input.Text", "id": "myUrl", "label": "style: url", "style": "url" }, { "type": "Input.Text", "id": "myPassword", "label": "style: password", "style": "password" } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] } [自适应卡片自己试一试 >]

inlineAction （版本 1.2）

输入的内联动作。 通常显示在输入右侧。 强烈建议在动作上提供一个图标（该图标将会显示，而不是动作的标题）。

  • 类型：ISelectAction
  • 版本 ：1.2
  • 必需：否
  • 允许的值：
    • Action.Execute
    • Action.OpenUrl
    • Action.Submit
    • Action.ToggleVisibility
JSON 自适应卡片
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.5", "body": [ { "type": "Input.Text", "id": "iconInlineActionId", "label": "Text input with an inline action", "inlineAction": { "type": "Action.Submit", "iconUrl": "https://adaptivecards.io/content/send.png", "tooltip": "Send" } }, { "type": "Input.Text", "label": "Text input with an inline action with no icon", "id": "textInlineActionId", "inlineAction": { "type": "Action.OpenUrl", "title": "Reply", "tooltip": "Reply to this message", "url": "https://adaptivecards.io" } } ] } [自适应卡片自己试一试 >]

值 （版本 1.0）

此字段的初始值。

  • 类型：string
  • 必需：否

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 当标签显示在输入上方时，将被忽略。

  • 类型： string， number
  • 版本 ：1.6
  • 必需：否

inputStyle （版本 1.6）

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

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

回退 （版本 1.2）

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

  • 类型： Element， FallbackOption
  • 版本 ：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
  • 必需：否
  • Last updated on