ToolWindowContainer Class

[TemplatePart(Name = "PART_Icon", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "PART_OptionsButton", Type = typeof(PopupButton))]
[TemplatePart(Name = "PART_TitleBar", Type = typeof(FrameworkElement))]
[TemplateVisualState(Name = "Active", GroupName = "ActiveStates")]
[TemplateVisualState(Name = "Inactive", GroupName = "ActiveStates")]
[TemplateVisualState(Name = "AutoHide", GroupName = "StateStates")]
[TemplateVisualState(Name = "Docked", GroupName = "StateStates")]
public class ToolWindowContainer : DockingWindowContainerBase, IDockTarget, IOrientedElement

public ToolWindowContainer()

public ICommand AutoHideCommand { get; }

Property Value

ICommand:

The ICommand that can auto-hide the windows in the container.

public DataTemplate CloseButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the close button content.

public ICommand CloseCommand { get; }

Property Value

ICommand:

The ICommand that can close the windows in the container.

public ICommand DockCommand { get; }

Property Value

ICommand:

The ICommand that can dock the windows in the container.

public Style EmbeddedButtonStyle { get; set; }

Property Value

Style:

The Style to use for embedded buttons.

public bool HasCloseButton { get; set; }

Property Value

bool:

true if the container has a title bar close button if the SelectedWindow is closable; otherwise, false. The default value is true.

public bool HasTitleBarGripper { get; set; }

Property Value

bool:

true if the titlebar has a gripper; otherwise, false. The default value is false.

public bool HasTitleBarIcon { get; set; }

Property Value

bool:

true if the window is capable of displaying the selected window's icon in the title bar; otherwise, false. The default value is false.

public bool HasToggleAutoHideButton { get; set; }

Property Value

bool:

true if the container has a title bar toggle auto-hide button if the SelectedWindow can auto-hide; otherwise, false. The default value is true.

public bool IsCloseButtonVisible { get; }

Property Value

bool:

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

public bool IsMaximizeButtonVisible { get; }

Property Value

bool:

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

public bool IsMinimizeButtonVisible { get; }

Property Value

bool:

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

public bool IsOptionsButtonVisible { get; }

Property Value

bool:

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

public bool IsRestoreButtonVisible { get; }

Property Value

bool:

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

public bool IsToggleAutoHideButtonVisible { get; }

Property Value

bool:

true if the container's toggle auto-hide button is visible; otherwise, false. The default value is true.

public DataTemplate MaximizeButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the maximize button content.

public ICommand MaximizeCommand { get; }

Property Value

ICommand:

The ICommand that can maximize the window that hosts the container.

public DataTemplate MenuButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the drop-down menu button content.

public DataTemplate MinimizeButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the minimize button content.

public ICommand MinimizeCommand { get; }

Property Value

ICommand:

The ICommand that can minimize the window that hosts the container.

public DataTemplate PinButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the pin button content.

public DataTemplate RestoreButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the restore button content.

public ICommand RestoreCommand { get; }

Property Value

ICommand:

The ICommand that can restore the window that hosts the container.

public ToolWindow SelectedToolWindow { get; }

Property Value

ToolWindow:

The ToolWindow that is currently selected in the container.

public SingleTabLayoutBehavior SingleTabLayoutBehavior { get; set; }

Property Value

SingleTabLayoutBehavior:

The behavior used when a single ToolWindow is in the container.

public ContextContentAlignment TitleBarContextContentAlignment { get; set; }

Property Value

ContextContentAlignment:

The alignment of title bar context content. The default value is Far.

public double TitleBarMinHeight { get; set; }

Property Value

double:

The title bar minimum height.

public FontFamily TitleFontFamily { get; set; }

Property Value

FontFamily:

The title's font family.

public double TitleFontSize { get; set; }

Property Value

double:

The title's font size.

public FontWeight TitleFontWeight { get; set; }

Property Value

FontWeight:

The title's font weight. The default value is Normal.

public ICommand ToggleAutoHideCommand { get; }

Property Value

ICommand:

The ICommand that can toggle the container between an auto-hide and docked state.

public DataTemplate UnpinButtonContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the unpin button content.

public ObservableCollection<DockingWindow> Windows { get; }

Property Value

ObservableCollection<DockingWindow>:

The collection of child DockingWindow objects.

public void AutoHide()

Remarks

Using this method places the contained ToolWindow controls in an AutoHideState. Use the AutoHide(Side) method overload to auto-hide to a specific side.

public void AutoHide(Side side)

Parameter	Type	Description
side	Side	A Side indicating the side upon which to auto-hide.

Remarks

Using this method places the contained ToolWindow controls in an AutoHideState. Use the AutoHide() method overload to auto-hide to the control's default side.

public bool Close()

Returns

bool:

true if all tool windows were closed successfully; otherwise, false.

public void Dock()

Remarks

Using this method places the contained ToolWindow controls in a DockedState.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

protected override void OnDockSiteChanged(DockSite oldDockSite, DockSite newDockSite)

Parameter	Type	Description
oldDockSite	DockSite	The old value.
newDockSite	DockSite	The new value.

protected override void OnKeyDown(KeyEventArgs e)

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

protected override void OnTabControlMenuOpening(AdvancedTabControlMenuEventArgs e)

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

public void OpenOptionsMenu()

public void OpenOptionsMenu(FrameworkElement placementTarget)

Parameter	Type	Description
placementTarget	FrameworkElement	The optional FrameworkElement under which to open the menu.

protected override void UpdateCommands()

protected override void UpdateDockingWindowStates()

protected override void UpdateIsTabStripVisible()

protected override void UpdateTitleBarButtonVisibility()

protected override void UpdateVisualState(bool useTransitions)

Parameter	Type	Description
useTransitions	bool	Whether to use transitions.

protected override void ValidateChildType(DockingWindow window)

Parameter	Type	Description
window	DockingWindow	The DockingWindow to examine.

public static readonly DependencyProperty CloseButtonContentTemplateProperty

public static readonly DependencyProperty EmbeddedButtonStyleProperty

public static readonly DependencyProperty HasCloseButtonProperty

public static readonly DependencyProperty HasTitleBarGripperProperty

public static readonly DependencyProperty HasTitleBarIconProperty

public static readonly DependencyProperty HasToggleAutoHideButtonProperty

public static readonly DependencyProperty IsCloseButtonVisibleProperty

public static readonly DependencyProperty IsMaximizeButtonVisibleProperty

public static readonly DependencyProperty IsMinimizeButtonVisibleProperty

public static readonly DependencyProperty IsOptionsButtonVisibleProperty

public static readonly DependencyProperty IsRestoreButtonVisibleProperty

public static readonly DependencyProperty IsToggleAutoHideButtonVisibleProperty

public static readonly DependencyProperty MaximizeButtonContentTemplateProperty

public static readonly DependencyProperty MenuButtonContentTemplateProperty

public static readonly DependencyProperty MinimizeButtonContentTemplateProperty

public static readonly DependencyProperty PinButtonContentTemplateProperty

public static readonly DependencyProperty RestoreButtonContentTemplateProperty

public static readonly DependencyProperty SingleTabLayoutBehaviorProperty

public static readonly DependencyProperty TitleBarContextContentAlignmentProperty

public static readonly DependencyProperty TitleBarMinHeightProperty

public static readonly DependencyProperty TitleFontFamilyProperty

public static readonly DependencyProperty TitleFontSizeProperty

public static readonly DependencyProperty TitleFontWeightProperty

public static readonly DependencyProperty UnpinButtonContentTemplateProperty