DockingWindow Class

public abstract class DockingWindow : ContentControl, IDockTarget

protected DockingWindow(bool isContainerForItem = false)

Parameter	Type	Description
isContainerForItem	bool	Whether the window has been auto-created as a container for an item.

public ICommand ActivateCommand { get; }

Property Value

ICommand

public bool? CanAttach { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global DockSite setting.

public bool CanAttachResolved { get; protected set; }

Property Value

bool

public bool CanBecomeDocumentResolved { get; protected set; }

Property Value

bool

public bool? CanClose { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global DockSite setting.

public bool CanCloseResolved { get; protected set; }

Property Value

bool

public bool? CanDock { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global DockSite setting.

public bool CanDockResolved { get; protected set; }

Property Value

bool

public bool? CanDragTab { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global DockSite setting.

public bool CanDragTabResolved { get; protected set; }

Property Value

bool

public bool? CanDragToLinkedDockSites { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global DockSite setting.

public bool CanDragToLinkedDockSitesResolved { get; protected set; }

Property Value

bool

public bool? CanFloat { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global DockSite setting.

public bool CanFloatResolved { get; protected set; }

Property Value

bool

public bool CanMoveToNewHorizontalContainer { get; }

Property Value

bool

Remarks

This property returns true when the window is currently within a tabbed MDI container that has more than one docking window.

public bool CanMoveToNewVerticalContainer { get; }

Property Value

bool

Remarks

This property returns true when the window is currently within a tabbed MDI container that has more than one docking window.

public bool CanMoveToNextContainer { get; }

Property Value

bool

Remarks

This property returns true when the window is currently within a tabbed MDI container and there is another tabbed MDI container after it in the layout.

public bool CanMoveToPreviousContainer { get; }

Property Value

bool

Remarks

This property returns true when the window is currently within a tabbed MDI container and there is another tabbed MDI container before it in the layout.

public bool CanMoveToPrimaryMdiHost { get; }

Property Value

bool

public bool CanSerialize { get; set; }

Property Value

bool

Remarks

When false, this property designates that the window should not be included in serialized layout information.

public bool? CanStandardMdiMaximize { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global StandardMdiHost setting.

public bool CanStandardMdiMaximizeResolved { get; }

Property Value

bool

public bool? CanStandardMdiMinimize { get; set; }

Property Value

bool?

Remarks

If set to null, the resolved value will use the global StandardMdiHost setting.

public bool CanStandardMdiMinimizeResolved { get; }

Property Value

bool

public ICommand CloseAllInContainerCommand { get; }

Property Value

ICommand

public ICommand CloseCommand { get; }

Property Value

ICommand

public ICommand CloseOthersCommand { get; }

Property Value

ICommand

public Size ContainerDockedSize { get; set; }

Property Value

Size

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public Size ContainerMaxSize { get; set; }

Property Value

Size

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public Size ContainerMaxSizeResolved { get; }

Property Value

Size

public Size ContainerMinSize { get; set; }

Property Value

Size

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public Size ContainerMinSizeResolved { get; }

Property Value

Size

[Localizability(LocalizationCategory.ToolTip)]
public string? Description { get; set; }

Property Value

string

public ICommand DestroyCommand { get; }

Property Value

ICommand

public DockHost? DockHost { get; }

Property Value

DockHost

Remarks

The primary dock host is the one directly within the DockSite hierarchy. Floating dock hosts are top-level containers that are external to the DockSite hierarchy's primary dock host.

public DockSite? DockSite { get; }

Property Value

DockSite

public ICommand FloatAllInContainerCommand { get; }

Property Value

ICommand

public ICommand FloatCommand { get; }

Property Value

ICommand

public ImageSource? ImageSource { get; set; }

Property Value

ImageSource

public bool IsActive { get; set; }

Property Value

bool

Remarks

This property is set to true when the ActiveWindow is this window.

public bool IsContainerForItem { get; }

Property Value

bool

public bool IsFloating { get; set; }

Property Value

bool

public bool IsOpen { get; set; }

Property Value

bool

public bool IsSelected { get; set; }

Property Value

bool

Remarks

The container is generally a TabbedMdiContainer, StandardMdiHost, or ToolWindowContainer.

public DateTime LastActiveDateTime { get; }

Property Value

DateTime

public ICommand MoveToMdiCommand { get; }

Property Value

ICommand

public ICommand MoveToNewHorizontalContainerCommand { get; }

Property Value

ICommand

public ICommand MoveToNewVerticalContainerCommand { get; }

Property Value

ICommand

public ICommand MoveToNextContainerCommand { get; }

Property Value

ICommand

public ICommand MoveToPreviousContainerCommand { get; }

Property Value

ICommand

public ICommand MoveToPrimaryMdiHostCommand { get; }

Property Value

ICommand

public ICommand OpenCommand { get; }

Property Value

ICommand

public DockingWindowContainerBase? ParentContainer { get; }

Property Value

DockingWindowContainerBase

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

[Localizability(LocalizationCategory.NeverLocalize)]
public string? SerializationId { get; set; }

Property Value

string

Remarks

When deserializing a saved layout, the layout information has to be matched up with related windows, which is done via this property. Each window needs to have a unique serialization ID, specified by this property. When this property is null, the window's Name property will be used instead. While the Name property must conform to standard .NET identifier syntax, this property can use any characters in its value.

public ICommand SetTabbedMdiLayoutKindCommand { get; }

Property Value

ICommand

public SizeToContentModes SizeToContentModes { get; set; }

Property Value

SizeToContentModes:

The default value is None.

public Rect StandardMdiBounds { get; set; }

Property Value

Rect

public DataTemplate? StandardMdiTitleBarContextContentTemplate { get; set; }

Property Value

DataTemplate

public WindowState StandardMdiWindowState { get; set; }

Property Value

WindowState

public DockingWindowState State { get; set; }

Property Value

DockingWindowState

public Color TabFlashColor { get; set; }

Property Value

Color:

The default value is #80FFA000.

Remarks

Tab flashing can be enabled via the TabFlashMode property.

public TabFlashMode TabFlashMode { get; set; }

Property Value

TabFlashMode

Remarks

The tab flash color can be set via the TabFlashColor property.

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

Property Value

string

Remarks

If this text is not specified, the Title will display on tabs.

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

Property Value

string

Remarks

The resolved value uses TabText if non-null, falling back to Title.

public Color TabTintColor { get; set; }

Property Value

Color

[Localizability(LocalizationCategory.ToolTip)]
public object? TabToolTip { get; set; }

Property Value

object

public TabLayoutKind TabbedMdiLayoutKind { get; set; }

Property Value

TabLayoutKind

public DataTemplate? TabbedMdiTabContextContentTemplate { get; set; }

Property Value

DataTemplate

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

Property Value

string

public Guid UniqueId { get; }

Property Value

Guid

Remarks

A new Guid value is assigned to this property every time the application is run. Use the SerializationId property to designate an ID that uniquely identifies the window for layout deserialization purposes.

[Localizability(LocalizationCategory.NeverLocalize)]
public string? WindowGroupName { get; set; }

Property Value

string

Remarks

Say that there are three windows that should generally be attached together. All of them should be assigned the same group name (e.g. Bottom). When a window is first opened and no previous location is found for it, it will search for other windows that are already open in the same state and have the same group name. If any are found, it will default to attaching to the most recently activated one.

public void Activate(bool focus = true)

Parameter	Type	Description
focus	bool	Whether to focus the window as well.

public bool Close()

Returns

bool:

true if the docking window was closed successfully; otherwise, false.

public bool CloseAllInContainer(bool onlyCloseable = true)

Parameter	Type	Description
onlyCloseable	bool	Only close windows whose CanCloseResolved property is true. The default value is true.

Returns

bool:

true if the docking windows were closed successfully; otherwise, false.

public bool CloseOthers(bool onlyCloseable = true)

Parameter	Type	Description
onlyCloseable	bool	Only close windows whose CanCloseResolved property is true. The default value is true.

Returns

bool:

true if the other docking windows were closed successfully; otherwise, false.

public void Destroy()

public void DragMove(InputPointerButtonEventArgs sourceEventArgs)

Parameter	Type	Description
sourceEventArgs	InputPointerButtonEventArgs	The source InputPointerButtonEventArgs, which can be used to capture the pointer.

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 void Float()

public abstract void Float(Point? location, Size? size)

Parameter	Type	Description
location	Point?	An optional System.Windows.Point specifying the target location of the floating dock host. When UseHostedFloatingWindows is true, the location is expressed relative to the containing control; otherwise, the value is the device independent screen position.
size	Size?	An optional System.Windows.Size specifying the target size of the floating dock host.

Remarks

When location is not specified, it will float to a default location. When size is not specified, it will float with its current size.

public void Float(Point location)

Parameter	Type	Description
location	Point	A System.Windows.Point specifying the target location of the floating dock host. When UseHostedFloatingWindows is true, the location is expressed relative to the containing control; otherwise, the value is the device independent screen position.

public void Float(Size size)

Parameter	Type	Description
size	Size	A System.Windows.Size specifying the target size of the floating dock host.

public void FloatAllInContainer()

public void MoveToFirst()

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public void MoveToIndex(int index)

Parameter	Type	Description
index	int	The index where the window should be moved.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public void MoveToLast()

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public void MoveToLinkedDockSite(DockSite targetDockSite)

Parameter	Type	Description
targetDockSite	DockSite	The dock site where the window should be moved.

public void MoveToMdi()

Remarks

Using this method places the DockingWindow in a DocumentState.

public void MoveToMdi(DockHost? dockHost)

Parameter	Type	Description
dockHost	DockHost	The DockHost that contains an MDI area in which to move the window.

Remarks

Using this method places the DockingWindow in a DocumentState.

public bool MoveToNewHorizontalContainer()

Returns

bool:

true if the window was moved to a new horizontal container; otherwise, false.

public bool MoveToNewVerticalContainer()

Returns

bool:

true if the window was moved to a new vertical container; otherwise, false.

public bool MoveToNextContainer()

Returns

bool:

true if the window was moved to the next container; otherwise, false.

public bool MoveToPreviousContainer()

Returns

bool:

true if the window was moved to the previous container; otherwise, false.

[Obsolete("Use one of the new SetProperty or OnPropertyChanged methods instead of this deprecated NotifyPropertyChanged method.", false)]
protected void NotifyPropertyChanged(string propertyName)

Parameter	Type	Description
propertyName	string	The name of the property that was changed.

protected virtual void OnDefaultLocationRequested(DockingWindowDefaultLocationEventArgs e)

Parameter	Type	Description
e	DockingWindowDefaultLocationEventArgs	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 OnDockSiteChanged(DockSite? oldValue, DockSite? newValue)

Parameter	Type	Description
oldValue	DockSite	The old value.
newValue	DockSite	The new value.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains the event data.

protected virtual void OnIsSelectedChanged()

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameter	Type	Description
e	PropertyChangedEventArgs	The event data.

protected void OnPropertyChanged(string? propertyName = null)

Parameter	Type	Description
propertyName	string	(Optional) The name of the property that changed.

protected virtual void OnStateChanged(DockingWindowState oldValue, DockingWindowState newValue)

Parameter	Type	Description
oldValue	DockingWindowState	The old value.
newValue	DockingWindowState	The new value.

public void Open()

protected bool SetProperty<T>(ref T field, T newValue, string? propertyName = null)

Type Parameters:

T -

The type of the property that changed.

Parameter	Type	Description
field	T	The backing field that holds the property's value, which may be updated.
newValue	T	The new property value.
propertyName	string	(Optional) The name of the property that changed.

Returns

bool:

true if the property was changed; otherwise, false.

public override string ToString()

Returns

string:

The string representation of this object.

protected abstract void UpdateCanAttachResolved()

protected virtual void UpdateCanBecomeDocumentResolved()

protected abstract void UpdateCanCloseResolved()

protected abstract void UpdateCanDockResolved()

protected abstract void UpdateCanDragTabResolved()

protected abstract void UpdateCanDragToLinkedDockSitesResolved()

protected abstract void UpdateCanFloatResolved()

protected virtual void UpdateCommands()

public event EventHandler<DockingWindowDefaultLocationEventArgs> DefaultLocationRequested

Event Type

EventHandler<DockingWindowDefaultLocationEventArgs>

Remarks

The handler should examine the event arguments and set the Target and/or Side properties as appropriate.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler

public static readonly DependencyProperty CanAttachProperty

public static readonly DependencyProperty CanAttachResolvedProperty

public static readonly DependencyProperty CanBecomeDocumentResolvedProperty

public static readonly DependencyProperty CanCloseProperty

public static readonly DependencyProperty CanCloseResolvedProperty

public static readonly DependencyProperty CanDockProperty

public static readonly DependencyProperty CanDockResolvedProperty

public static readonly DependencyProperty CanDragTabProperty

public static readonly DependencyProperty CanDragTabResolvedProperty

public static readonly DependencyProperty CanDragToLinkedDockSitesProperty

public static readonly DependencyProperty CanDragToLinkedDockSitesResolvedProperty

public static readonly DependencyProperty CanFloatProperty

public static readonly DependencyProperty CanFloatResolvedProperty

public static readonly DependencyProperty CanSerializeProperty

public static readonly DependencyProperty CanStandardMdiMaximizeProperty

public static readonly DependencyProperty CanStandardMdiMaximizeResolvedProperty

public static readonly DependencyProperty CanStandardMdiMinimizeProperty

public static readonly DependencyProperty CanStandardMdiMinimizeResolvedProperty

public static readonly DependencyProperty ContainerDockedSizeProperty

public static readonly DependencyProperty ContainerMaxSizeProperty

public static readonly DependencyProperty ContainerMinSizeProperty

public static readonly RoutedEvent DefaultLocationRequestedEvent

public static readonly DependencyProperty DescriptionProperty

public static readonly DependencyProperty ImageSourceProperty

public static readonly DependencyProperty IsActiveProperty

public static readonly DependencyProperty IsFloatingProperty

public static readonly DependencyProperty IsOpenProperty

public static readonly DependencyProperty IsSelectedProperty

public static readonly DependencyProperty LastActiveDateTimeProperty

public static readonly DependencyProperty SerializationIdProperty

public static readonly DependencyProperty SizeToContentModesProperty

public static readonly DependencyProperty StandardMdiBoundsProperty

public static readonly DependencyProperty StandardMdiTitleBarContextContentTemplateProperty

public static readonly DependencyProperty StandardMdiWindowStateProperty

public static readonly DependencyProperty StateProperty

public static readonly DependencyProperty TabFlashColorProperty

public static readonly DependencyProperty TabFlashModeProperty

public static readonly DependencyProperty TabTextProperty

public static readonly DependencyProperty TabTextResolvedProperty

public static readonly DependencyProperty TabTintColorProperty

public static readonly DependencyProperty TabToolTipProperty

public static readonly DependencyProperty TabbedMdiLayoutKindProperty

public static readonly DependencyProperty TabbedMdiTabContextContentTemplateProperty

public static readonly DependencyProperty TitleProperty

public static readonly DependencyProperty UniqueIdProperty

public static readonly DependencyProperty WindowGroupNameProperty