操作.切换可见性

注释

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

此页面记录了 Action.ToggleVisibility 元素,该元素是一个动作,可用于切换卡片元素的关联可见性。

版本 1.2 中引入

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

操作.切换可见性

切换关联卡片元素可见性的动作。

Action.ToggleVisibility 属性

资产 类型 必选 Description 版本
类型 "Action.ToggleVisibility" 是的 必须是 "Action.ToggleVisibility" 1.2
targetElements TargetElement[] 是的 TargetElements 的数组。 不建议在“Action.Toggle”下包含具有验证功能的输入元素,因为这些输入项可能由于无效且当前不可见而引发混淆。 有关详细信息,请参阅 /adaptive-cards/authoring-cards/input-validation 1.2

继承的属性

资产 类型 必选 Description 版本
标题 string 表示此操作的按钮或链接的标签。 1.2
iconUrl uri 可选图标将在操作中与标题一起显示。 支持版本 1.2+ 中的数据 URI。 1.1
id string 与此动作相关联的唯一标识符。 1.2
style ActionStyle 控制动作的样式,该样式会影响动作的显示方式、语音方式等。 1.2
回退 ActionFallbackOption 描述当遇到未知元素或无法满足此元素或任何子元素的需求时要执行的措施。 1.2
工具提示 string 定义在最终用户将鼠标悬停于操作上时显示给他们的文本,并在使用旁白软件时读取。 1.5
isEnabled boolean 否,默认值: true 确定是否应启用该操作。 1.5
mode ActionMode 否,默认值: "primary" 确定是否应将操作显示为按钮还是放在溢出菜单中。 1.5
需要 Dictionary<string> 一系列键/值对,说明项目所需功能及其相应的最低版本。 当某个功能缺失或版本不够时,将触发降级。 1.2

Example

Action.ToggleVisibility 示例(JSON)

{
	"type": "AdaptiveCard",
	"version": "1.2",
	"body": [
		{
			"type": "TextBlock",
			"text": "Press the buttons to toggle the images!",
			"wrap": true
		},
		{
			"type": "TextBlock",
			"text": "Here are some images:",
			"isVisible": false,
			"id": "textToToggle"
		},
		{
			"type": "ColumnSet",
			"columns": [
				{
					"type": "Column",
					"items": [
						{
							"style": "person",
							"type": "Image",
							"url": "https://picsum.photos/100/100?image=112",
							"isVisible": false,
							"id": "imageToToggle",
							"altText": "sample image 1",
							"size": "medium"
						}
					]
				},
				{
					"type": "Column",
					"items": [

						{
							"type": "Image",
							"url": "https://picsum.photos/100/100?image=123",
							"isVisible": false,
							"id": "imageToToggle2",
							"altText": "sample image 2",
							"size": "medium"
						}
					]
				}
			]
		}
	],
	"actions": [
		{
			"type": "Action.ToggleVisibility",
			"title": "Toggle!",
			"targetElements": [ "textToToggle", "imageToToggle", "imageToToggle2" ]
		},
		{
			"type": "Action.ToggleVisibility",
			"title": "Show!",
			"targetElements": [
				{
					"elementId": "textToToggle",
					"isVisible": true
				},
				{
					"elementId": "imageToToggle",
					"isVisible": true
				},
				{
					"elementId": "imageToToggle2",
					"isVisible": true
				}
			]
		},
		{
			"type": "Action.ToggleVisibility",
			"title": "Hide!",
			"targetElements": [
				{
					"elementId": "textToToggle",
					"isVisible": false
				},
				{
					"elementId": "imageToToggle",
					"isVisible": false
				},
				{
					"elementId": "imageToToggle2",
					"isVisible": false
				}
			]
		}
	]
}

属性

目标元素

TargetElements 的数组。 建议不要在 Action.Toggle 下包含带有验证功能的输入元素,因为这会导致对当前不可见的无效输入产生混淆。 有关详细信息,请参阅 /adaptive-cards/authoring-cards/input-validation

  • 类型TargetElement[]
  • 必需:是
  • 允许的值
    • TargetElement
    • string

title

表示此操作的按钮或链接的标签。

  • 类型string
  • 必需:否

iconUrl

可选图标将在操作中与标题一起显示。 支持版本 1.2+ 中的数据 URI。

  • 类型uri
  • 版本:1.1
  • 必需:否

id

与此动作相关联的唯一标识符。

  • 类型string
  • 必需:否

样式

控制动作的样式,该样式会影响动作的显示方式、语音方式等。

  • 类型ActionStyle
  • 版本:1.2
  • 必需:否
  • 允许的值
    • "default":操作显示为正常。
    • "positive":操作以正面样式显示(通常按钮显示为强调色)。
    • "destructive":以破坏性样式显示操作(通常按钮变为红色)。

后备

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

  • 类型ActionFallbackOption
  • 版本:1.2
  • 必需:否
  • 允许的值
    • Action.Execute、、Action.OpenUrlAction.ShowCardAction.Submit. Action.ToggleVisibility
    • "drop":导致遇到未知元素时立即删除此元素。 未知元素不会进一步冒泡。

工具提示

定义在最终用户将鼠标悬停于操作上时显示给他们的文本,并在使用旁白软件时读取。

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

isEnabled

确定是否应启用该操作。

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

mode

确定是否应将操作显示为按钮还是放在溢出菜单中。

  • 类型ActionMode
  • 版本:1.5
  • 必需:否,默认值: "primary"
  • 允许的值
    • "primary":动作显示为按钮。
    • "secondary":操作被放置在溢出菜单中(通常在按钮下的...弹出菜单中)。

需要

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

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