GridBase Class
Namespace: Stride.UI.PanelsAssembly: Stride.UI.dll
Represents the base primitive for all the grid-like controls
[DataContract("GridBase")]
public abstract class GridBase : Panel, IUIElementUpdate, IUIElementChildren, IIdentifiable, IScrollAnchorInfo
Name | Description | |
---|---|---|
Fields | ||
ColumnPropertyKey | The key to the Column attached dependency property. This defines the column an item is inserted into. |
|
ColumnSpanPropertyKey | The key to the ColumnSpan attached dependency property. This defines the number of columns an item takes. |
|
LayerPropertyKey | The key to the Layer attached dependency property. This defines the layer an item is inserted into. |
|
LayerSpanPropertyKey | The key to the LayerSpan attached dependency property. This defines the number of layers an item takes. |
|
RowPropertyKey | The key to the Row attached dependency property. This defines the row an item is inserted into. |
|
RowSpanPropertyKey | The key to the RowSpan attached dependency property. This defines the number of rows an item takes. |
|
Methods | ||
GetElementGridPositions(UIElement) | Get the positions of an element in the grid as an Int3. |
|
GetElementSpanValues(UIElement) | Get an element span values as an Int3. |
Fields
ColumnPropertyKey
The key to the Column attached dependency property. This defines the column an item is inserted into.
[DataMemberRange(0, 0)]
[Display(null, "Layout")]
public static readonly PropertyKey<int> ColumnPropertyKey
Field Value
Type | Description |
---|---|
PropertyKey<System.Int32> |
Remarks
The value is coerced in the range [0, System.Int32.MaxValue].
ColumnSpanPropertyKey
The key to the ColumnSpan attached dependency property. This defines the number of columns an item takes.
[DataMemberRange(1, 0)]
[Display(null, "Layout")]
public static readonly PropertyKey<int> ColumnSpanPropertyKey
Field Value
Type | Description |
---|---|
PropertyKey<System.Int32> |
Remarks
The value is coerced in the range [1, System.Int32.MaxValue].
LayerPropertyKey
The key to the Layer attached dependency property. This defines the layer an item is inserted into.
[DataMemberRange(0, 0)]
[Display(null, "Layout")]
public static readonly PropertyKey<int> LayerPropertyKey
Field Value
Type | Description |
---|---|
PropertyKey<System.Int32> |
Remarks
The value is coerced in the range [0, System.Int32.MaxValue].
LayerSpanPropertyKey
The key to the LayerSpan attached dependency property. This defines the number of layers an item takes.
[DataMemberRange(1, 0)]
[Display(null, "Layout")]
public static readonly PropertyKey<int> LayerSpanPropertyKey
Field Value
Type | Description |
---|---|
PropertyKey<System.Int32> |
Remarks
The value is coerced in the range [1, System.Int32.MaxValue].
RowPropertyKey
The key to the Row attached dependency property. This defines the row an item is inserted into.
[DataMemberRange(0, 0)]
[Display(null, "Layout")]
public static readonly PropertyKey<int> RowPropertyKey
Field Value
Type | Description |
---|---|
PropertyKey<System.Int32> |
Remarks
The value is coerced in the range [0, System.Int32.MaxValue].
RowSpanPropertyKey
The key to the RowSpan attached dependency property. This defines the number of rows an item takes.
[DataMemberRange(1, 0)]
[Display(null, "Layout")]
public static readonly PropertyKey<int> RowSpanPropertyKey
Field Value
Type | Description |
---|---|
PropertyKey<System.Int32> |
Remarks
The value is coerced in the range [1, System.Int32.MaxValue].
Methods
GetElementGridPositions(UIElement)
Get the positions of an element in the grid as an Int3.
protected virtual Int3 GetElementGridPositions(UIElement element)
Parameters
Type | Name | Description |
---|---|---|
UIElement | element | The element from which extract the position values |
Returns
Type | Description |
---|---|
Int3 | The position of the element |
GetElementSpanValues(UIElement)
Get an element span values as an Int3.
protected virtual Int3 GetElementSpanValues(UIElement element)
Parameters
Type | Name | Description |
---|---|---|
UIElement | element | The element from which extract the span values |
Returns
Type | Description |
---|---|
Int3 | The span values of the element |