DockItem Class

DevZest WPF Docking

previous page next page

DevZest WPF Docking

DockItem Class

Represents a dockable item hosted by a DockControl.

Inheritance Hierarchy

SystemObject  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            System.Windows.ControlsControl
              System.Windows.ControlsContentControl
                DevZest.Windows.DockingDockItem

Namespace: DevZest.Windows.Docking
Assembly: DevZest.WpfDocking (in DevZest.WpfDocking.dll) Version: 2.5.0.0 (2.5.5912.0)

Syntax

Copy

public class DockItem : ContentControl, IDockItemUndoRedoReference

Public Class DockItem
	Inherits ContentControl
	Implements IDockItemUndoRedoReference

The DockItem type exposes the following members.

Constructors

	Name	Description
	DockItem	Initializes a new instance of the DockItem class

Top

Properties

	Name	Description
	AllowedDockTreePositions	Gets or sets the allowed dock tree positions for this DockItem. This is a dependency property.
	AutoHideSize	Gets or sets the size of this DockItem when in auto hide mode. This is a dependency property.
	CanToggleAutoHide	Gets a value indicates whether the auto hide mode of this DockItem can be toggled.
	CanToggleFloating	Gets a value indicates whether the floating mode of this DockItem can be toggled.
	DefaultDockPosition	Gets or sets the default DockPosition for this DockItem. This is a dependency property.
	Description	Gets or sets the description of this DockItem. This is a dependency property.
	DockControl	Gets the DockControl object associated with this DockItem. This is a dependency property.
	DockPosition	Gets the dock position of this DockItem. This is a dependency property.
	DockTreePosition	Gets the dock tree position of this DockItem.
	FirstPane	Gets the first DockPane that this DockItem associated with. This is a dependency property.
	HideOnPerformClose	Gets or sets the value indicates whether hides or closes this DockItem when calling PerformClose.
	Icon	Gets or sets the DockItem object's icon. This is a dependency property.
	IsActiveDocument	Gets a value indicates whether this DockItem is active document. This is a dependency property.
	IsActiveItem	Gets a value indicates whether this DockItem is active. This is a dependency property.
	IsAutoHide	Gets a value indicates whether the DockItem is in auto hide mode.
	IsHidden	Gets a value indicates whether the DockItem is invisible. This is a dependency property.
	IsSelected	Gets a value indicates whether this DockItem is selected. This is a dependency property.
	SecondPane	Gets the second DockPane that this DockItem associated with. This is a dependency property.
	ShowAction	Gets or sets the show action in XAML initialization.
	TabContextMenu	Gets or sets the DockItem object's context menu to display for the tab. This is a dependency property.
	TabText	Gets or sets the DockItem object's text when shown as tabbed. This is a dependency property.
	Title	Gets or sets the DockItem object's title. This is a dependency property.
	UndoRedoReference	Gets a value provides a DockItem reference for undo/redo.

Top

Methods

	Name	Description
	Activate	Activates the DockItem and gives it focus.
	Close	Closes the DockItem.
	Hide	Makes the DockItem invisible.
	OnClosing	Raises the Closing event.
	OnStateChanged	Raises the StateChanged event.
	OnStateChanging	Raises the StateChanging event.
	PerformClose	Hides or closes the DockItem, depending on the value of HideOnPerformClose property.
	Save	Saves the DockItem.
	Show(DockControl)	Shows the DockItem targeting specified DockControl, as activated.
	Show(DockItemShowMethod)	Shows the DockItem, using specified DockItemShowMethod.
	Show(DockControl, DockItemShowMethod)	Shows the DockItem targeting specified DockControl, using specified DockItemShowMethod.
	Show(DockControl, DockPosition)	Shows the DockItem to specified dock position, as activated.
	Show(DockControl, Rect)	Shows the DockItem as activated floating window.
	Show(DockItem, DockItemShowMethod)	Shows the DockItem as tabeed, using specified show method.
	Show(DockPane, Int32)	Shows the DockItem as activated and tabbed.
	Show(DockControl, DockPosition, DockItemShowMethod)	Shows the DockItem to specified dock position, using specified show method.
	Show(DockControl, Rect, DockItemShowMethod)	Shows the DockItem as floating window, using specified show method.
	Show(DockPane, Int32, DockItemShowMethod)	Shows the DockItem as tabbed, using specified show method.
	Show(DockPaneNode, Dock, SplitterDistance)	Shows the DockItem as activated non auto hide DockPane, side by side of target DockPaneNode.
	Show(DockControl, Dock, Boolean, DockItemShowMethod)	Shows the DockItem to the edge of DockControl, brings the respective dock tree to front or sends it to back, using specified show method.
	Show(DockPaneNode, Boolean, Dock, SplitterDistance, Boolean, DockItemShowMethod)	Shows the DockItem as DockPane, side by side of target DockPane, using specified auto hide state, size for target setting and show method.
	ToggleAutoHide	Toggles the auto hide state of the DockItem object's FirstPane, using default DockItemShowMethod for this DockItem.
	ToggleAutoHide(DockItemShowMethod)	Toggles the auto hide state of the DockItem object's FirstPane, using specified DockItemShowMethod for this DockItem.
	ToggleFloating	Toggles the floating state of the DockItem, as activated.
	ToggleFloating(DockItemShowMethod)	Toggles the floating state of the DockItem, using specified show method.

Top

Events

	Name	Description
	Closing	Occurs when the DockItem is closing.
	StateChanged	Occurs when the state of DockItem is changed.
	StateChanging	Occurs when the state of DockItem is changing.

Top

Fields

	Name	Description
	AllowedDockTreePositionsProperty	Identifies the AllowedDockTreePositions dependency property.
	AutoHideSizeProperty	Identifies the AutoHideSize dependency property.
	DefaultDockPositionProperty	Identifies the DefaultDockPosition dependency property.
	DescriptionProperty	Identifies the Description dependency property.
	DockControlProperty	Identifies the DockControl dependency property.
	DockPositionProperty	Identifies the DockPosition dependency property.
	FirstPaneProperty	Identifies the FirstPane dependency property.
	HideOnPerformCloseProperty	Identifies the HideOnPerformClose dependency property.
	IconProperty	Identifies the Icon dependency property.
	IsActiveDocumentProperty	Identifies the IsActiveDocument dependency property.
	IsActiveItemProperty	Identifies the IsActiveItem dependency property.
	IsHiddenProperty	Identifies the IsHidden dependency property.
	IsSelectedProperty	Identifies the IsSelected dependency property.
	SecondPaneProperty	Identifies the SecondPane dependency property.
	TabContextMenuProperty	Identifies the TabContextMenu dependency property.
	TabTextProperty	Identifies the TabText dependency property.
	TitleProperty	Identifies the Title dependency property.

Top

Remarks

Content Model: DockItem derives from ContentControl class, set the Content property to organize the UI of the dockable item.

Use AllowedDockTreePositions, AutoHideSize, DefaultDockPosition, Description, Icon, TabContextMenu, TabText and Title properties to customize the DockItem.

Call Show method to show the DockItem; call Activate method to activate the DockItem; call Close method to close the DockItem (disconnect the DockItem from DockControl); call PerformClose method to close or hide the DockItem, depending on the value of HideOnPerformClose property. You may intercept the Closing event to cancel the DockItem closing.

The DockItem has the following state reflected by its DockPosition and other properties:

State	DockPosition	Description
Disconnected	Unknown	The DockItem is not connected to any DockControl. The values of its DockControl, FirstPane and SecondPane properties are all .
Hidden	Hidden	The DockItem is hidden with its IsHidden property set to .
Visible	other values	The DockItem is visible with its IsHidden property set to , plus the following properties to reflect the state: The IsSelected property indicates whether this DockItem is selected (DockControl.SelectedAutoHideItem or its FirstPane's SelectedItem returns this DockItem). The IsActiveItem property indicates whether this DockItem is active (DockControl.ActiveItem returns this DockItem). The IsActiveDocument property indicates whether this DockItem is active document (DockControl.ActiveDocument returns this DockItem). The IsAutoHide property indicates whether this DockItem is in auto-hide mode. Call ToggleAutoHide method to toggle the auto hide state of the DockItem's FirstPane; call ToggleFloating method to toggle the floating state of the DockItem.

State

DockPosition

Description

Disconnected

Unknown

The DockItem is not connected to any DockControl. The values of its DockControl, FirstPane and SecondPane properties are all .

Hidden

The DockItem is hidden with its IsHidden property set to .

Visible

other values

The DockItem is visible with its IsHidden property set to , plus the following properties to reflect the state:

The IsSelected property indicates whether this DockItem is selected (DockControl.SelectedAutoHideItem or its FirstPane's SelectedItem returns this DockItem).
The IsActiveItem property indicates whether this DockItem is active (DockControl.ActiveItem returns this DockItem).
The IsActiveDocument property indicates whether this DockItem is active document (DockControl.ActiveDocument returns this DockItem).
The IsAutoHide property indicates whether this DockItem is in auto-hide mode.

Call ToggleAutoHide method to toggle the auto hide state of the DockItem's FirstPane; call ToggleFloating method to toggle the floating state of the DockItem.

You may intercept the StateChanging or StateChanged event, which occurs before or after the state of DockItem changed.

Derived class may override the Save method to return a object instance represents this DockItem for saving/loading the window layout, or override the UndoRedoReference property to return a DockItem reference for undo/redo.

Reference

DevZest.Windows.Docking Namespace

previous page start next page