Window Class |
Namespace: DigitalRune.Game.UI.Controls
The Window type exposes the following members.
Name | Description | |
---|---|---|
Activate |
Activates this window (and deactivates all other windows).
| |
Arrange |
Positions child elements and determines a size for a control.
(Inherited from UIControl.) | |
BringIntoView |
Attempts to bring this element into view, within any scrollable regions it is contained
within.
(Inherited from UIControl.) | |
Close |
Closes this window.
| |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
Focus |
Moves the input focus to this control.
(Inherited from UIControl.) | |
GetControl |
Gets a control by name from the visual subtree of this control.
(Inherited from UIControl.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValueT(Int32) |
Gets the value of the property with the given ID.
(Inherited from GameObject.) | |
GetValueT(String) |
Gets the value of the property with the given name.
(Inherited from GameObject.) | |
GetValueT(GamePropertyMetadataT) |
Gets the value of the property with the given metadata.
(Inherited from GameObject.) | |
GetWindow |
Gets the window that contains the given control.
| |
HitTest |
Tests if a position is over a control.
(Inherited from ContentControl.) | |
InvalidateArrange |
Invalidates the arrange state (layout) for the control.
(Inherited from UIControl.) | |
InvalidateMeasure |
Invalidates the measurement state (layout) for the control.
(Inherited from UIControl.) | |
InvalidateVisual |
Invalidates the cached RenderData.
(Inherited from UIControl.) | |
Load |
Loads the content of the game object.
(Inherited from GameObject.) | |
Measure |
Updates the DesiredWidth and DesiredHeight of the control.
(Inherited from UIControl.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NewFrame |
Tells the game object to prepare itself for the next time step.
(Inherited from GameObject.) | |
OnArrange |
Called by Arrange(Vector2F, Vector2F) to arrange the visual children.
(Inherited from ContentControl.) | |
OnContentChanged |
Called when the Content was exchanged.
(Inherited from ContentControl.) | |
OnHandleInput |
Called when the control should handle device input.
(Overrides UIControlOnHandleInput(InputContext).) | |
OnLoad |
Called when the game object should load its content.
(Overrides UIControlOnLoad.) | |
OnMeasure |
Called by Measure(Vector2F) to compute the control-specific desired size.
(Inherited from ContentControl.) | |
OnPropertyChanged(PropertyChangedEventArgs) |
Raises the PropertyChanged event.
(Inherited from GameObject.) | |
OnPropertyChangedT(GamePropertyT, T, T) |
Is called after a game object property was changed.
(Inherited from GameObject.) | |
OnPropertyChangedT(GamePropertyT, T, T) |
Is called after a game object property was changed.
(Inherited from UIControl.) | |
OnRender |
Called when the control and its visual children should be rendered.
(Inherited from UIControl.) | |
OnTemplateChanged |
Raises the TemplateChanged event.
(Inherited from ContentControl.) | |
OnUnload |
Called when the game object should unload its content.
(Overrides UIControlOnUnload.) | |
OnUpdate |
Called when the game object should be updated.
(Inherited from UIControl.) | |
Render |
Renders the control (including visual children).
(Inherited from UIControl.) | |
SetValueT(Int32, T) |
Sets the value of the property with the given ID.
(Inherited from GameObject.) | |
SetValueT(String, T) |
Sets the value of the property with the given name.
(Inherited from GameObject.) | |
SetValueT(GamePropertyMetadataT, T) |
Set the value of the property for the given metadata.
(Inherited from GameObject.) | |
Show |
Opens a window and returns without waiting for the newly opened window to close.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Unload |
Unloads the content of the game object.
(Inherited from GameObject.) | |
Update |
Updates this game object.
(Inherited from GameObject.) | |
UpdateLayout |
Ensures that all visual child controls of this element are properly updated for layout.
(Inherited from UIControl.) |
Name | Description | |
---|---|---|
GetAncestors |
Gets the ancestors of the control in the visual tree.
(Defined by UIHelper.) | |
GetDescendants | Overloaded.
Gets the descendants of the control in the visual tree using a depth-first search.
(Defined by UIHelper.) | |
GetDescendants(Boolean) | Overloaded.
Gets the descendants of the control in the visual tree using either a depth-first or a
breadth-first search.
(Defined by UIHelper.) | |
GetLeaves |
Gets the leaves of the control in the visual tree.
(Defined by UIHelper.) | |
GetRoot |
Returns the root control of the visual tree.
(Defined by UIHelper.) | |
GetSelfAndAncestors |
Gets the control and its ancestors in the visual tree.
(Defined by UIHelper.) | |
GetSubtree | Overloaded.
Gets the subtree (the given control and all of its descendants in the visual tree) using a
depth-first search.
(Defined by UIHelper.) | |
GetSubtree(Boolean) | Overloaded.
Gets the subtree (the given control and all of its descendants in the visual tree) using
either a depth-first or a breadth-first search.
(Defined by UIHelper.) |
Name | Description | |
---|---|---|
CanDragPropertyId |
The ID of the CanDrag game object property.
| |
CanResizePropertyId |
The ID of the CanResize game object property.
| |
CloseButtonStylePropertyId |
The ID of the CloseButtonStyle game object property.
| |
ClosedEventId |
The ID of the Closed game object event.
| |
ClosingEventId |
The ID of the Closing game object event.
| |
DialogResultPropertyId |
The ID of the DialogResult game object property.
| |
HideOnClosePropertyId |
The ID of the HideOnClose game object property.
| |
IconPropertyId |
The ID of the Icon game object property.
| |
IconSourceRectanglePropertyId |
The ID of the IconSourceRectangle game object property.
| |
IconStylePropertyId |
The ID of the IconStyle game object property.
| |
IsActivePropertyId |
The ID of the IsActive game object property.
| |
IsModalPropertyId |
The ID of the IsModal game object property.
| |
ResizeBorderPropertyId |
The ID of the ResizeBorder game object property.
| |
TitlePropertyId |
The ID of the Title game object property.
| |
TitleTextBlockStylePropertyId |
The ID of the TitleTextBlockStyle game object property.
|
Name | Description | |
---|---|---|
ActualBounds |
Gets the actual bounding rectangle of the control (defined by ActualX,
ActualY, ActualWidth and ActualHeight).
(Inherited from UIControl.) | |
ActualHeight |
Gets the actual height of the control (computed in
Arrange(Vector2F, Vector2F)).
(Inherited from UIControl.) | |
ActualIsEnabled |
Gets a value indicating whether this control is actually enabled, taking into account the
IsEnabled flag and the state of the VisualParent.
(Inherited from UIControl.) | |
ActualIsVisible |
Gets a value indicating whether this control is actually visible, taking into account the
IsVisible flag and the state of the VisualParent.
(Inherited from UIControl.) | |
ActualWidth |
Gets the actual width of the control (computed in
Arrange(Vector2F, Vector2F)).
(Inherited from UIControl.) | |
ActualX |
Gets the actual X position of the top left corner of the control's bounds in screen
coordinates (computed in Arrange(Vector2F, Vector2F)).
(Inherited from UIControl.) | |
ActualY |
Gets the actual Y position of the top left corner of the control's bounds in screen
coordinates (computed in Arrange(Vector2F, Vector2F)).
(Inherited from UIControl.) | |
AllowedPlayer |
Gets or sets the LogicalPlayerIndex from which input is accepted.
(Inherited from UIControl.) | |
AutoUnfocus |
Gets or sets a value indicating whether this control clears the focus when the mouse clicks
another control than the currently focused control. This is a game object property.
(Inherited from UIControl.) | |
Background |
Gets or sets the background color.
This is a game object property.
(Inherited from UIControl.) | |
CanDrag |
Gets or sets a value indicating whether this window can dragged with the mouse.
This is a game object property.
| |
CanResize |
Gets or sets a value indicating whether this window can be resized with the mouse.
This is a game object property.
| |
ClipContent |
Gets or sets a value indicating whether the Content is clipped to the
ContentBounds or whether the Content can draw outside the
ContentBounds. This is a game object property.
(Inherited from ContentControl.) | |
CloseButtonStyle |
Gets or sets the style that is applied to the Close button.
This is a game object property.
| |
Content |
Gets or sets the content.
(Inherited from ContentControl.) | |
ContentBounds |
Gets the content bounds that define where the Content is drawn.
(Inherited from ContentControl.) | |
ContentStyle |
Gets or sets the style that is applied to the Content.
This is a game object property.
(Inherited from ContentControl.) | |
ContextMenu |
Gets or sets the context menu that should pop up when the control is right-clicked
(tap-and-hold on Windows Phone 7).
(Inherited from UIControl.) | |
Cursor |
Gets or sets the mouse cursor that should be displayed when the mouse is over this control.
(Inherited from UIControl.) | |
DesiredHeight |
Gets the desired height (including Margin) (which is computed in
Measure(Vector2F)).
(Inherited from UIControl.) | |
DesiredWidth |
Gets the desired width (including Margin) (which is computed in
Measure(Vector2F)).
(Inherited from UIControl.) | |
DialogResult |
Gets or sets the dialog result.
This is a game object property.
| |
Events |
Gets the game object events.
(Inherited from GameObject.) | |
Focusable |
Gets or sets a value indicating whether this UIControl can receive the input
focus. This is a game object property.
(Inherited from UIControl.) | |
FocusWhenMouseOver |
Gets or sets a value indicating whether the control automatically receives focus when the
mouse is over the control (without being clicked). This is a game object property.
(Inherited from UIControl.) | |
Font |
Gets or sets the font that is used if the control renders text.
This is a game object property.
(Inherited from UIControl.) | |
Foreground |
Gets or sets the foreground color.
This is a game object property.
(Inherited from UIControl.) | |
HasRenderTransform |
Gets a value indicating whether this control has a render transform that is not the
identity transformation.
(Inherited from UIControl.) | |
Height |
Gets or sets the user-defined height.
This is a game object property.
(Inherited from UIControl.) | |
HideOnClose |
Gets or sets a value indicating whether a this window is made in visible or totally
removed from the control tree when the window is closed. This is a game object property.
| |
HorizontalAlignment |
Gets or sets the horizontal alignment of this control.
This is a game object property.
(Inherited from UIControl.) | |
Icon |
Gets or sets the texture that contains the window icon.
This is a game object property.
| |
IconSourceRectangle |
Gets or sets the region of the Icon texture that contains the icon.
This is a game object property.
| |
IconStyle | ||
InputService |
Gets the IInputService.
(Inherited from UIControl.) | |
IsActive |
Gets a value indicating whether this window is the currently active window.
This is a game object property.
| |
IsArrangeValid |
Gets a value indicating whether the Arrange(Vector2F, Vector2F) results are
up-to-date.
(Inherited from UIControl.) | |
IsEnabled |
Gets or sets a value indicating whether this control is enabled.
This is a game object property.
(Inherited from UIControl.) | |
IsFocused |
Gets a value indicating whether this control has the input focus.
This is a game object property.
(Inherited from UIControl.) | |
IsFocusScope |
Gets or sets a value indicating whether this control is a focus scope.
This is a game object property.
(Inherited from UIControl.) | |
IsFocusWithin |
Gets (or sets) a value indicating whether the focus is on this control or on any of
the visual children.
(Inherited from UIControl.) | |
IsLoaded |
Gets a value indicating whether the content of this object was loaded.
(Inherited from GameObject.) | |
IsMeasureValid |
Gets a value indicating whether the Measure(Vector2F) results
(DesiredWidth and DesiredHeight) are up-to-date.
(Inherited from UIControl.) | |
IsModal |
Gets or sets a value indicating whether this window is a modal dialog.
This is a game object property.
| |
IsMouseDirectlyOver |
Gets a value indicating whether the mouse is over this control and not over a visual child
control.
(Inherited from UIControl.) | |
IsMouseOver |
Gets or sets a value indicating whether the mouse is over this control or over a visual
child. This is a game object property.
(Inherited from UIControl.) | |
IsVisible |
Gets or sets a value indicating whether this control is visible.
This is a game object property.
(Inherited from UIControl.) | |
IsVisualValid |
Gets a value indicating whether the cached RenderData is up-to-date.
(Inherited from UIControl.) | |
Margin |
Gets or sets the margin.
This is a game object property.
(Inherited from UIControl.) | |
MaxHeight |
Gets or sets the maximal height of the control.
This is a game object property.
(Inherited from UIControl.) | |
MaxWidth |
Gets or sets the maximal width of the control.
This is a game object property.
(Inherited from UIControl.) | |
MinHeight |
Gets or sets the minimal height of the control.
This is a game object property.
(Inherited from UIControl.) | |
MinWidth |
Gets or sets the minimal width of the control.
This is a game object property.
(Inherited from UIControl.) | |
Name |
Gets or sets the name.
(Inherited from GameObject.) | |
Opacity |
Gets or sets the opacity.
This is a game object property.
(Inherited from UIControl.) | |
Owner |
Gets the owner of this window that was specified in Show(UIControl) (typically a
UIScreen).
| |
Padding |
Gets or sets the padding.
This is a game object property.
(Inherited from UIControl.) | |
Properties |
Gets the game object properties.
(Inherited from GameObject.) | |
RenderData |
Gets or sets the cached renderer data.
(Inherited from UIControl.) | |
RendererInfo | Obsolete.
Gets or sets the cached renderer data.
(Inherited from UIControl.) | |
RenderRotation |
Gets or sets the rotation of the RenderTransform.
This is a game object property.
(Inherited from UIControl.) | |
RenderScale |
Gets or sets the scale of the RenderTransform.
This is a game object property.
(Inherited from UIControl.) | |
RenderTransform |
Gets the render transformation.
(Inherited from UIControl.) | |
RenderTransformOrigin |
Gets or sets the relative origin of the RenderTransform.
This is a game object property.
(Inherited from UIControl.) | |
RenderTranslation |
Gets or sets the translation of the RenderTransform.
This is a game object property.
(Inherited from UIControl.) | |
ResizeBorder |
Gets or sets the dimensions of the window border where resize operations can start.
This is a game object property.
| |
Screen |
Gets the UIScreen.
(Inherited from UIControl.) | |
Style |
Gets or sets the style.
(Inherited from UIControl.) | |
Tag | Obsolete.
Gets or sets a user-defined tag.
(Inherited from UIControl.) | |
Template |
Gets or sets the template.
(Inherited from GameObject.) | |
Title |
Gets or sets the window title that is visible in the caption bar.
This is a game object property.
| |
TitleTextBlockStyle | ||
ToolTip |
Gets or sets the tool tip.
This is a game object property.
(Inherited from UIControl.) | |
UIService |
Gets the IUIService.
(Inherited from UIControl.) | |
UserData |
Gets or sets user-defined data.
(Inherited from UIControl.) | |
VerticalAlignment |
Gets or sets the vertical alignment of this control.
This is a game object property.
(Inherited from UIControl.) | |
VisualChildren |
Gets the visual children.
(Inherited from UIControl.) | |
VisualParent |
Gets the visual parent.
(Inherited from UIControl.) | |
VisualState |
Gets the visual state of the control as string.
(Overrides UIControlVisualState.) | |
Width |
Gets or sets the user-defined width.
This is a game object property.
(Inherited from UIControl.) | |
X |
Gets or sets the x-position offset of the control. (Use this only for controls in a
Canvas or under the UIScreen.) This is a game object property.
(Inherited from UIControl.) | |
Y |
Gets or sets the y-position offset of the control. (Use this only for controls in a
Canvas or under the UIScreen.) This is a game object property.
(Inherited from UIControl.) |
Name | Description | |
---|---|---|
Closed |
Occurs when the window was closed using the Close method.
This is a game object event.
| |
Closing |
Occurs when the window is closing. Allows to cancel the closing operation.
This is a game object event.
| |
InputProcessed |
Occurs after the device input was processed.
(Inherited from UIControl.) | |
InputProcessing |
Occurs before the device input is processed.
(Inherited from UIControl.) | |
PropertyChanged |
Occurs when a property value has changed.
(Inherited from GameObject.) | |
TemplateChanged |
Occurs when the Template changed.
(Inherited from GameObject.) |
Name | Description | |
---|---|---|
INotifyPropertyChangedPropertyChanged |
Occurs when a property value has changed.
(Inherited from GameObject.) | |
IAnimatableObjectGetAnimatablePropertyT |
Gets the property with given name and type which can be animated.
(Inherited from GameObject.) | |
IAnimatableObjectGetAnimatedProperties |
Gets either the properties which are currently animated, or all properties which can be
animated. (See remarks.)
(Inherited from GameObject.) |
A window is ContentControl. The Content is usually a Panel. Besides the Content the window contains an Icon, a Title and a Close button.
The window can be dragged with the mouse if CanDrag is . A dragging operation starts when the user clicks any part of the window (except over nested controls). The window can be resized with the mouse if CanResize is . A resize operation starts when the user clicks the border of the window. ResizeBorder defines the size of the border where resize operations can start. For windows that can be dragged or resized, use only top/left for the VerticalAlignment and HorizontalAlignment.
Visual States: The VisualStates of this control are: "Disabled", "Default", "Active"
private void ShowMessageBox(UIScreen screen, string title, string message) { // ----- Create the message box. var text = new TextBlock { Text = message, Margin = new Vector4F(4), HorizontalAlignment = HorizontalAlignment.Center, }; var button = new Button { Content = new TextBlock { Text = "Ok" }, IsCancel = true, // Cancel buttons are clicked when the user presses ESC (or BACK or B on the gamepad). IsDefault = true, // Default buttons are clicked when the user presses ENTER or SPACE (or START or A on the gamepad). Margin = new Vector4F(4), Width = 60, HorizontalAlignment = HorizontalAlignment.Center, }; var stackPanel = new StackPanel { Margin = new Vector4F(4) }; stackPanel.Children.Add(text); stackPanel.Children.Add(button); var window = new Window { CanResize = false, IsModal = true, // Modal dialogs consume all input until the window is closed. Content = stackPanel, MinHeight = 0, Title = title, }; button.Click += (s, e) => window.Close(); // ----- Show the window in the center of the screen. // First, we need to open the window. window.Show(screen); // The window is now part of the visual tree of controls and can be measured. (The // window does not have a fixed size. Window.Width and Window.Height are NaN. The // size is calculated automatically depending on its content.) window.Measure(new Vector2F(float.PositiveInfinity)); // Measure() computes DesiredWidth and DesiredHeight. With this info we can center the // window on the screen. window.X = screen.ActualWidth / 2 - window.DesiredWidth / 2; window.Y = screen.ActualHeight / 2 - window.DesiredHeight / 2; }