Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    ModalElement Class

    Namespace: Stride.UI.Controls
    Assembly: Stride.UI.dll

    Represents a modal element that puts an overlay upon the underneath elements and freeze their input.

    System.Object → UIElement → Control → ContentControl → ButtonBase → ModalElement
    Derived from ModalElement:

    [DataContract("ModalElement")]
    [DataContractMetadataType(typeof(ModalElement.ModalElementMetadata))]
    [Display(null, null)]
    public class ModalElement : ButtonBase, IUIElementUpdate, IUIElementChildren, IIdentifiable
    Name Description
    Constructors
    ModalElement()
    Fields
    OutsideClickEvent

    Identifies the OutsideClick routed event.

    Properties
    IsModal

    Determine if the control should block the input of underneath elements or not.

    OverlayColor

    The color of the overlay drawn upon underneath elements.

    Methods
    Intersects(ref Ray, out Vector3)
    OnTouchUp(TouchEventArgs)
    Events
    OutsideClick

    Occurs when the element is modal and the user click outside of the modal element.

    | Improve this Doc View Source

    Constructors


    ModalElement()

    public ModalElement()
    | Improve this Doc View Source

    Fields


    OutsideClickEvent

    Identifies the OutsideClick routed event.

    public static readonly RoutedEvent<RoutedEventArgs> OutsideClickEvent
    Field Value
    Type Description
    RoutedEvent<RoutedEventArgs>
    | Improve this Doc View Source

    Properties


    IsModal

    Determine if the control should block the input of underneath elements or not.

    [DataMember]
    [Display(null, "Behavior")]
    public bool IsModal { get; set; }
    Property Value
    Type Description
    System.Boolean

    OverlayColor

    The color of the overlay drawn upon underneath elements.

    [DataMember]
    [Display(null, "Appearance")]
    public Color OverlayColor { get; set; }
    Property Value
    Type Description
    Color
    | Improve this Doc View Source

    Methods


    Intersects(ref Ray, out Vector3)

    protected override bool Intersects(ref Ray ray, out Vector3 intersectionPoint)
    Parameters
    Type Name Description
    Ray ray
    Vector3 intersectionPoint
    Returns
    Type Description
    System.Boolean
    Overrides
    UIElement.Intersects(ref Ray, out Vector3)

    OnTouchUp(TouchEventArgs)

    protected override void OnTouchUp(TouchEventArgs args)
    Parameters
    Type Name Description
    TouchEventArgs args
    Overrides
    ButtonBase.OnTouchUp(TouchEventArgs)
    | Improve this Doc View Source

    Events


    OutsideClick

    Occurs when the element is modal and the user click outside of the modal element.

    public event EventHandler<RoutedEventArgs> OutsideClick
    Event Type
    Type Description
    System.EventHandler<RoutedEventArgs>
    Remarks

    A click event is bubbling


    Inherited Members

    ButtonBase.ClickMode
    ButtonBase.IsPressed
    ButtonBase.Click
    ButtonBase.ClickEvent
    ButtonBase.OnTouchDown(TouchEventArgs)
    ButtonBase.OnTouchLeave(TouchEventArgs)
    ButtonBase.OnClick(RoutedEventArgs)
    ContentControl.ContentArrangeMatrixPropertyKey
    ContentControl.Content
    ContentControl.VisualContent
    ContentControl.EnumerateChildren()
    ContentControl.MeasureOverride(Vector3)
    ContentControl.ArrangeOverride(Vector3)
    ContentControl.UpdateWorldMatrix(Matrix, Boolean)
    Control.padding
    Control.Padding
    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.Arrange(Vector3, Boolean)
    UIElement.CollapseOverride()
    UIElement.PropagateCollapseToChild(UIElement)
    UIElement.FindName(String)
    UIElement.SetParent(UIElement, UIElement)
    UIElement.SetVisualParent(UIElement, UIElement)
    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.OnTouchEnter(TouchEventArgs)
    UIElement.OnTouchMove(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