In This Article

DockingWindow Class

Represents the base class for a docking window implementation.

public abstract class DockingWindow : ContentControl, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild, INotifyPropertyChanged, IDragDockTarget, IDockTarget, IHierarchyNode
Inheritance:
Object DispatcherObject DependencyObject Visual UIElement FrameworkElement Control ContentControl Object
Derived:
DocumentWindow ToolWindow
Implements:
IDockTarget

Constructors

DockingWindow()

Initializes a new instance of the DockingWindow class.

protected DockingWindow()

DockingWindow(Boolean)

Initializes a new instance of the DockingWindow class.

protected DockingWindow(bool isContainerForItem)
Parameter Type Description
isContainerForItem Boolean

Whether the window has been auto-created as a container for an item.

Properties

ActivateCommand

Gets the ICommand that can Activate() the window.

public ICommand ActivateCommand { get; }

Property Value

ICommand:

The ICommand that can Activate() the window.

CanAttach

Gets or sets whether the window may be attached to another window, creating a tabbed grouping.

public bool? CanAttach { get; set; }

Property Value

Nullable<Boolean>:

A nullable Boolean 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.

CanAttachResolved

Gets a resolved value indicating whether the window may be attached to another window, creating a tabbed grouping.

public bool CanAttachResolved { get; protected set; }

Property Value

Boolean:

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

CanBecomeDocumentResolved

Gets a resolved value indicating whether the window may be placed in a document state.

public bool CanBecomeDocumentResolved { get; protected set; }

Property Value

Boolean:

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

CanClose

Gets or sets whether the window may be closed.

public bool? CanClose { get; set; }

Property Value

Nullable<Boolean>:

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

Remarks

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

CanCloseResolved

Gets a resolved value indicating whether the window may be closed.

public bool CanCloseResolved { get; protected set; }

Property Value

Boolean:

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

CanDock

Gets or sets whether the window may be docked.

public bool? CanDock { get; set; }

Property Value

Nullable<Boolean>:

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

Remarks

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

CanDockResolved

Gets a resolved value indicating whether the window may be docked.

public bool CanDockResolved { get; protected set; }

Property Value

Boolean:

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

CanDragTab

Gets or sets whether the window's tab may be dragged to another location.

public bool? CanDragTab { get; set; }

Property Value

Nullable<Boolean>:

A nullable Boolean 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.

CanDragTabResolved

Gets a resolved value indicating whether the window's tab may be dragged to another location.

public bool CanDragTabResolved { get; protected set; }

Property Value

Boolean:

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

CanDragToLinkedDockSites

Gets or sets whether the window may be dragged to a linked dock site.

public bool? CanDragToLinkedDockSites { get; set; }

Property Value

Nullable<Boolean>:

A nullable Boolean 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.

CanDragToLinkedDockSitesResolved

Gets a resolved value indicating whether the window may be dragged to a linked dock site.

public bool CanDragToLinkedDockSitesResolved { get; protected set; }

Property Value

Boolean:

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

CanFloat

Gets or sets whether the window may be moved into a separate top-level floating DockHost that is external to the DockSite hierarchy's primary DockHost.

public bool? CanFloat { get; set; }

Property Value

Nullable<Boolean>:

A nullable Boolean 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.

CanFloatResolved

Gets a resolved value indicating whether the window may be moved into a separate top-level floating DockHost that is external to the DockSite hierarchy's primary DockHost.

public bool CanFloatResolved { get; protected set; }

Property Value

Boolean:

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.

CanMoveToNewHorizontalContainer

Gets whether the window can move to a new horizontal container within tabbed MDI.

public bool CanMoveToNewHorizontalContainer { get; }

Property Value

Boolean:

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.

CanMoveToNewVerticalContainer

Gets whether the window can move to a new vertical container within tabbed MDI.

public bool CanMoveToNewVerticalContainer { get; }

Property Value

Boolean:

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.

CanMoveToNextContainer

Gets whether the window can move to the next container within tabbed MDI.

public bool CanMoveToNextContainer { get; }

Property Value

Boolean:

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.

CanMoveToPreviousContainer

Gets whether the window can move to the previous container within tabbed MDI.

public bool CanMoveToPreviousContainer { get; }

Property Value

Boolean:

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.

CanMoveToPrimaryMdiHost

Gets whether the window can move to the primary MDI host, which is the one directly within the main DockSite hierarchy and not on a floating DockHost.

public bool CanMoveToPrimaryMdiHost { get; }

Property Value

Boolean:

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

CanSerialize

Gets or sets whether the window's layout information may be serialized.

public bool CanSerialize { get; set; }

Property Value

Boolean:

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.

CanStandardMdiMaximize

Gets or sets whether the window may be maximized when hosted in a StandardMdiHost.

public bool? CanStandardMdiMaximize { get; set; }

Property Value

Nullable<Boolean>:

A nullable Boolean 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.

CanStandardMdiMaximizeResolved

Gets a resolved value indicating whether the window may be maximized when hosted in a StandardMdiHost.

public bool CanStandardMdiMaximizeResolved { get; }

Property Value

Boolean:

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

CanStandardMdiMinimize

Gets or sets whether the window may be minimized when hosted in a StandardMdiHost.

public bool? CanStandardMdiMinimize { get; set; }

Property Value

Nullable<Boolean>:

A nullable Boolean 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.

CanStandardMdiMinimizeResolved

Gets a resolved value indicating whether the window may be attached to another window, creating a tabbed grouping.

public bool CanStandardMdiMinimizeResolved { get; }

Property Value

Boolean:

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

CloseAllInContainerCommand

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

public ICommand CloseAllInContainerCommand { get; }

Property Value

ICommand:

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

CloseCommand

Gets the ICommand that can Close() the window.

public ICommand CloseCommand { get; }

Property Value

ICommand:

The ICommand that can Close() the window.

CloseOthersCommand

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

public ICommand CloseOthersCommand { get; }

Property Value

ICommand:

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

ContainerDockedSize

Gets or sets the Size of the docking window's container when it is in a docked state.

public Size ContainerDockedSize { get; set; }

Property Value

Size:

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

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

ContainerMaxSize

Gets or sets the maximum Size of the docking window's container.

public Size ContainerMaxSize { get; set; }

Property Value

Size:

The maximum Size of the docking window's container.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

ContainerMaxSizeResolved

Gets the resolved maximum Size of the docking window's container.

public Size ContainerMaxSizeResolved { get; }

Property Value

Size:

The maximum Size of the docking window's container.

ContainerMinSize

Gets or sets the minimum Size of the docking window's container.

public Size ContainerMinSize { get; set; }

Property Value

Size:

The minimum Size of the docking window's container.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

ContainerMinSizeResolved

Gets the resolved minimum Size of the docking window's container.

public Size ContainerMinSizeResolved { get; }

Property Value

Size:

The minimum Size of the docking window's container.

Description

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

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

DestroyCommand

Gets the ICommand that can Destroy() the window.

public ICommand DestroyCommand { get; }

Property Value

ICommand:

The ICommand that can Destroy() the window.

DockHost

Gets the DockHost in which the window is currently located.

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.

DockSite

Gets the DockSite that is managing this docking window.

public DockSite DockSite { get; }

Property Value

DockSite:

The DockSite that is managing this docking window.

FloatAllInContainerCommand

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

public ICommand FloatAllInContainerCommand { get; }

Property Value

ICommand:

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

FloatCommand

Gets the ICommand that can Float() the window.

public ICommand FloatCommand { get; }

Property Value

ICommand:

The ICommand that can Float() the window.

ImageSource

Gets or sets the ImageSource specifying the 16x16 image for the docking window, used in switcher UI and also sometimes on tabs.

public ImageSource ImageSource { get; set; }

Property Value

ImageSource:

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

IsActive

Gets or sets whether the docking window is currently active, meaning the primary window that currently/last had focus.

public bool IsActive { get; set; }

Property Value

Boolean:

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

Remarks

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

IsContainerForItem

Gets whether this window was auto-created as a container for an item, which occurs when using the DocumentItemsSource or ToolItemsSource properties.

public bool IsContainerForItem { get; }

Property Value

Boolean:

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

IsFloating

Gets or sets whether the docking window is floating, meaning it is currently open in a floating DockHost, or is closed and was last open in a floating DockHost.

public bool IsFloating { get; set; }

Property Value

Boolean:

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

IsOpen

Gets or sets whether the docking window is currently open in the layout.

public bool IsOpen { get; set; }

Property Value

Boolean:

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

IsSelected

Gets or sets whether the docking window is currently selected in its parent container.

public bool IsSelected { get; set; }

Property Value

Boolean:

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

Remarks

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

LastActiveDateTime

Gets or sets the DateTime at which the window was last active, meaning the primary window that was focused.

public DateTime LastActiveDateTime { get; }

Property Value

DateTime:

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

MoveToMdiCommand

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

public ICommand MoveToMdiCommand { get; }

Property Value

ICommand:

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

MoveToNewHorizontalContainerCommand

Gets the ICommand that can move the window to a new horizontal container within tabbed MDI.

public ICommand MoveToNewHorizontalContainerCommand { get; }

Property Value

ICommand:

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

MoveToNewVerticalContainerCommand

Gets the ICommand that can move the window to a new vertical container within tabbed MDI.

public ICommand MoveToNewVerticalContainerCommand { get; }

Property Value

ICommand:

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

MoveToNextContainerCommand

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

public ICommand MoveToNextContainerCommand { get; }

Property Value

ICommand:

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

MoveToPreviousContainerCommand

Gets the ICommand that can move the window to the previous container within tabbed MDI.

public ICommand MoveToPreviousContainerCommand { get; }

Property Value

ICommand:

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

MoveToPrimaryMdiHostCommand

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

public ICommand MoveToPrimaryMdiHostCommand { get; }

Property Value

ICommand:

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

OpenCommand

Gets the ICommand that can Open() the window.

public ICommand OpenCommand { get; }

Property Value

ICommand:

The ICommand that can Open() the window.

ParentContainer

Gets the DockingWindowContainerBase that currently contains 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.

SerializationId

Gets or sets the unique ID to use when matching up windows with serialized layout data.

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

SetTabbedMdiLayoutKindCommand

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

public ICommand SetTabbedMdiLayoutKindCommand { get; }

Property Value

ICommand:

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

SizeToContentModes

Gets or sets a SizeToContentModes that indicates when to try to size-to-content.

public SizeToContentModes SizeToContentModes { get; set; }

Property Value

SizeToContentModes:

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

StandardMdiBounds

Gets or sets the bounds of this docking window when in standard MDI 'restored' state.

public Rect StandardMdiBounds { get; set; }

Property Value

Rect:

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

StandardMdiTitleBarContextContentTemplate

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

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.

StandardMdiWindowState

Gets or sets the WindowState of this docking window when in standard MDI.

public WindowState StandardMdiWindowState { get; set; }

Property Value

WindowState:

The WindowState of this docking window when in standard MDI.

State

Gets or sets the DockingWindowState that specifies the current state of the window.

public DockingWindowState State { get; set; }

Property Value

DockingWindowState:

The DockingWindowState that specifies the current state of the window.

TabbedMdiLayoutKind

Gets or sets the TabLayoutKind that indicates how the tab will be positioned (normal, pinned, or preview).

public TabLayoutKind TabbedMdiLayoutKind { get; set; }

Property Value

TabLayoutKind:

The TabLayoutKind that indicates how the tab will be positioned.

TabbedMdiTabContextContentTemplate

Gets or sets the DataTemplate to use for displaying contextual content in a tabbed MDI tab.

public DataTemplate TabbedMdiTabContextContentTemplate { get; set; }

Property Value

DataTemplate:

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

TabFlashColor

Gets or sets the flash color to use if tab flashing is enabled.

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.

TabFlashMode

Gets or sets the flash mode for the tab.

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.

TabText

Gets or sets the optional text to only display on tabs.

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

TabTextResolved

Gets the resolved optional text to only display on tabs.

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

Property Value

String:

The resolved optional text to only display on tabs.

TabTintColor

Gets or sets the color used to tint the tab background and border brushes.

public Color TabTintColor { get; set; }

Property Value

Color:

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

TabToolTip

Gets or sets the tooltip content to use for tabs that represent the window.

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

Property Value

Object:

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

Title

Gets or sets the title for the docking window, which appears in several places throughout the UI.

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

Property Value

String:

The title for the docking window.

UniqueId

Gets the Guid that uniquely identifies the control.

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.

WindowGroupName

Gets or sets an optional name that specifies a group of windows that have an affinity.

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

Methods

Activate()

Activates the window by opening it (if closed), ensuring that it is brought to front, and focusing it.

public void Activate()

Activate(Boolean)

Activates the window by opening it (if closed), ensuring that it is brought to front, and optionally focusing it.

public void Activate(bool focus)
Parameter Type Description
focus Boolean

Whether to focus the window as well.

Close()

Closes the window, removing it from the layout.

public bool Close()

Returns

Boolean:

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

CloseAllInContainer(Boolean)

Closes all windows in the same parent container, removing them from the layout.

public bool CloseAllInContainer(bool onlyCloseable = true)
Parameter Type Description
onlyCloseable Boolean

Only close windows whose CanCloseResolved property is true. The default value is true.

Returns

Boolean:

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

CloseOthers(Boolean)

Closes all other windows in the same parent container, removing them from the layout.

public bool CloseOthers(bool onlyCloseable = true)
Parameter Type Description
onlyCloseable Boolean

Only close windows whose CanCloseResolved property is true. The default value is true.

Returns

Boolean:

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

Destroy()

Ensures the window is closed (removed from the layout) and also unregisters it from the DockSite.

public void Destroy()

DragMove(InputPointerButtonEventArgs)

Programmatically starts a drag/move.

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.

Float()

Floats the window to a default location with its current size.

public void Float()

Float(Nullable<Point>, Nullable<Size>)

Floats the window to the specified optional location and size.

public abstract void Float(Point? location, Size? size)
Parameter Type Description
location Nullable<Point>

An optional Point specifying the target location of the floating dock host.

size Nullable<Size>

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

Float(Point)

Floats the window to the specified location with its current size.

public void Float(Point location)
Parameter Type Description
location Point

A Point specifying the target location of the floating dock host.

Float(Size)

Floats the window to a default location with the specified size.

public void Float(Size size)
Parameter Type Description
size Size

A Size specifying the target size of the floating dock host.

FloatAllInContainer()

Floats all windows in the same parent container.

public void FloatAllInContainer()

MoveToFirst()

Moves the DockingWindow to be the first item in the current parent container.

public void MoveToFirst()

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

MoveToIndex(Int32)

Moves the DockingWindow to the specified location in the current parent container.

public void MoveToIndex(int index)
Parameter Type Description
index Int32

The index where the window should be moved.

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

MoveToLast()

Moves the DockingWindow to be the last item in the current parent container.

public void MoveToLast()

Remarks

The container is generally a TabbedMdiContainer or ToolWindowContainer.

MoveToLinkedDockSite(DockSite)

Moves the DockingWindow to the specified linked dock site.

public void MoveToLinkedDockSite(DockSite targetDockSite)
Parameter Type Description
targetDockSite DockSite

The dock site where the window should be moved.

MoveToMdi()

Changes the DockingWindow into a document within a MDI area.

public void MoveToMdi()

Remarks

Using this method places the DockingWindow in a Document State.

MoveToMdi(DockHost)

Changes the DockingWindow into a document within a specific DockHost's MDI area.

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

MoveToNewHorizontalContainer()

Moves the window to a new horizontal container within tabbed MDI.

public bool MoveToNewHorizontalContainer()

Returns

Boolean:

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

MoveToNewVerticalContainer()

Moves the window to a new vertical container within tabbed MDI.

public bool MoveToNewVerticalContainer()

Returns

Boolean:

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

MoveToNextContainer()

Moves the window to the next container (i.e. the one that appears after it in the layout) within tabbed MDI.

public bool MoveToNextContainer()

Returns

Boolean:

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

MoveToPreviousContainer()

Moves the window to the previous container (i.e. the one that appears before it in the layout) within tabbed MDI.

public bool MoveToPreviousContainer()

Returns

Boolean:

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

NotifyPropertyChanged(String)

Notifies that a property has changed.

protected void NotifyPropertyChanged(string propertyName)
Parameter Type Description
propertyName String

The name of the property that was changed.

OnDefaultLocationRequested(DockingWindowDefaultLocationEventArgs)

Occurs when a DockingWindow's default location is requested.

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.

OnDockSiteChanged(DockSite, DockSite)

Occurs when the value of the DockSite property has changed.

protected virtual void OnDockSiteChanged(DockSite oldValue, DockSite newValue)
Parameter Type Description
oldValue DockSite

The old value.

newValue DockSite

The new value.

OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

Occurs when a control within this control's hierarchy gains keyboard focus.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)
Parameter Type Description
e KeyboardFocusChangedEventArgs

The KeyboardFocusChangedEventArgs that contains data related to this event.

OnIsSelectedChanged()

Occurs when the value of the IsSelected property changes.

protected virtual void OnIsSelectedChanged()

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event.

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
Parameter Type Description
e PropertyChangedEventArgs

The PropertyChangedEventArgs that contains the event data.

OnStateChanged(DockingWindowState, DockingWindowState)

Occurs when the value of the State property has changed.

protected virtual void OnStateChanged(DockingWindowState oldValue, DockingWindowState newValue)
Parameter Type Description
oldValue DockingWindowState

The old value.

newValue DockingWindowState

The new value.

Open()

Opens the window, inserting it into the layout.

public void Open()

ToString()

Returns a String that represents the current Object.

public override string ToString()

Returns

String:

A String that represents the current Object.

UpdateCanAttachResolved()

Updates the CanAttachResolved value.

protected abstract void UpdateCanAttachResolved()

UpdateCanBecomeDocumentResolved()

Updates the CanBecomeDocumentResolved value.

protected virtual void UpdateCanBecomeDocumentResolved()

UpdateCanCloseResolved()

Updates the CanCloseResolved value.

protected abstract void UpdateCanCloseResolved()

UpdateCanDockResolved()

Updates the CanDockResolved value.

protected abstract void UpdateCanDockResolved()

UpdateCanDragTabResolved()

Updates the CanDragTabResolved value.

protected abstract void UpdateCanDragTabResolved()

UpdateCanDragToLinkedDockSitesResolved()

protected abstract void UpdateCanDragToLinkedDockSitesResolved()

UpdateCanFloatResolved()

Updates the CanFloatResolved value.

protected abstract void UpdateCanFloatResolved()

UpdateCommands()

Updates the enabled states of the commands.

protected virtual void UpdateCommands()

Events

DefaultLocationRequested

Occurs when a DockingWindow's default location is requested.

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.

PropertyChanged

Occurs when a property has been changed.

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

Explicit Interface Implementations

IDockTarget.DockHost

Gets the owner DockHost.

DockHost IDockTarget.DockHost { get; }

Returns

DockHost:

The owner DockHost.

IDockTarget.GetState(Nullable<Side>)

Returns the DockingWindowState that specifies the state of the docking location around the target.

DockingWindowState IDockTarget.GetState(Side? side)
Parameter Type Description
side Nullable<Side>

Returns

DockingWindowState:

The DockingWindowState that specifies the state of the docking location around the target.

Fields

CanAttachProperty

Identifies the CanAttach dependency property. This field is read-only.

public static readonly DependencyProperty CanAttachProperty

CanAttachResolvedProperty

Identifies the CanAttachResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanAttachResolvedProperty

CanBecomeDocumentResolvedProperty

Identifies the CanBecomeDocumentResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanBecomeDocumentResolvedProperty

CanCloseProperty

Identifies the CanClose dependency property. This field is read-only.

public static readonly DependencyProperty CanCloseProperty

CanCloseResolvedProperty

Identifies the CanCloseResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanCloseResolvedProperty

CanDockProperty

Identifies the CanDock dependency property. This field is read-only.

public static readonly DependencyProperty CanDockProperty

CanDockResolvedProperty

Identifies the CanDockResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanDockResolvedProperty

CanDragTabProperty

Identifies the CanDragTab dependency property. This field is read-only.

public static readonly DependencyProperty CanDragTabProperty

CanDragTabResolvedProperty

Identifies the CanDragTabResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanDragTabResolvedProperty

CanDragToLinkedDockSitesProperty

Identifies the CanDragToLinkedDockSites dependency property. This field is read-only.

public static readonly DependencyProperty CanDragToLinkedDockSitesProperty

CanDragToLinkedDockSitesResolvedProperty

Identifies the CanDragToLinkedDockSitesResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanDragToLinkedDockSitesResolvedProperty

CanFloatProperty

Identifies the CanFloat dependency property. This field is read-only.

public static readonly DependencyProperty CanFloatProperty

CanFloatResolvedProperty

Identifies the CanFloatResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanFloatResolvedProperty

CanSerializeProperty

Identifies the CanSerialize dependency property. This field is read-only.

public static readonly DependencyProperty CanSerializeProperty

CanStandardMdiMaximizeProperty

Identifies the CanStandardMdiMaximize dependency property. This field is read-only.

public static readonly DependencyProperty CanStandardMdiMaximizeProperty

CanStandardMdiMaximizeResolvedProperty

Identifies the CanStandardMdiMaximizeResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanStandardMdiMaximizeResolvedProperty

CanStandardMdiMinimizeProperty

Identifies the CanStandardMdiMinimize dependency property. This field is read-only.

public static readonly DependencyProperty CanStandardMdiMinimizeProperty

CanStandardMdiMinimizeResolvedProperty

Identifies the CanStandardMdiMinimizeResolved dependency property. This field is read-only.

public static readonly DependencyProperty CanStandardMdiMinimizeResolvedProperty

ContainerDockedSizeProperty

Identifies the ContainerDockedSize dependency property. This field is read-only.

public static readonly DependencyProperty ContainerDockedSizeProperty

ContainerMaxSizeProperty

Identifies the ContainerMaxSize dependency property. This field is read-only.

public static readonly DependencyProperty ContainerMaxSizeProperty

ContainerMinSizeProperty

Identifies the ContainerMinSize dependency property. This field is read-only.

public static readonly DependencyProperty ContainerMinSizeProperty

DefaultLocationRequestedEvent

Identifies the DefaultLocationRequested routed event. This field is read-only.

public static readonly RoutedEvent DefaultLocationRequestedEvent

DescriptionProperty

Identifies the Description dependency property. This field is read-only.

public static readonly DependencyProperty DescriptionProperty

ImageSourceProperty

Identifies the ImageSource dependency property. This field is read-only.

public static readonly DependencyProperty ImageSourceProperty

IsActiveProperty

Identifies the IsActive dependency property. This field is read-only.

public static readonly DependencyProperty IsActiveProperty

IsFloatingProperty

Identifies the IsFloating dependency property. This field is read-only.

public static readonly DependencyProperty IsFloatingProperty

IsOpenProperty

Identifies the IsOpen dependency property. This field is read-only.

public static readonly DependencyProperty IsOpenProperty

IsSelectedProperty

Identifies the IsSelected dependency property. This field is read-only.

public static readonly DependencyProperty IsSelectedProperty

LastActiveDateTimeProperty

Identifies the LastActiveDateTime dependency property. This field is read-only.

public static readonly DependencyProperty LastActiveDateTimeProperty

SerializationIdProperty

Identifies the SerializationId dependency property. This field is read-only.

public static readonly DependencyProperty SerializationIdProperty

SizeToContentModesProperty

Identifies the SizeToContentModes dependency property. This field is read-only.

public static readonly DependencyProperty SizeToContentModesProperty

StandardMdiBoundsProperty

Identifies the StandardMdiBounds dependency property. This field is read-only.

public static readonly DependencyProperty StandardMdiBoundsProperty

StandardMdiTitleBarContextContentTemplateProperty

Identifies the StandardMdiTitleBarContextContentTemplate dependency property. This field is read-only.

public static readonly DependencyProperty StandardMdiTitleBarContextContentTemplateProperty

StandardMdiWindowStateProperty

Identifies the StandardMdiWindowState dependency property. This field is read-only.

public static readonly DependencyProperty StandardMdiWindowStateProperty

StateProperty

Identifies the State dependency property. This field is read-only.

public static readonly DependencyProperty StateProperty

TabbedMdiLayoutKindProperty

Identifies the TabbedMdiLayoutKind dependency property. This field is read-only.

public static readonly DependencyProperty TabbedMdiLayoutKindProperty

TabbedMdiTabContextContentTemplateProperty

Identifies the TabbedMdiTabContextContentTemplate dependency property. This field is read-only.

public static readonly DependencyProperty TabbedMdiTabContextContentTemplateProperty

TabFlashColorProperty

Identifies the TabFlashColor dependency property. This field is read-only.

public static readonly DependencyProperty TabFlashColorProperty

TabFlashModeProperty

Identifies the TabFlashMode dependency property. This field is read-only.

public static readonly DependencyProperty TabFlashModeProperty

TabTextProperty

Identifies the TabText dependency property. This field is read-only.

public static readonly DependencyProperty TabTextProperty

TabTextResolvedProperty

Identifies the TabTextResolved dependency property. This field is read-only.

public static readonly DependencyProperty TabTextResolvedProperty

TabTintColorProperty

Identifies the TabTintColor dependency property. This field is read-only.

public static readonly DependencyProperty TabTintColorProperty

TabToolTipProperty

Identifies the TabToolTip dependency property. This field is read-only.

public static readonly DependencyProperty TabToolTipProperty

TitleProperty

Identifies the Title dependency property. This field is read-only.

public static readonly DependencyProperty TitleProperty

UniqueIdProperty

Identifies the UniqueId dependency property. This field is read-only.

public static readonly DependencyProperty UniqueIdProperty

WindowGroupNameProperty

Identifies the WindowGroupName dependency property. This field is read-only.

public static readonly DependencyProperty WindowGroupNameProperty

Inherited Members

Extension Methods