Schema Explorer
Important note about accessibility: In version 1.3 of the schema we introduced a label property on Inputs to improve accessibility. If the Host app you are targetting supports v1.3 you should use label intead of a TextBlock as seen in some samples below. Once most Host apps have updated to the latest version we will update the samples accordingly.
ColumnSet
ColumnSet divides a region into Columns, allowing elements to sit side-by-side.
Property | Type | Required | Description | Version |
---|---|---|---|---|
type | "ColumnSet" |
Yes | Must be "ColumnSet" . |
1.0 |
columns | Column[] |
No | The array of Columns to divide the region into. |
1.0 |
selectAction | ISelectAction |
No | An Action that will be invoked when the ColumnSet is tapped or selected. Action.ShowCard is not supported. |
1.1 |
style | ContainerStyle? |
No | Style hint for ColumnSet . |
1.2 |
bleed | boolean |
No | Determines whether the element should bleed through its parent’s padding. | 1.2 |
minHeight | string |
No | Specifies the minimum height of the column set in pixels, like "80px" . |
1.2 |
Inherited properties
Property | Type | Required | Description | Version |
---|---|---|---|---|
fallback | Element , FallbackOption |
No | Describes what to do when an unknown element is encountered or the requires of this or any children can’t be met. | 1.2 |
height | BlockElementHeight |
No | Specifies the height of the element. | 1.1 |
separator | boolean |
No | When true , draw a separating line at the top of the element. |
1.0 |
spacing | Spacing |
No | Controls the amount of spacing between this element and the preceding element. | 1.0 |
id | string |
No | A unique identifier associated with the item. | 1.0 |
isVisible | boolean |
No, default: true |
If false , this item will be removed from the visual tree. |
1.2 |
requires | Dictionary<string> |
No | A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered. | 1.2 |
Example
Properties
columns
The array of Columns
to divide the region into.
- Type:
Column[]
- Required: No
- Allowed values:
Column
selectAction
An Action that will be invoked when the ColumnSet
is tapped or selected. Action.ShowCard
is not supported.
- Type:
ISelectAction
- Version : 1.1
- Required: No
- Allowed values:
Action.OpenUrl
Action.Submit
Action.ToggleVisibility
style
Style hint for ColumnSet
.
- Type:
ContainerStyle?
- Version : 1.2
- Required: No
- Allowed values:
"default"
"emphasis"
"good"
"attention"
"warning"
"accent"
bleed
Determines whether the element should bleed through its parent's padding.
- Type:
boolean
- Version : 1.2
- Required: No
minHeight
Specifies the minimum height of the column set in pixels, like "80px"
.
- Type:
string
- Version : 1.2
- Required: No
fallback
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
- Type:
Element
,FallbackOption
- Version : 1.2
- Required: No
- Allowed values:
ActionSet
ColumnSet
Container
FactSet
Image
ImageSet
Input.ChoiceSet
Input.Date
Input.Number
Input.Text
Input.Time
Input.Toggle
Media
RichTextBlock
TextBlock
"drop"
: Causes this element to be dropped immediately when unknown elements are encountered. The unknown element doesn't bubble up any higher.
height
Specifies the height of the element.
- Type:
BlockElementHeight
- Version : 1.1
- Required: No
- Allowed values:
"auto"
: The height of the container will be determined by the height of its contents."stretch"
: The container will stretch its height to the available remaining height of the parent container.
separator
When true
, draw a separating line at the top of the element.
- Type:
boolean
- Required: No
spacing
Controls the amount of spacing between this element and the preceding element.
- Type:
Spacing
- Required: No
- Allowed values:
"default"
"none"
"small"
"medium"
"large"
"extraLarge"
"padding"
id
A unique identifier associated with the item.
- Type:
string
- Required: No
isVisible
If false
, this item will be removed from the visual tree.
- Type:
boolean
- Version : 1.2
- Required: No, default:
true
requires
A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered.
- Type:
Dictionary<string>
- Version : 1.2
- Required: No