Class ChildWindow

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

Inheritance
System.Object
DependencyObject
UIElement
FrameworkElement
Control
ContentControl
ChildWindow
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Controls
Assembly: OpenSilver.dll
Syntax
[TemplatePart(Name = "Chrome", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "CloseButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "ContentPresenter", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "ContentRoot", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "Overlay", Type = typeof(Panel))]
[TemplatePart(Name = "Root", Type = typeof(FrameworkElement))]
public class ChildWindow : ContentControl, IControl, IFrameworkElement, IUIElement, IDependencyObject

Constructors

| Improve this Doc View Source

ChildWindow()

Initializes a new instance of the ChildWindow class.

Declaration
public ChildWindow()

Fields

| Improve this Doc View Source

HasCloseButtonProperty

Identifies the HasCloseButton dependency property.

Declaration
public static readonly DependencyProperty HasCloseButtonProperty
Field Value
Type Description
DependencyProperty

The identifier for the HasCloseButton dependency property.
| Improve this Doc View Source

IsModalProperty

Identifies the IsModal dependency property.

Declaration
public static readonly DependencyProperty IsModalProperty
Field Value
Type Description
DependencyProperty

The identifier for the IsModal dependency property.
| Improve this Doc View Source

OverlayBrushProperty

Identifies the OverlayBrush dependency property.

Declaration
public static readonly DependencyProperty OverlayBrushProperty
Field Value
Type Description
DependencyProperty

The identifier for the OverlayBrush dependency property.
| Improve this Doc View Source

OverlayOpacityProperty

Identifies the OverlayOpacity dependency property.

Declaration
public static readonly DependencyProperty OverlayOpacityProperty
Field Value
Type Description
DependencyProperty

The identifier for the OverlayOpacity dependency property.
| Improve this Doc View Source

TitleProperty

Identifies the Title dependency property.

Declaration
public static readonly DependencyProperty TitleProperty
Field Value
Type Description
DependencyProperty

The identifier for the Title dependency property.

Properties

| Improve this Doc View Source

DialogResult

Gets or sets a value indicating whether the ChildWindow was accepted or canceled.

Declaration
[TypeConverter(typeof(NullableBoolConverter))]
public bool? DialogResult { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

True if the child window was accepted; false if the child window was canceled. The default is null.
| Improve this Doc View Source

HasCloseButton

Gets or sets a value indicating whether the ChildWindow has a close button.

Declaration
public bool HasCloseButton { get; set; }
Property Value
Type Description
System.Boolean

True if the child window has a close button; otherwise, false. The default is true.
| Improve this Doc View Source

IsModal

Gets or sets a value indicating whether the ChildWindow is modal.

Declaration
public bool IsModal { get; set; }
Property Value
Type Description
System.Boolean
Exceptions
Type Condition
System.InvalidOperationException

The ChildWindow was open when attempting the modify IsModal.
| Improve this Doc View Source

OverlayBrush

Gets or sets the visual brush that is used to cover the parent window when the child window is open.

Declaration
public Brush OverlayBrush { get; set; }
Property Value
Type Description
Brush

The visual brush that is used to cover the parent window when the ChildWindow is open. The default is null.
| Improve this Doc View Source

OverlayOpacity

Gets or sets the opacity of the overlay brush that is used to cover the parent window when the child window is open.

Declaration
public double OverlayOpacity { get; set; }
Property Value
Type Description
System.Double

The opacity of the overlay brush that is used to cover the parent window when the ChildWindow is open. The default is 1.0.
| Improve this Doc View Source

Title

Gets or sets the title that is displayed in the frame of the ChildWindow.

Declaration
public object Title { get; set; }
Property Value
Type Description
System.Object

The title displayed at the top of the window. The default is null.

Methods

| Improve this Doc View Source

Close()

Closes a ChildWindow.

Declaration
public void Close()
| Improve this Doc View Source

OnApplyTemplate()

Builds the visual tree for the ChildWindow control when a new template is applied.

Declaration
public override void OnApplyTemplate()
Overrides
| Improve this Doc View Source

OnClosed(EventArgs)

Raises the Closed event.

Declaration
protected virtual void OnClosed(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The event data.
| Improve this Doc View Source

OnClosing(CancelEventArgs)

Raises the Closing event.

Declaration
protected virtual void OnClosing(CancelEventArgs e)
Parameters
Type Name Description
System.ComponentModel.CancelEventArgs e

The event data.
| Improve this Doc View Source

OnCreateAutomationPeer()

Returns a ChildWindowAutomationPeer for use by the Silverlight automation infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type Description
AutomationPeer

ChildWindowAutomationPeer for the ChildWindow object.
Overrides
| Improve this Doc View Source

OnOpened()

This method is called every time a ChildWindow is displayed.

Declaration
protected virtual void OnOpened()
| Improve this Doc View Source

Show()

Opens a ChildWindow and returns without waiting for the ChildWindow to close.

Declaration
public void Show()
Exceptions
Type Condition
System.InvalidOperationException

The child window is already in the visual tree.
| Improve this Doc View Source

ShowAndWait()

Opens a ChildWindow and waits for the ChildWindow to close.

Declaration
public Task ShowAndWait()
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.InvalidOperationException

The child window is already in the visual tree.

Events

| Improve this Doc View Source

Closed

Occurs when the ChildWindow is closed.

Declaration
public event EventHandler Closed
Event Type
Type Description
System.EventHandler
| Improve this Doc View Source

Closing

Occurs when the ChildWindow is closing.

Declaration
public event EventHandler<CancelEventArgs> Closing
Event Type
Type Description
System.EventHandler<System.ComponentModel.CancelEventArgs>

Extension Methods