ModalElement Class
Namespace: Stride.UI.ControlsAssembly: Stride.UI.dll
Represents a modal element that puts an overlay upon the underneath elements and freeze their input.
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. |
Constructors
ModalElement()
public ModalElement()
Fields
OutsideClickEvent
Identifies the OutsideClick routed event.
public static readonly RoutedEvent<RoutedEventArgs> OutsideClickEvent
Field Value
Type | Description |
---|---|
RoutedEvent<RoutedEventArgs> |
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 |
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
OnTouchUp(TouchEventArgs)
protected override void OnTouchUp(TouchEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
TouchEventArgs | args |
Overrides
| Improve this Doc View SourceEvents
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