In This Article

DockingWindowContainerBase Class

Represents the base class for a control that can contain multiple docking windows, with one selected.

[TemplatePart(Name = "PART_TabControl", Type = typeof(AdvancedTabControl))]
[TemplateVisualState(Name = "TabStripBottom", GroupName = "TabStripPlacementStates")]
[TemplateVisualState(Name = "TabStripLeft", GroupName = "TabStripPlacementStates")]
[TemplateVisualState(Name = "TabStripRight", GroupName = "TabStripPlacementStates")]
[TemplateVisualState(Name = "TabStripTop", GroupName = "TabStripPlacementStates")]
public abstract class DockingWindowContainerBase : Control, IOrientedElement
Inheritance:
object Visual UIElement FrameworkElement Control object
Derived:
TabbedMdiContainer ToolWindowContainer
Implements:
IOrientedElement

Constructors

DockingWindowContainerBase()

Initializes an instance of the DockingWindowContainerBase class.

protected DockingWindowContainerBase()

Properties

CanTabsCloseOnMiddleClick

Gets or sets whether tabs can close when a middle-click is performed over them.

public bool CanTabsCloseOnMiddleClick { get; set; }

Property Value

bool:

true if tabs can close when a middle-click is performed over them; otherwise, false. The default value is true.

Remarks

The CanClose property must also be set to true for this behavior to work.

DockHost

Gets the DockHost that contains this control.

public DockHost DockHost { get; }

Property Value

DockHost:

The DockHost that contains this control.

DockSite

Gets the DockSite that is managing this control.

public DockSite DockSite { get; }

Property Value

DockSite:

The DockSite that is managing this control.

HasTabImages

Gets or sets whether tabs display an embedded image when one is available.

public bool HasTabImages { get; set; }

Property Value

bool:

true if tabs display an embedded image when one is available; otherwise, false. The default value is false.

IsActive

Gets whether the container is currently active, due to focus being within it.

public bool IsActive { get; }

Property Value

bool:

true if the container is currently active, due to focus being within it; otherwise, false. The default value is false.

IsTabLayoutAnimationEnabled

Gets or sets whether animation effects should be applied during tab layout, such as when tabs are added or removed.

public bool IsTabLayoutAnimationEnabled { get; set; }

Property Value

bool:

true if animation effects should be applied during tab layout, such as when tabs are added or removed; otherwise, false. The default value is false.

IsTabLayoutAnimationEnabledResolved

Gets whether animation effects are applied during tab layout, such as when tabs are added or removed.

public bool IsTabLayoutAnimationEnabledResolved { get; }

Property Value

bool:

true if animation effects are applied during tab layout, such as when tabs are added or removed; otherwise, false. The default value is false.

IsTabStripVisible

Gets whether the tabstrip is visible.

public bool IsTabStripVisible { get; protected set; }

Property Value

bool:

true if the tabstrip is visible; otherwise, false.

LogicalChildren

Gets an enumerator for logical child elements of this element.

protected override IEnumerator LogicalChildren { get; }

Property Value

IEnumerator:

An enumerator for logical child elements of this element.

MaxTabExtent

Gets or sets the maximum extent of a tab.

public double MaxTabExtent { get; set; }

Property Value

double:

The maximum extent of a tab. The default value is 260.0.

MinTabExtent

Gets or sets the minimum extent of a tab.

public double MinTabExtent { get; set; }

Property Value

double:

The minimum extent of a tab. The default value is 30.0.

SelectedWindow

Gets or sets the DockingWindow that is currently selected in the container.

public DockingWindow SelectedWindow { get; set; }

Property Value

DockingWindow:

The DockingWindow that is currently selected in the container.

State

Gets the DockingWindowState that specifies the current state of the container.

public DockingWindowState State { get; }

Property Value

DockingWindowState:

The DockingWindowState that specifies the current state of the container.

TabControl

Gets the tab control in the container's user interface.

protected AdvancedTabControl TabControl { get; }

Property Value

AdvancedTabControl:

The tab control in the container's user interface.

TabControlStyle

Gets or sets the Style to use for the contained TabControl.

public Style TabControlStyle { get; set; }

Property Value

Style:

The Style to use for the contained TabControl.

TabItemContainerStyle

Gets or sets the Style to use for rendering the tab item containers.

public Style TabItemContainerStyle { get; set; }

Property Value

Style:

The Style to use for rendering the tab item containers.

TabOverflowBehavior

Gets or sets the TabOverflowBehavior that indicates the logic to use in tab overflow scenarios.

public TabOverflowBehavior TabOverflowBehavior { get; set; }

Property Value

TabOverflowBehavior:

The TabOverflowBehavior that indicates the logic to use in tab overflow scenarios. The default value is Shrink.

TabStripPlacement

Gets or sets a Side indicating the side upon which the tabs are located.

public Side TabStripPlacement { get; set; }

Property Value

Side:

A Side indicating the side upon which the tabs are located. The default value is Bottom.

WindowsCore

Gets the collection of child DockingWindow objects.

protected ObservableCollection<DockingWindow> WindowsCore { get; }

Property Value

ObservableCollection<DockingWindow>:

The collection of child DockingWindow objects.

Methods

OnApplyTemplate()

Invoked whenever application code or internal processes call ApplyTemplate.

public override void OnApplyTemplate()

OnDockSiteChanged(DockSite, DockSite)

Occurs when the DockSite property is changed.

protected virtual void OnDockSiteChanged(DockSite oldDockSite, DockSite newDockSite)
Parameter Type Description
oldDockSite DockSite

The old value.

newDockSite DockSite

The new value.

OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs)

Reports that the IsKeyboardFocusWithin property changed.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)
Parameter Type Description
e DependencyPropertyChangedEventArgs

A DependencyPropertyChangedEventArgs that contains the event data.

OnSelectedWindowChanged(DockingWindow, DockingWindow)

Occurs when the SelectedWindow property is changed.

protected virtual void OnSelectedWindowChanged(DockingWindow oldSelectedWindow, DockingWindow newSelectedWindow)
Parameter Type Description
oldSelectedWindow DockingWindow

The old selected window.

newSelectedWindow DockingWindow

The new selected window.

OnTabControlMenuOpening(AdvancedTabControlMenuEventArgs)

Occurs when a menu on the tab control is opening.

protected virtual void OnTabControlMenuOpening(AdvancedTabControlMenuEventArgs e)
Parameter Type Description
e AdvancedTabControlMenuEventArgs

The AdvancedTabControlMenuEventArgs that contains the event data.

OnWindowsChanged(NotifyCollectionChangedEventArgs)

Occurs when the ActiproSoftware.Windows collection is changed.

protected virtual void OnWindowsChanged(NotifyCollectionChangedEventArgs e)
Parameter Type Description
e NotifyCollectionChangedEventArgs

A NotifyCollectionChangedEventArgs that contains the event data.

ToString()

Returns a String that represents the current Object.

public override string ToString()

Returns

string:

A String that represents the current Object.

UpdateCommands()

Updates the enabled states of the commands.

protected virtual void UpdateCommands()

UpdateDockingWindowStates()

Updates the DockingWindowState associated with all child docking windows.

protected abstract void UpdateDockingWindowStates()

UpdateIsTabStripVisible()

Updates the IsTabStripVisible property.

protected virtual void UpdateIsTabStripVisible()

UpdateTitleBarButtonVisibility()

Updates the title bar button visibility.

protected virtual void UpdateTitleBarButtonVisibility()

UpdateVisualState(bool)

Updates the visual state.

protected virtual void UpdateVisualState(bool useTransitions)
Parameter Type Description
useTransitions bool

Whether to use transitions.

ValidateChildType(DockingWindow)

Validates that the specified child DockingWindow type is valid for this container.

protected virtual void ValidateChildType(DockingWindow window)
Parameter Type Description
window DockingWindow

The DockingWindow to examine.

Fields

CanTabsCloseOnMiddleClickProperty

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

public static readonly DependencyProperty CanTabsCloseOnMiddleClickProperty

HasTabImagesProperty

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

public static readonly DependencyProperty HasTabImagesProperty

IsActiveProperty

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

public static readonly DependencyProperty IsActiveProperty

IsTabLayoutAnimationEnabledProperty

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

public static readonly DependencyProperty IsTabLayoutAnimationEnabledProperty

IsTabLayoutAnimationEnabledResolvedProperty

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

public static readonly DependencyProperty IsTabLayoutAnimationEnabledResolvedProperty

IsTabStripVisibleProperty

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

public static readonly DependencyProperty IsTabStripVisibleProperty

MaxTabExtentProperty

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

public static readonly DependencyProperty MaxTabExtentProperty

MinTabExtentProperty

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

public static readonly DependencyProperty MinTabExtentProperty

SelectedWindowProperty

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

public static readonly DependencyProperty SelectedWindowProperty

StateProperty

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

public static readonly DependencyProperty StateProperty

TabControlStyleProperty

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

public static readonly DependencyProperty TabControlStyleProperty

TabItemContainerStyleProperty

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

public static readonly DependencyProperty TabItemContainerStyleProperty

TabOverflowBehaviorProperty

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

public static readonly DependencyProperty TabOverflowBehaviorProperty

TabStripPlacementProperty

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

public static readonly DependencyProperty TabStripPlacementProperty