5.5 KiB
5.5 KiB
ColumnSet
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 |
horizontalAlignment | HorizontalAlignment? |
No | Controls the horizontal alignment of the ColumnSet. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left. | 1.0 |
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 |
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.Execute
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"
horizontalAlignment
Controls the horizontal alignment of the ColumnSet. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left.
- Type:
HorizontalAlignment?
- Required: No
- Allowed values:
"left"
"center"
"right"
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
Table
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.
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"
Rendering
- If
columns
is null or empty, render as a zero-height element. - Otherwise, render each valid column sequentially, from left to right. See the column widths section for determining widths.
- The final height of each column is determined by the height of the tallest column.
Column widths
To determine the width of each column...
- When given the final width of the entire ColumnSet...
- Subtract the widths of any columns with pixel widths specified.
- Then, sequentially ask each auto-width column how much space they need, given the remaining available width, and subtract that width from the remaining width before asking the next auto-width column.
- Then, distribute the remaining width across the stretch-width columns. If one column has a weight of 2 and another 1, then that column gets twice as much space as the other.
- If at any point remaining space goes to 0 or lower, the rest of the columns get 0 width.