ChildWindow Class

Provides a window that can be displayed over a parent window and blocks interaction with the parent window.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        System.Windows.Controls.Control
          System.Windows.Controls.ContentControl
            System.Windows.Controls.ChildWindow

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls (in System.Windows.Controls.dll)

Syntax

'Declaration
<TemplatePartAttribute(Name := "Overlay", Type := GetType(Panel))> _
<TemplatePartAttribute(Name := "ContentRoot", Type := GetType(FrameworkElement))> _
<TemplatePartAttribute(Name := "CloseButton", Type := GetType(ButtonBase))> _
<TemplatePartAttribute(Name := "ContentPresenter", Type := GetType(FrameworkElement))> _
<TemplatePartAttribute(Name := "Chrome", Type := GetType(FrameworkElement))> _
<TemplateVisualStateAttribute(Name := "Closed", GroupName := "WindowStates")> _
<TemplatePartAttribute(Name := "Root", Type := GetType(FrameworkElement))> _
<TemplateVisualStateAttribute(Name := "Open", GroupName := "WindowStates")> _
Public Class ChildWindow _
    Inherits ContentControl
[TemplatePartAttribute(Name = "Overlay", Type = typeof(Panel))]
[TemplatePartAttribute(Name = "ContentRoot", Type = typeof(FrameworkElement))]
[TemplatePartAttribute(Name = "CloseButton", Type = typeof(ButtonBase))]
[TemplatePartAttribute(Name = "ContentPresenter", Type = typeof(FrameworkElement))]
[TemplatePartAttribute(Name = "Chrome", Type = typeof(FrameworkElement))]
[TemplateVisualStateAttribute(Name = "Closed", GroupName = "WindowStates")]
[TemplatePartAttribute(Name = "Root", Type = typeof(FrameworkElement))]
[TemplateVisualStateAttribute(Name = "Open", GroupName = "WindowStates")]
public class ChildWindow : ContentControl
<sdk:ChildWindow ...>
  singleObject
</sdk:ChildWindow>
-or-
<sdk:ChildWindow ...>stringContent</sdk:ChildWindow>

XAML Values

  • singleObject
    A single object element that declares the content. Typically this is a class that can support additional content as child elements, such as a Panel class.

  • stringContent
    A string that is displayed as content through the default template ContentPresenter. For more information, see "String Content of a ContentControl" section of ContentControl.

The ChildWindow type exposes the following members.

Constructors

  Name Description
Public method ChildWindow Initializes a new instance of the ChildWindow class.

Top

Properties

  Name Description
Public property ActualHeight Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public property ActualWidth Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public property AllowDrop Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.)
Public property Background Gets or sets a brush that provides the background of the control. (Inherited from Control.)
Public property BorderBrush Gets or sets a brush that describes the border background of a control. (Inherited from Control.)
Public property BorderThickness Gets or sets the border thickness of a control. (Inherited from Control.)
Public property CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public property CharacterSpacing Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.)
Public property Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public property Content Gets or sets the value of the ContentControl dependency property. (Inherited from ContentControl.)
Public property ContentTemplate Gets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl.)
Public property Cursor Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public property DataContext Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Protected property DefaultStyleKey Gets or sets the key that references the default style for the control. (Inherited from Control.)
Public property DesiredSize Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public property DialogResult Gets or sets a value that indicates whether the ChildWindow was accepted or canceled.
Public property Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public property Effect Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
Public property FlowDirection Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public property FontFamily Gets or sets the font used to display text in the control. (Inherited from Control.)
Public property FontSize Gets or sets the size of the text in this control. (Inherited from Control.)
Public property FontStretch Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.)
Public property FontStyle Gets or sets the style in which the text is rendered. (Inherited from Control.)
Public property FontWeight Gets or sets the thickness of the specified font. (Inherited from Control.)
Public property Foreground Gets or sets a brush that describes the foreground color. (Inherited from Control.)
Public property HasCloseButton Gets or sets a value that indicates whether the ChildWindow has a close button.
Public property Height Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public property HorizontalAlignment Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.)
Public property HorizontalContentAlignment Gets or sets the horizontal alignment of the control's content. (Inherited from Control.)
Public property IsEnabled Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control.)
Public property IsHitTestVisible Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public property IsTabStop Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.)
Public property Language Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public property Margin Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MaxHeight Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MaxWidth Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MinHeight Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MinWidth Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property Name Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.)
Public property Opacity Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public property OpacityMask Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public property OverlayBrush Gets or sets the visual brush that is used to cover the parent window when the child window is open.
Public property OverlayOpacity Gets or sets the opacity of the overlay brush that is used to cover the parent window when the child window is open.
Public property Padding Gets or sets the padding inside a control. (Inherited from Control.)
Public property Parent Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public property Projection Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public property RenderSize Gets the final render size of a UIElement. (Inherited from UIElement.)
Public property RenderTransform Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public property RenderTransformOrigin Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Public property Resources Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.)
Public property Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public property TabIndex Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.)
Public property TabNavigation Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.)
Public property Tag Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public property Template Gets or sets a control template. (Inherited from Control.)
Public property Title Gets or sets the title of the ChildWindow.
Public property Triggers Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public property UseLayoutRounding Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.)
Public property VerticalAlignment Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.)
Public property VerticalContentAlignment Gets or sets the vertical alignment of the control's content. (Inherited from Control.)
Public property Visibility Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
Public property Width Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)

Top

Methods

  Name Description
Public method AddHandler Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
Public method ApplyTemplate Loads the relevant control template so that its parts can be referenced. (Inherited from Control.)
Public method Arrange Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.)
Protected method ArrangeOverride Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
Public method CaptureMouse Sets mouse capture to a UIElement. (Inherited from UIElement.)
Public method CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public method ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public method Close Closes a ChildWindow.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public method Focus Attempts to set the focus on the control. (Inherited from Control.)
Public method GetAnimationBaseValue Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public method GetBindingExpression Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetTemplateChild Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
Public method InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public method Measure Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.)
Protected method MeasureOverride Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method OnApplyTemplate Builds the visual tree for the ChildWindow control when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate().)
Protected method OnClosed Raises the Closed event.
Protected method OnClosing Raises the Closing event.
Protected method OnContentChanged Called when the value of the Content property changes. (Inherited from ContentControl.)
Protected method OnCreateAutomationPeer Returns a ChildWindowAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().)
Protected method OnDragEnter Called before the DragEnter event occurs. (Inherited from Control.)
Protected method OnDragLeave Called before the DragLeave event occurs. (Inherited from Control.)
Protected method OnDragOver Called before the DragOver event occurs. (Inherited from Control.)
Protected method OnDrop Called before the Drop event occurs. (Inherited from Control.)
Protected method OnGotFocus Called before the GotFocus event occurs. (Inherited from Control.)
Protected method OnKeyDown Called before the KeyDown event occurs. (Inherited from Control.)
Protected method OnKeyUp Called before the KeyUp event occurs. (Inherited from Control.)
Protected method OnLostFocus Called before the LostFocus event occurs. (Inherited from Control.)
Protected method OnLostMouseCapture Called before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
Protected method OnMouseEnter Called before the MouseEnter event occurs. (Inherited from Control.)
Protected method OnMouseLeave Called before the MouseLeave event occurs. (Inherited from Control.)
Protected method OnMouseLeftButtonDown Called before the MouseLeftButtonDown event occurs. (Inherited from Control.)
Protected method OnMouseLeftButtonUp Called before the MouseLeftButtonUp event occurs. (Inherited from Control.)
Protected method OnMouseMove Called before the MouseMove event occurs. (Inherited from Control.)
Protected method OnMouseRightButtonDown Called before the MouseRightButtonDown event occurs. (Inherited from Control.)
Protected method OnMouseRightButtonUp Called before the MouseRightButtonUp event occurs. (Inherited from Control.)
Protected method OnMouseWheel Called before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
Protected method OnOpened This method is called every time a ChildWindow is displayed.
Protected method OnTextInput Called before the TextInput event occurs. (Inherited from Control.)
Protected method OnTextInputStart Called before the TextInputStart event occurs. (Inherited from Control.)
Protected method OnTextInputUpdate Called before the TextInputUpdate event occurs. (Inherited from Control.)
Public method ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public method ReleaseMouseCapture Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public method RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public method SetBinding Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public method SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public method Show Opens a ChildWindow and returns without waiting for the ChildWindow to close.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public method UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)

Top

Events

  Name Description
Public event BindingValidationError Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public event Closed Occurs when the ChildWindow is closed.
Public event Closing Occurs when the ChildWindow is closing.
Public event DataContextChanged Occurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public event DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public event DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public event DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public event Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public event GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Public event IsEnabledChanged Occurs when the IsEnabled property changes. (Inherited from Control.)
Public event KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public event KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public event LayoutUpdated Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
Public event Loaded Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public event LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement.)
Public event LostMouseCapture Occurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public event MediaCommand Occurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public event MouseEnter Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public event MouseLeave Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public event MouseLeftButtonDown Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public event MouseLeftButtonUp Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public event MouseMove Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public event MouseRightButtonDown Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public event MouseRightButtonUp Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.)
Public event MouseWheel Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public event SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public event TextInput Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public event TextInputStart Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public event TextInputUpdate Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public event Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)

Top

Fields

  Name Description
Public fieldStatic member HasCloseButtonProperty Identifies the HasCloseButton dependency property.
Public fieldStatic member OverlayBrushProperty Identifies the OverlayBrush dependency property.
Public fieldStatic member OverlayOpacityProperty Identifies the OverlayOpacity dependency property.
Public fieldStatic member TitleProperty Identifies the Title dependency property.

Top

Remarks

You can use a ChildWindow to direct a user’s attention to a particular activity in your application, such as entering data or viewing information. To display simple information to a user, you might consider using a Popup or MessageBox. Consider using a ChildWindow when you want greater customization, you want to block the parent window, or when you want to retrieve a DialogResult and other data from the popup window. A ChildWindow always displays in a modal popup that blocks user interaction with the underlying user interface.

The following illustration shows the parts of a ChildWindow.

ChildWindow Parts

ChildWindow parts

A ChildWindow has three distinct areas inside its Root part:

  • Overlay – the part of the child window that covers the parent window.

  • Chrome – the part of the child window which hosts the Title and CloseButton parts.

  • ContentRoot – the part of the child window which hosts application-specific content in its ContentPresenter part.

NoteNote:

The ChildWindow control includes the Overlay part, which covers the whole parent window. Therefore, when ChildWindow reports its size, it considers the size of the Overlay in addition to the size of the Chrome and ContentRoot parts.

You typically define a child window by creating a new class that derives from ChildWindow. Alternatively, you can instantiate a ChildWindow directly. A child window can be the child of another child window.

To display a child window, call the Show method. The Show method does not block the calling thread. This lets activity on the parent window, such as an animation, continue. However, user interaction with the parent window is not possible as long as the child window is open.

By default, a user can close a child window by clicking the close button in the title bar, or by pressing the CTRL+SHIFT+F4 key combination.

To close a child window programmatically, you can either set the DialogResult value or call the Close method. Setting the DialogResult value will automatically call the Close method to close the child window.

You can cancel the close action by handling the Closing event and setting the CancelEventArgs.Cancel property to true in the event handler. If the close action is canceled, the DialogResult value will be reset to nulla null reference (Nothing in Visual Basic).

To get the DialogResult value from a child window, handle the Closed event in the code-behind page of the calling window. In the Closed event handler, cast the sender parameter to a ChildWindow or a derived class to access the DialogResult property.

NoteNote:

The ChildWindow control is available as part of the libraries in the Silverlight Software Development Kit (SDK). For more information, see the Silverlight Tools.

To add a ChildWindow Control to a Visual Studio Project

To add a ChildWindow to a project in Visual Studio, complete the following steps:

  1. In Solution Explorer, select your Silverlight project.

  2. On the Project menu, click Add New Item. The Add New Item dialog box opens.

  3. In the Category pane, select Silverlight.

  4. In the Templates pane, select Silverlight Child Window

  5. Enter a name for the child window and click Add.

Customizing the ChildWindow Control

You can set the Title to be any object. This lets you create complex titles with text, graphics, and animations. If the object does not have a visual representation, the string representation of the object returned by the ToString method will be shown in the title bar. You can modify the appearance of the child window overlay area by setting the OverlayBrush and OverlayOpacity properties.

The default close button can be hidden by setting the HasCloseButton property to false. This can be useful if you want to prevent a user from dismissing the information displayed in the child window. For example, you might display a video message and then close the child window automatically when the video is finished. If the default close button is hidden, you should call the Close method in your code to close the child window or provide an alternative way for the user to close the child window.

You can customize a child window every time it is opened by overriding the OnOpened method. In the OnOpened method, apply conditional logic to set the properties of the child window.

To apply the same property settings to multiple ChildWindow controls, use the Style property. To change the visual structure and visual behavior of a ChildWindow, copy and modify its default style and template. For more information, see Control Customization. To apply a template to the whole ChildWindow control, including the overlay, chrome, and content areas, set the Template property. To apply a template to only chrome and content areas, set the ContentTemplate property.

Dependency properties for this control might be set by the default style of the control. If a dependency property for a ChildWindow is set by its default style, the property might change from its default value when the ChildWindow appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for ChildWindow from ChildWindow Styles and Templates.

NoteNote:

Setting a visual property will only have an effect if that property is both present in ChildWindow control's default template and is set using TemplateBinding. You can find a list of visual properties in the "Changing the Visual Structure of a Control" section of Customizing the Appearance of an Existing Control by Using a ControlTemplate.

Examples

The following code example demonstrates how to use a child window to get login credentials from a user. The LoginWindow class is derived from ChildWindow. In the main page of the application, the LoginWindow is instantiated and displayed when the login button is clicked. If the user submits their login credentials with incomplete information, a second ChildWindow is displayed with instructions for the user. When the user submits their login credentials, the LoginWindow is closed and the main page displays a greeting to the user.

Run this sample

The following XAML and code show the child window.

<!-- NOTE: 
  By convention, the sdk prefix indicates a URI-based XAML namespace declaration 
  for Silverlight SDK client libraries. This namespace declaration is valid for 
  Silverlight 4 only. In Silverlight 3, you must use individual XAML namespace 
  declarations for each CLR assembly and namespace combination outside the scope 
  of the default Silverlight XAML namespace. For more information, see the help 
  topic "Prefixes and Mappings for Silverlight Libraries". 
-->
<sdk:ChildWindow x:Class="ChildWindowLogin.LoginWindow"
           xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
           xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
           xmlns:sdk="http://schemas.microsoft.com/winfx/2006/xaml/presentation/sdk"
           Width="300" Height="200" 
           Title="Login Window"
           Closing="ChildWindow_Closing">
    <Grid x:Name="LayoutRoot" Margin="2">
        <Grid.RowDefinitions>
            <RowDefinition />
            <RowDefinition Height="Auto" />
        </Grid.RowDefinitions>
        <StackPanel>
            <TextBlock Text="Name" />
            <TextBox x:Name="nameBox"/>
            <TextBlock Text="Password" />
            <PasswordBox x:Name="passwordBox"/>
        </StackPanel>
        <Button x:Name="CancelButton" Content="Cancel" Click="CancelButton_Click" 
                Width="75" Height="23" HorizontalAlignment="Right" Margin="0,12,0,0" 
                Grid.Row="1" />
        <Button x:Name="OKButton" Content="OK" Click="OKButton_Click" 
                Width="75" Height="23" HorizontalAlignment="Right" Margin="0,12,79,0" 
                Grid.Row="1" />
    </Grid>
</sdk:ChildWindow>
Partial Public Class LoginWindow
    Inherits ChildWindow

    Public Sub New()
        InitializeComponent()
    End Sub
    Private Sub OKButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs) Handles OKButton.Click
        Me.DialogResult = True
    End Sub

    Private Sub CancelButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs) Handles CancelButton.Click
        Me.DialogResult = False
    End Sub
    Private Sub ChildWindow_Closing(ByVal sender As System.Object, ByVal e As System.ComponentModel.CancelEventArgs)
        If Me.DialogResult = True AndAlso _
                (Me.nameBox.Text = String.Empty OrElse Me.passwordBox.Password = String.Empty) Then
            e.Cancel = True
            Dim cw As New ChildWindow
            cw.Content = "Please enter name and password or click Cancel."
            cw.Show()
        End If
    End Sub
End Class
using System.Windows;
using System.Windows.Controls;

namespace ChildWindowLogin
{
    public partial class LoginWindow : ChildWindow
    {
        public LoginWindow()
        {
            InitializeComponent();
        }
        private void OKButton_Click(object sender, RoutedEventArgs e)
        {
            this.DialogResult = true;
        }

        private void CancelButton_Click(object sender, RoutedEventArgs e)
        {
            this.DialogResult = false;
        }
        private void ChildWindow_Closing(object sender, System.ComponentModel.CancelEventArgs e)
        {
            if (this.DialogResult == true && 
                    (this.nameBox.Text == string.Empty || this.passwordBox.Password == string.Empty))
            {
                e.Cancel = true;
                ChildWindow cw = new ChildWindow();
                cw.Content = "Please enter name and password or click Cancel.";
                cw.Show();
            }
        }
    }
}

The following XAML and code show the parent window that calls the child window.

<UserControl x:Class="ChildWindowLogin.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
    Width="300" Height="200">
    <Grid x:Name="LayoutRoot" Background="White">
        <StackPanel Margin="5">
            <Button Height="23" Width="100" HorizontalAlignment="Left"
                    Content="Log in" Click="Button_Click" />
            <TextBlock Name="helloTxt" />
        </StackPanel>
    </Grid>
</UserControl>
Partial Public Class MainPage
    Inherits UserControl

    Public Sub New()
        InitializeComponent()
    End Sub
    Private Sub Button_Click(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
        Dim loginWnd As New LoginWindow()
        AddHandler loginWnd.Closed, AddressOf loginWnd_Closed
        loginWnd.Show()
    End Sub
    Private Sub loginWnd_Closed(ByVal sender As System.Object, ByVal e As EventArgs)
        Dim lw As LoginWindow = CType(sender, LoginWindow)

        If lw.DialogResult = True AndAlso lw.nameBox.Text <> String.Empty Then
            Me.helloTxt.Text = "Hello " + lw.nameBox.Text
        ElseIf (lw.DialogResult = False) Then
            Me.helloTxt.Text = "Login canceled."
        End If
    End Sub
End Class
using System;
using System.Windows;
using System.Windows.Controls;

namespace ChildWindowLogin
{
    public partial class MainPage : UserControl
    {
        public MainPage()
        {
            InitializeComponent();
        }
        private void Button_Click(object sender, RoutedEventArgs e)
        {
            LoginWindow loginWnd = new LoginWindow();
            loginWnd.Closed += new EventHandler(loginWnd_Closed);
            loginWnd.Show();
        }
        void loginWnd_Closed(object sender, EventArgs e)
        {
            LoginWindow lw = (LoginWindow)sender;

            if (lw.DialogResult == true && lw.nameBox.Text != string.Empty)
            {
                this.helloTxt.Text = "Hello " + lw.nameBox.Text;
            }
            else if (lw.DialogResult == false)
            {
                this.helloTxt.Text = "Login canceled.";
            }
        }
    }
}

The following code example demonstrates how to use a child window as a splash screen. The SplashWindow class is derived from ChildWindow. In the main page of the application, the SplashWindow is instantiated and displayed when the page is loaded or when the button is clicked. The SplashWindow displays one of two videos that is randomly selected in the OnOpened method. It closes automatically when the video is finished. The splash window uses a custom OverlayBrush and does not have a close button.

Run this sample

The following XAML and code show the child window.

<!-- NOTE: 
  By convention, the sdk prefix indicates a URI-based XAML namespace declaration 
  for Silverlight SDK client libraries. This namespace declaration is valid for 
  Silverlight 4 only. In Silverlight 3, you must use individual XAML namespace 
  declarations for each CLR assembly and namespace combination outside the scope 
  of the default Silverlight XAML namespace. For more information, see the help 
  topic "Prefixes and Mappings for Silverlight Libraries". 
-->
<sdk:ChildWindow x:Class="ChildWindowSplash.SplashWindow"
           xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
           xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
           xmlns:sdk="http://schemas.microsoft.com/winfx/2006/xaml/presentation/sdk"
           Width="200" Height="150"
           HasCloseButton="False"
           OverlayBrush="{StaticResource overlayGradient}"
           OverlayOpacity="0.85">
    <Grid x:Name="LayoutRoot" Margin="2">
        <MediaElement x:Name="splashMedia" MediaEnded="splashMedia_MediaEnded"
                      Height="100" Margin="10" />
    </Grid>
</sdk:ChildWindow>
Partial Public Class SplashWindow
    Inherits ChildWindow

    Public Sub New()
        InitializeComponent()
    End Sub
    Private Sub splashMedia_MediaEnded(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
        Me.Close()
    End Sub
    Protected Overrides Sub OnOpened()
        MyBase.OnOpened()

        Dim generator As New Random
        Dim randomValue As Integer
        randomValue = generator.Next(0, 2)

        If randomValue = 1 Then
            Me.splashMedia.Source = New Uri("/Silverlight1.wmv", UriKind.RelativeOrAbsolute)
        Else
            Me.splashMedia.Source = New Uri("/Silverlight2.wmv", UriKind.RelativeOrAbsolute)
        End If
    End Sub
End Class
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;

namespace ChildWindowSplash
{
    public partial class SplashWindow : ChildWindow
    {
        public SplashWindow()
        {
            InitializeComponent();
        }
        private void splashMedia_MediaEnded(object sender, RoutedEventArgs e)
        {
            this.Close();
        }

        protected override void OnOpened()
        {
            base.OnOpened();

            Random random = new Random();
            if ((int)random.Next(0, 2) == 1)
            {
                this.splashMedia.Source = new Uri("/Silverlight1.wmv", UriKind.RelativeOrAbsolute); ;
            }
            else
                this.splashMedia.Source = new Uri("/Silverlight2.wmv", UriKind.RelativeOrAbsolute);
        }
    }
}

The following XAML and code show the parent window that calls the child window.

<UserControl x:Class="ChildWindowSplash.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
    Width="400" Height="300">
    <Grid x:Name="LayoutRoot" Background="White">
        <Button Content="Show Splash Window" Click="Button_Click" 
                Height="100" Width="200" Margin="10" />
    </Grid>
</UserControl>
Partial Public Class MainPage
    Inherits UserControl

    Public Sub New()
        InitializeComponent()
        AddHandler Me.Loaded, AddressOf MainPage_Loaded
    End Sub

    Private Sub Button_Click(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
        Dim splashWnd As New SplashWindow
        splashWnd.Show()
    End Sub

    Private Sub MainPage_Loaded(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
        Dim splashWnd As New SplashWindow
        splashWnd.Show()
    End Sub
End Class
using System.Windows;
using System.Windows.Controls;

namespace ChildWindowSplash
{
    public partial class MainPage : UserControl
    {
        public MainPage()
        {
            InitializeComponent();
            Loaded += new RoutedEventHandler(MainPage_Loaded);
        }

        void MainPage_Loaded(object sender, RoutedEventArgs e)
        {
            SplashWindow splashWnd = new SplashWindow();
            splashWnd.Show();
        }

        private void Button_Click(object sender, RoutedEventArgs e)
        {
            SplashWindow splashWnd = new SplashWindow();
            splashWnd.Show();
        }
    }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.