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

public DataTemplate? CloseButtonContentTemplate { get; set; }

Property Value

DataTemplate

public string? CloseButtonToolTip { get; }

Property Value

string

Remarks

The text of CloseKeyGesture will be passed as the first argument for string formatting, so {0} in the string resource will be replaced by the key gesture.

public ICommand CloseCommand { get; }

Property Value

ICommand

public KeyGesture? CloseKeyGesture { get; set; }

Property Value

KeyGesture:

The default value is Shift+Esc.

See Also

• CloseCommand

public ICommand DockCommand { get; }

Property Value

ICommand

public Style? EmbeddedButtonStyle { get; set; }

Property Value

Style

public bool HasCloseButton { get; set; }

Property Value

bool:

The default value is true.

public bool HasTitleBarGripper { get; set; }

Property Value

bool:

The default value is false.

public bool HasTitleBarIcon { get; set; }

Property Value

bool:

The default value is false.

public bool HasToggleAutoHideButton { get; set; }

Property Value

bool:

The default value is true.

public bool IsCloseButtonVisible { get; }

Property Value

bool:

The default value is true.

public bool IsMaximizeButtonVisible { get; }

Property Value

bool:

The default value is false.

public bool IsMinimizeButtonVisible { get; }

Property Value

bool:

The default value is false.

public bool IsOptionsButtonVisible { get; }

Property Value

bool:

The default value is true.

public bool IsRestoreButtonVisible { get; }

Property Value

bool:

The default value is false.

public bool IsToggleAutoHideButtonVisible { get; }

Property Value

bool:

The default value is true.

public DataTemplate? MaximizeButtonContentTemplate { get; set; }

Property Value

DataTemplate

public ICommand MaximizeCommand { get; }

Property Value

ICommand

public DataTemplate? MenuButtonContentTemplate { get; set; }

Property Value

DataTemplate

public DataTemplate? MinimizeButtonContentTemplate { get; set; }

Property Value

DataTemplate

public ICommand MinimizeCommand { get; }

Property Value

ICommand

public KeyGesture? OpenOptionsMenuKeyGesture { get; set; }

Property Value

KeyGesture:

The default value is Alt+-.

public string? OptionsMenuButtonToolTip { get; }

Property Value

string

Remarks

The text of OpenOptionsMenuKeyGesture will be passed as the first argument for string formatting, so {0} in the string resource will be replaced by the key gesture.

public DataTemplate? PinButtonContentTemplate { get; set; }

Property Value

DataTemplate

public DataTemplate? RestoreButtonContentTemplate { get; set; }

Property Value

DataTemplate

public ICommand RestoreCommand { get; }

Property Value

ICommand

public ToolWindow? SelectedToolWindow { get; }

Property Value

ToolWindow

public ContextContentAlignment TitleBarContextContentAlignment { get; set; }

Property Value

ContextContentAlignment:

The default value is Far.

public double TitleBarMinHeight { get; set; }

Property Value

double

public FontFamily TitleFontFamily { get; set; }

Property Value

FontFamily

public double TitleFontSize { get; set; }

Property Value

double

public FontWeight TitleFontWeight { get; set; }

Property Value

FontWeight:

The default value is Normal.

public ICommand ToggleAutoHideCommand { get; }

Property Value

ICommand

public DataTemplate? UnpinButtonContentTemplate { get; set; }

Property Value

DataTemplate

public ObservableCollection<DockingWindow> Windows { get; }

Property Value

ObservableCollection<DockingWindow>

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

The type-specific AutomationPeer implementation.

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

public static readonly DependencyProperty CloseKeyGestureProperty

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 OpenOptionsMenuKeyGestureProperty

public static readonly DependencyProperty OptionsMenuButtonToolTipProperty

public static readonly DependencyProperty PinButtonContentTemplateProperty

public static readonly DependencyProperty RestoreButtonContentTemplateProperty

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