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 targeting supports v1.3 you should use label instead 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.
Column
Defines a container that is part of a ColumnSet.
Property | Type | Required | Description | Version |
---|---|---|---|---|
items | Element[] |
No | The card elements to render inside the Column . |
1.0 |
backgroundImage | BackgroundImage , uri |
No | Specifies the background image. Acceptable formats are PNG, JPEG, and GIF | 1.2 |
bleed | boolean |
No | Determines whether the column should bleed through its parent’s padding. | 1.2 |
fallback | Column , FallbackOption |
No | Describes what to do when an unknown item is encountered or the requires of this or any children can’t be met. | 1.2 |
minHeight | string |
No | Specifies the minimum height of the column in pixels, like "80px" . |
1.2 |
rtl | boolean? |
No | When true content in this column should be presented right to left. When ‘false’ content in this column should be presented left to right. When unset layout direction will inherit from parent container or column. If unset in all ancestors, the default platform behavior will apply. |
1.5 |
separator | boolean |
No | When true , draw a separating line between this column and the previous column. |
1.0 |
spacing | Spacing |
No | Controls the amount of spacing between this column and the preceding column. | 1.0 |
selectAction | ISelectAction |
No | An Action that will be invoked when the Column is tapped or selected. Action.ShowCard is not supported. |
1.1 |
style | ContainerStyle? |
No | Style hint for Column . |
1.0 |
verticalContentAlignment | VerticalContentAlignment? |
No | Defines how the content should be aligned vertically within the column. When not specified, the value of verticalContentAlignment is inherited from the parent container. If no parent container has verticalContentAlignment set, it defaults to Top. | 1.1 |
width | string , number |
No | "auto" , "stretch" , a number representing relative width of the column in the column group, or in version 1.1 and higher, a specific pixel width, like "50px" . |
1.0 |
Inherited properties
Property | Type | Required | Description | Version |
---|---|---|---|---|
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
items
The card elements to render inside the Column
.
- Type:
Element[]
- Required: No
- Allowed values:
ActionSet
ColumnSet
Container
FactSet
Image
ImageSet
Input.ChoiceSet
Input.Date
Input.Number
Input.Text
Input.Time
Input.Toggle
Media
RichTextBlock
Table
TextBlock
backgroundImage
Specifies the background image. Acceptable formats are PNG, JPEG, and GIF
- Type:
BackgroundImage
,uri
- Version : 1.2
- Required: No
- Allowed values:
BackgroundImage
uri
bleed
Determines whether the column should bleed through its parent's padding.
- Type:
boolean
- Version : 1.2
- Required: No
fallback
Describes what to do when an unknown item is encountered or the requires of this or any children can't be met.
- Type:
Column
,FallbackOption
- Version : 1.2
- Required: No
- Allowed values:
Column
"drop"
: Causes this element to be dropped immediately when unknown elements are encountered. The unknown element doesn't bubble up any higher.
minHeight
Specifies the minimum height of the column in pixels, like "80px"
.
- Type:
string
- Version : 1.2
- Required: No
rtl
When true
content in this column should be presented right to left. When 'false' content in this column should be presented left to right. When unset layout direction will inherit from parent container or column. If unset in all ancestors, the default platform behavior will apply.
- Type:
boolean?
- Version : 1.5
- Required: No
separator
When true
, draw a separating line between this column and the previous column.
- Type:
boolean
- Required: No
spacing
Controls the amount of spacing between this column and the preceding column.
- Type:
Spacing
- Required: No
- Allowed values:
"default"
"none"
"small"
"medium"
"large"
"extraLarge"
"padding"
selectAction
An Action that will be invoked when the Column
is tapped or selected. Action.ShowCard
is not supported.
- Type:
ISelectAction
- Version : 1.1
- Required: No
- Allowed values:
Action.Execute
Action.OpenUrl
Action.Submit
Action.ToggleVisibility
style
Style hint for Column
.
- Type:
ContainerStyle?
- Required: No
- Allowed values:
"default"
"emphasis"
"good"
: Added in version 1.2."attention"
: Added in version 1.2."warning"
: Added in version 1.2."accent"
: Added in version 1.2.
verticalContentAlignment
Defines how the content should be aligned vertically within the column. When not specified, the value of verticalContentAlignment is inherited from the parent container. If no parent container has verticalContentAlignment set, it defaults to Top.
- Type:
VerticalContentAlignment?
- Version : 1.1
- Required: No
- Allowed values:
"top"
"center"
"bottom"
width
"auto"
, "stretch"
, a number representing relative width of the column in the column group, or in version 1.1 and higher, a specific pixel width, like "50px"
.
- Type:
string
,number
- Required: No
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