DockingWindow Class

public abstract class DockingWindow : ContentControl, IDockTarget

protected DockingWindow()

protected DockingWindow(bool isContainerForItem)

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:

The ICommand that can Activate() the window.

public bool? CanAttach { get; set; }

Property Value

bool?:

A nullable bool that indicates whether the window may be attached to another window, creating a tabbed grouping.

Remarks

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

public bool CanAttachResolved { get; protected set; }

Property Value

bool:

true if the window may be attached to another window, creating a tabbed grouping; otherwise, false.

public bool CanBecomeDocumentResolved { get; protected set; }

Property Value

bool:

true if the window may be placed in a document state; otherwise, false.

public bool? CanClose { get; set; }

Property Value

bool?:

A nullable bool that indicates whether the window may be closed.

Remarks

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

public bool CanCloseResolved { get; protected set; }

Property Value

bool:

true if the window may be closed; otherwise, false.

public bool? CanDock { get; set; }

Property Value

bool?:

A nullable bool that indicates whether the window may be docked.

Remarks

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

public bool CanDockResolved { get; protected set; }

Property Value

bool:

true if the window may be docked; otherwise, false.

public bool? CanDragTab { get; set; }

Property Value

bool?:

A nullable bool that indicates whether the window's tab may be dragged to another location.

Remarks

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

public bool CanDragTabResolved { get; protected set; }

Property Value

bool:

true if the window's tab may be dragged to another location; otherwise, false.

public bool? CanDragToLinkedDockSites { get; set; }

Property Value

bool?:

A nullable bool that indicates whether the window may be dragged to a linked dock site.

Remarks

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

public bool CanDragToLinkedDockSitesResolved { get; protected set; }

Property Value

bool:

true if the window may be dragged to a linked dock site; otherwise, false.

public bool? CanFloat { get; set; }

Property Value

bool?:

A nullable bool that indicates whether the window may be moved into a separate top-level floating DockHost that is external to the DockSite hierarchy's primary DockHost.

Remarks

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

public bool CanFloatResolved { get; protected set; }

Property Value

bool:

true if the window may be moved into a separate top-level floating DockHost that is external to the DockSite hierarchy's primary DockHost; otherwise, false.

public bool CanMoveToNewHorizontalContainer { get; }

Property Value

bool:

true if the window can move to a new horizontal container; otherwise, false.

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:

true if the window can move to a new vertical container; otherwise, false.

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:

true if the window can move to the next container; otherwise, false.

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:

true if the window can move to the previous container; otherwise, false.

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:

true if the window can move to the primary MDI host; otherwise, false.

public bool CanSerialize { get; set; }

Property Value

bool:

true if the window's layout information may be serialized; otherwise, false. The default value is true.

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?:

A nullable bool that indicates whether the window may be maximized when hosted in a StandardMdiHost.

Remarks

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

public bool CanStandardMdiMaximizeResolved { get; }

Property Value

bool:

true if the window may be maximized when hosted in a StandardMdiHost; otherwise, false.

public bool? CanStandardMdiMinimize { get; set; }

Property Value

bool?:

A nullable bool that indicates whether the window may be minimized when hosted in a StandardMdiHost.

Remarks

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

public bool CanStandardMdiMinimizeResolved { get; }

Property Value

bool:

true if the window may be attached to another window; otherwise, false.

public ICommand CloseAllInContainerCommand { get; }

Property Value

ICommand:

The ICommand that can close all windows in the current container.

public ICommand CloseCommand { get; }

Property Value

ICommand:

The ICommand that can Close() the window.

public ICommand CloseOthersCommand { get; }

Property Value

ICommand:

The ICommand that can close all other windows in the current container.

public Size ContainerDockedSize { get; set; }

Property Value

Size:

The System.Windows.Size of the docking window's container when it is in a docked state.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public Size ContainerMaxSize { get; set; }

Property Value

Size:

The maximum System.Windows.Size of the docking window's container.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public Size ContainerMaxSizeResolved { get; }

Property Value

Size:

The maximum System.Windows.Size of the docking window's container.

public Size ContainerMinSize { get; set; }

Property Value

Size:

The minimum System.Windows.Size of the docking window's container.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

public Size ContainerMinSizeResolved { get; }

Property Value

Size:

The minimum System.Windows.Size of the docking window's container.

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

Property Value

string:

The description for the docking window, which may be used in Ctrl+Tab switching UI.

public ICommand DestroyCommand { get; }

Property Value

ICommand:

The ICommand that can Destroy() the window.

public DockHost DockHost { get; }

Property Value

DockHost:

The DockHost in which the window is currently located.

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:

The DockSite that is managing this docking window.

public ICommand FloatAllInContainerCommand { get; }

Property Value

ICommand:

The ICommand that can float all windows in the current container.

public ICommand FloatCommand { get; }

Property Value

ICommand:

The ICommand that can Float() the window.

public ImageSource ImageSource { get; set; }

Property Value

ImageSource:

The ImageSource specifying the 16x16 image for the docking window.

public bool IsActive { get; set; }

Property Value

bool:

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

Remarks

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

public bool IsContainerForItem { get; }

Property Value

bool:

true if this window was auto-created as a container for an item; otherwise, false.

public bool IsFloating { get; set; }

Property Value

bool:

true if the docking window is floating; otherwise, false.

public bool IsOpen { get; set; }

Property Value

bool:

true if the docking window is currently open in the layout; otherwise, false.

public bool IsSelected { get; set; }

Property Value

bool:

true if the docking window is currently selected in its parent container; otherwise, false.

Remarks

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

public DateTime LastActiveDateTime { get; }

Property Value

DateTime:

The DateTime at which the window was last active, meaning the primary window that was focused.

public ICommand MoveToMdiCommand { get; }

Property Value

ICommand:

The ICommand that can change the window into a document within a MDI area.

public ICommand MoveToNewHorizontalContainerCommand { get; }

Property Value

ICommand:

The ICommand that can move the window to a new horizontal container.

public ICommand MoveToNewVerticalContainerCommand { get; }

Property Value

ICommand:

The ICommand that can move the window to a new vertical container.

public ICommand MoveToNextContainerCommand { get; }

Property Value

ICommand:

The ICommand that can move the window to the next container.

public ICommand MoveToPreviousContainerCommand { get; }

Property Value

ICommand:

The ICommand that can move the window to the previous container.

public ICommand MoveToPrimaryMdiHostCommand { get; }

Property Value

ICommand:

The ICommand that can move the window to the primary MDI host.

public ICommand OpenCommand { get; }

Property Value

ICommand:

The ICommand that can Open() the window.

public DockingWindowContainerBase ParentContainer { get; }

Property Value

DockingWindowContainerBase:

The DockingWindowContainerBase that currently contains the window.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

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

Property Value

string:

The unique ID to use when matching up windows with serialized layout data.

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:

The ICommand that can set the TabbedMdiLayoutKind property to the TabLayoutKind value specified in the command parameter.

public SizeToContentModes SizeToContentModes { get; set; }

Property Value

SizeToContentModes:

A SizeToContentModes that specifies the modes. The default value is None.

public Rect StandardMdiBounds { get; set; }

Property Value

Rect:

The bounds of this docking window when in standard MDI 'restored' state.

public DataTemplate StandardMdiTitleBarContextContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate containing contextual content that should be rendered in a standard MDI window's title bar for this window.

public WindowState StandardMdiWindowState { get; set; }

Property Value

WindowState:

The WindowState of this docking window when in standard MDI.

public DockingWindowState State { get; set; }

Property Value

DockingWindowState:

The DockingWindowState that specifies the current state of the window.

public Color TabFlashColor { get; set; }

Property Value

Color:

The flash color to use if tab flashing is enabled. The default value is #80FFA000.

Remarks

Tab flashing can be enabled via the TabFlashMode property.

public TabFlashMode TabFlashMode { get; set; }

Property Value

TabFlashMode:

The flash mode for the tab.

Remarks

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

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

Property Value

string:

The optional text to only display on tabs.

Remarks

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

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

Property Value

string:

The resolved text to only display on tabs.

Remarks

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

public Color TabTintColor { get; set; }

Property Value

Color:

The color used to tint the tab background and border brushes.

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

Property Value

object:

The tooltip content to use for tabs that represent the window.

public TabLayoutKind TabbedMdiLayoutKind { get; set; }

Property Value

TabLayoutKind:

The TabLayoutKind that indicates how the tab will be positioned.

public DataTemplate TabbedMdiTabContextContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for displaying contextual content in a tabbed MDI tab.

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

Property Value

string:

The title for the docking window.

public Guid UniqueId { get; }

Property Value

Guid:

The Guid that uniquely identifies the control.

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:

The optional name that specifies a group of windows that have an affinity.

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

public void Activate(bool focus)

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.
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.

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 a 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.

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 DockingWindowDefaultLocationEventArgs 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 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 data related to this event.

protected virtual void OnIsSelectedChanged()

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

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

protected virtual void OnStateChanged(DockingWindowState oldValue, DockingWindowState newValue)

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

public void Open()

public override string ToString()

Returns

string:

A String that represents the current 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