Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    GridBase Class

    Namespace: Stride.UI.Panels
    Assembly: Stride.UI.dll

    Represents the base primitive for all the grid-like controls

    System.Object → UIElement → Panel → GridBase
    Derived from GridBase: Grid UniformGrid

    [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.

    | Improve this Doc View Source

    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].

    | Improve this Doc View Source

    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


    Inherited Members

    Panel.ZIndexPropertyKey
    Panel.PanelArrangeMatrixPropertyKey
    Panel.PanelChildrenSorter
    Panel.Children
    Panel.EnumerateChildren()
    Panel.LogicalChildrenChanged(Object, TrackingCollectionChangedEventArgs)
    Panel.OnLogicalChildRemoved(UIElement, Int32)
    Panel.OnLogicalChildAdded(UIElement, Int32)
    Panel.UpdateWorldMatrix(Matrix, Boolean)
    Panel.ActivateAnchoring(Orientation, Boolean)
    Panel.ShouldAnchor(Orientation)
    Panel.GetSurroudingAnchorDistances(Orientation, Single)
    Panel.ScrollOwner
    UIElement.InputCategory
    UIElement.PanelCategory
    UIElement.AppearanceCategory
    UIElement.BehaviorCategory
    UIElement.LayoutCategory
    UIElement.MiscCategory
    UIElement.MarginInternal
    UIElement.ArrangeChanged
    UIElement.LocalMatrixChanged
    UIElement.Id
    UIElement.DependencyProperties
    UIElement.LocalMatrix
    UIElement.BackgroundColor
    UIElement.Opacity
    UIElement.Visibility
    UIElement.ClipToBounds
    UIElement.DrawLayerNumber
    UIElement.IsEnabled
    UIElement.CanBeHitByUser
    UIElement.Width
    UIElement.Height
    UIElement.Depth
    UIElement.Size
    UIElement.HorizontalAlignment
    UIElement.VerticalAlignment
    UIElement.DepthAlignment
    UIElement.Margin
    UIElement.MinimumWidth
    UIElement.MinimumHeight
    UIElement.MinimumDepth
    UIElement.MaximumWidth
    UIElement.MaximumHeight
    UIElement.MaximumDepth
    UIElement.DefaultWidth
    UIElement.DefaultHeight
    UIElement.DefaultDepth
    UIElement.Name
    UIElement.DesiredSize
    UIElement.DesiredSizeWithMargins
    UIElement.IsArrangeValid
    UIElement.IsMeasureValid
    UIElement.WorldMatrix
    UIElement.DepthBias
    UIElement.LayoutingContext
    UIElement.VisualChildrenCollection
    UIElement.InvalidateArrange()
    UIElement.InvalidateMeasure()
    UIElement.OnNameChanged()
    UIElement.IsHierarchyEnabled
    UIElement.IsVisible
    UIElement.IsCollapsed
    UIElement.Parent
    UIElement.VisualParent
    UIElement.VisualChildren
    UIElement.HitableChildren
    UIElement.RenderOpacity
    UIElement.RenderSize
    UIElement.RenderOffsets
    UIElement.ActualWidth
    UIElement.ActualHeight
    UIElement.ActualDepth
    UIElement.IUIElementChildren.Children
    UIElement.Measure(Vector3)
    UIElement.MeasureOverride(Vector3)
    UIElement.Arrange(Vector3, Boolean)
    UIElement.ArrangeOverride(Vector3)
    UIElement.CollapseOverride()
    UIElement.PropagateCollapseToChild(UIElement)
    UIElement.FindName(String)
    UIElement.SetParent(UIElement, UIElement)
    UIElement.SetVisualParent(UIElement, UIElement)
    UIElement.Intersects(Ray, Vector3)
    UIElement.IUIElementUpdate.Update(GameTime)
    UIElement.IUIElementUpdate.UpdateWorldMatrix(Matrix, Boolean)
    UIElement.IUIElementUpdate.UpdateElementState(Int32)
    UIElement.Update(GameTime)
    UIElement.CalculateSizeWithThickness(Vector3, Thickness)
    UIElement.CalculateSizeWithoutThickness(Vector3, Thickness)
    UIElement.CalculateAdjustmentOffsets(Thickness, Vector3, Vector3)
    UIElement.IsTouched
    UIElement.MouseOverState
    UIElement.RequiresMouseOverUpdate
    UIElement.RaiseEvent(RoutedEventArgs)
    UIElement.AddHandler<T>(RoutedEvent<T>, EventHandler<T>, Boolean)
    UIElement.RemoveHandler<T>(RoutedEvent<T>, EventHandler<T>)
    UIElement.MouseOverStateChanged
    UIElement.PreviewTouchDown
    UIElement.PreviewTouchMove
    UIElement.PreviewTouchUp
    UIElement.TouchDown
    UIElement.TouchEnter
    UIElement.TouchLeave
    UIElement.TouchMove
    UIElement.TouchUp
    UIElement.OnPreviewTouchDown(TouchEventArgs)
    UIElement.OnPreviewTouchMove(TouchEventArgs)
    UIElement.OnPreviewTouchUp(TouchEventArgs)
    UIElement.OnTouchDown(TouchEventArgs)
    UIElement.OnTouchEnter(TouchEventArgs)
    UIElement.OnTouchLeave(TouchEventArgs)
    UIElement.OnTouchMove(TouchEventArgs)
    UIElement.OnTouchUp(TouchEventArgs)

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    UIElementExtensions.SetPanelZIndex(UIElement, Int32)
    UIElementExtensions.GetPanelZIndex(UIElement)
    UIElementExtensions.SetCanvasRelativeSize(UIElement, Vector3)
    UIElementExtensions.GetCanvasRelativeSize(UIElement)
    UIElementExtensions.SetCanvasRelativePosition(UIElement, Vector3)
    UIElementExtensions.GetCanvasRelativePosition(UIElement)
    UIElementExtensions.SetCanvasAbsolutePosition(UIElement, Vector3)
    UIElementExtensions.GetCanvasAbsolutePosition(UIElement)
    UIElementExtensions.SetCanvasPinOrigin(UIElement, Vector3)
    UIElementExtensions.GetCanvasPinOrigin(UIElement)
    UIElementExtensions.SetGridColumn(UIElement, Int32)
    UIElementExtensions.GetGridColumn(UIElement)
    UIElementExtensions.SetGridRow(UIElement, Int32)
    UIElementExtensions.GetGridRow(UIElement)
    UIElementExtensions.SetGridLayer(UIElement, Int32)
    UIElementExtensions.GetGridLayer(UIElement)
    UIElementExtensions.SetGridColumnSpan(UIElement, Int32)
    UIElementExtensions.GetGridColumnSpan(UIElement)
    UIElementExtensions.SetGridRowSpan(UIElement, Int32)
    UIElementExtensions.GetGridRowSpan(UIElement)
    UIElementExtensions.SetGridLayerSpan(UIElement, Int32)
    UIElementExtensions.GetGridLayerSpan(UIElement)
    VisualTreeHelper.FindVisualChildOfType<T>(UIElement, String)
    VisualTreeHelper.FindVisualChildrenOfType<T>(UIElement)
    VisualTreeHelper.FindVisualParentOfType<T>(UIElement)
    VisualTreeHelper.FindVisualRoot(UIElement)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation