WindowControl Class

[TemplateVisualState(Name = "Active", GroupName = "ActiveStates")]
[TemplateVisualState(Name = "Inactive", GroupName = "ActiveStates")]
[TemplateVisualState(Name = "FrameHidden", GroupName = "FrameStates")]
[TemplateVisualState(Name = "FrameVisible", GroupName = "FrameStates")]
[TemplateVisualState(Name = "Editable", GroupName = "ReadOnlyStates")]
[TemplateVisualState(Name = "ReadOnly", GroupName = "ReadOnlyStates")]
[TemplateVisualState(Name = "Maximized", GroupName = "WindowStates")]
[TemplateVisualState(Name = "Minimized", GroupName = "WindowStates")]
[TemplateVisualState(Name = "Restored", GroupName = "WindowStates")]
[TemplatePart(Name = "PART_Icon", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "PART_TitleBar", Type = typeof(FrameworkElement))]
public class WindowControl : ContentControl

public WindowControl()

public bool CanClose { get; set; }

Property Value

bool:

true if the window can close; otherwise, false. The default value is true.

public ICommand CloseCommand { get; }

Property Value

ICommand:

The ICommand that can close the window.

public object ContextContent { get; set; }

Property Value

object:

The context content that is displayed on the title bar next to the title. The default value is null.

public DataTemplate ContextContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the ContextContent. The default value is null.

public DataTemplateSelector ContextContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the ContextContent. The default value is null.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

The CornerRadius of the window. The default value is 0.0.

public bool HasCloseButton { get; set; }

Property Value

bool:

true if the window is capable of displaying a close button; otherwise, false. The default value is true.

public bool HasDropShadow { get; set; }

Property Value

bool:

true if the window has a drop shadow; otherwise, false. The default value is false.

public bool HasIcon { get; set; }

Property Value

bool:

true if the window is capable of displaying an icon; otherwise, false. The default value is true.

public bool HasMaximizeButton { get; set; }

Property Value

bool:

true if the window is capable of displaying a maximize button; otherwise, false. The default value is true.

public bool HasMinimizeButton { get; set; }

Property Value

bool:

true if the window is capable of displaying a minimize button; otherwise, false. The default value is true.

public bool HasRestoreButton { get; set; }

Property Value

bool:

true if the window is capable of displaying a restore button; otherwise, false. The default value is true.

public bool HasTitleBar { get; set; }

Property Value

bool:

true if the window is capable of displaying a title bar; otherwise, false. The default value is true.

public ImageSource Icon { get; set; }

Property Value

ImageSource:

The ImageSource displayed as the window icon. The default value is null.

public bool IsActive { get; protected set; }

Property Value

bool:

true if the window is currently active; otherwise, false.

public bool IsCloseButtonVisible { get; }

Property Value

bool:

true if the window's close button is visible; otherwise, false. The default value is true.

public bool IsMaximizeButtonVisible { get; }

Property Value

bool:

true if the window's maximize button is visible; otherwise, false. The default value is false.

public bool IsMaximizedFrameVisible { get; set; }

Property Value

bool:

true if the frame should be displayed when the window is maximized; otherwise, false. The default value is true.

public bool IsMinimizeButtonVisible { get; }

Property Value

bool:

true if the window's minimize button is visible; otherwise, false. The default value is false.

public bool IsMoving { get; }

Property Value

bool:

true if the window is currently being dragged to move its location; otherwise, false.

public bool IsReadOnly { get; set; }

Property Value

bool:

true if the window's contents are read-only; otherwise, false. The default value is false.

public bool IsResizing { get; }

Property Value

bool:

true if the window is currently being dragged to alter its size; otherwise, false.

public bool IsRestoreButtonVisible { get; }

Property Value

bool:

true if the window's restore button is visible; otherwise, false. The default value is false.

public double Left { get; set; }

Property Value

double:

The position of the window's left edge, in relation to its container.

public ICommand MaximizeCommand { get; }

Property Value

ICommand:

The ICommand that can maximize the window.

public ICommand MinimizeCommand { get; }

Property Value

ICommand:

The ICommand that can minimize the window.

public DataTemplate ReadOnlyContextContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to assign to ContextContentTemplate when the IsReadOnly property is true.

public ResizeMode ResizeMode { get; set; }

Property Value

ResizeMode:

A ResizeMode indicating how the window is able to resize. The default value is CanResize.

public ICommand RestoreCommand { get; }

Property Value

ICommand:

The ICommand that can restore the window.

public Rect RestoredBounds { get; set; }

Property Value

Rect:

The bounds of this window when in a 'restored' state.

public int ShadowElevation { get; set; }

Property Value

int:

The shadow elevation. The default value is 8.

Remarks

Set this property to 0 to disable the shadow.

[Localizability(LocalizationCategory.Title)]
public string Title { get; set; }

Property Value

string:

The title of the window.

public FontWeight TitleBarFontWeight { get; set; }

Property Value

FontWeight:

The FontWeight of the title. The default value is Normal.

public double Top { get; set; }

Property Value

double:

The position of the window's top edge, in relation to its container.

public WindowState WindowState { get; set; }

Property Value

WindowState:

A WindowState indicating the current state of the window. The default value is Normal.

public virtual bool Activate()

Returns

bool:

true if the window was successfully activated; otherwise, false.

public void Close()

public void DragMove(InputPointerButtonEventArgs e)

Parameter	Type	Description
e	InputPointerButtonEventArgs	The InputPointerButtonEventArgs that can wrap a platform-specific input event args instance.

Remarks

The primary button of the pointer in the event arguments must be pressed down when calling this method. The pointer will be captured.

public virtual Rect GetAdjustedBounds(Rect bounds, ResizeOperation resizeOperation)

Parameter	Type	Description
bounds	Rect	The bounds to examine.
resizeOperation	ResizeOperation	The active resize operation.

Returns

Rect:

The adjusted bounds.

public ResizeOperation HitTestResizeOperation(Point point)

Parameter	Type	Description
point	Point	The System.Windows.Point, in control coordinates, to hit test.

Returns

ResizeOperation:

The resize operation that can be caused by dragging at the System.Windows.Point.

protected virtual void OnActivated(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

public override void OnApplyTemplate()

protected virtual void OnClosed(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnClosing(CancelRoutedEventArgs e)

Parameter	Type	Description
e	CancelRoutedEventArgs	A CancelRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

protected virtual void OnDeactivated(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnDragMoved(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnDragMoving(CancelRoutedEventArgs e)

Parameter	Type	Description
e	CancelRoutedEventArgs	A CancelRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnDragResized(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnDragResizing(CancelRoutedEventArgs e)

Parameter	Type	Description
e	CancelRoutedEventArgs	A CancelRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains data related to this event.

protected virtual void OnLocationChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains data related to this event.

protected virtual void OnOpened(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnStateChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	A RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnTitleBarDoubleTapped(CancelRoutedEventArgs e)

Parameter	Type	Description
e	CancelRoutedEventArgs	A CancelRoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnTitleBarMenuOpening(DockingMenuEventArgs e)

Parameter	Type	Description
e	DockingMenuEventArgs	A DockingMenuEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

public void Show()

public void ToggleWindowState()

Remarks

This method is generally called when the title bar is double-tapped.

public event RoutedEventHandler Activated

Event Type

RoutedEventHandler

public event RoutedEventHandler Closed

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> Closing

Event Type

EventHandler<CancelRoutedEventArgs>

public event RoutedEventHandler Deactivated

Event Type

RoutedEventHandler

public event RoutedEventHandler DragMoved

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> DragMoving

Event Type

EventHandler<CancelRoutedEventArgs>

public event RoutedEventHandler DragResized

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> DragResizing

Event Type

EventHandler<CancelRoutedEventArgs>

public event RoutedEventHandler LocationChanged

Event Type

RoutedEventHandler

public event RoutedEventHandler Opened

Event Type

RoutedEventHandler

public event RoutedEventHandler StateChanged

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> TitleBarDoubleTapped

Event Type

EventHandler<CancelRoutedEventArgs>

public event EventHandler<DockingMenuEventArgs> TitleBarMenuOpening

Event Type

EventHandler<DockingMenuEventArgs>

public static readonly RoutedEvent ActivatedEvent

public static readonly DependencyProperty CanCloseProperty

public static readonly RoutedEvent ClosedEvent

public static readonly RoutedEvent ClosingEvent

public static readonly DependencyProperty ContextContentProperty

public static readonly DependencyProperty ContextContentTemplateProperty

public static readonly DependencyProperty ContextContentTemplateSelectorProperty

public static readonly DependencyProperty CornerRadiusProperty

public static readonly RoutedEvent DeactivatedEvent

public static readonly RoutedEvent DragMovedEvent

public static readonly RoutedEvent DragMovingEvent

public static readonly RoutedEvent DragResizedEvent

public static readonly RoutedEvent DragResizingEvent

public static readonly DependencyProperty HasCloseButtonProperty

public static readonly DependencyProperty HasDropShadowProperty

public static readonly DependencyProperty HasIconProperty

public static readonly DependencyProperty HasMaximizeButtonProperty

public static readonly DependencyProperty HasMinimizeButtonProperty

public static readonly DependencyProperty HasRestoreButtonProperty

public static readonly DependencyProperty HasTitleBarProperty

public static readonly DependencyProperty IconProperty

public static readonly DependencyProperty IsActiveProperty

public static readonly DependencyProperty IsCloseButtonVisibleProperty

public static readonly DependencyProperty IsMaximizeButtonVisibleProperty

public static readonly DependencyProperty IsMaximizedFrameVisibleProperty

public static readonly DependencyProperty IsMinimizeButtonVisibleProperty

public static readonly DependencyProperty IsMovingProperty

public static readonly DependencyProperty IsReadOnlyProperty

public static readonly DependencyProperty IsResizingProperty

public static readonly DependencyProperty IsRestoreButtonVisibleProperty

public static readonly DependencyProperty LeftProperty

public static readonly RoutedEvent LocationChangedEvent

public static readonly RoutedEvent OpenedEvent

public static readonly DependencyProperty ReadOnlyContextContentTemplateProperty

public static readonly DependencyProperty ResizeModeProperty

public static readonly DependencyProperty RestoredBoundsProperty

public static readonly DependencyProperty ShadowElevationProperty

public static readonly RoutedEvent StateChangedEvent

public static readonly RoutedEvent TitleBarDoubleTappedEvent

public static readonly DependencyProperty TitleBarFontWeightProperty

public static readonly RoutedEvent TitleBarMenuOpeningEvent

public static readonly DependencyProperty TitleProperty

public static readonly DependencyProperty TopProperty

public static readonly DependencyProperty WindowStateProperty