Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail

MdiHostBase Class

In This Article
Namespace:
ActiproSoftware.Windows.Controls.Docking.Primitives
Assembly:
ActiproSoftware.Docking.Wpf.dll

Represents the base class for a container that hosts docking windows in a MDI (multiple-document interface).

public abstract class MdiHostBase : Control
Inheritance:
object Visual UIElement FrameworkElement Control object
Derived:
StandardMdiHost TabbedMdiHost

Constructors

MdiHostBase()

Initializes an instance of the class.

protected MdiHostBase()

Properties

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.

IsEmpty

Gets whether the host is currently empty (doesn't contain any visible documents).

public bool IsEmpty { get; protected set; }

Property Value

bool:

true if the host is currently empty (doesn't contain any visible documents); otherwise, false. The default value is true.

PrimaryWindow

Gets the primary DockingWindow within the host.

public DockingWindow PrimaryWindow { get; }

Property Value

DockingWindow:

The primary DockingWindow within the host. The default value is null.

Methods

GetDocuments()

Returns the list of docking windows within the MDI.

public abstract IList<DockingWindow> GetDocuments()

Returns

IList<DockingWindow>:

The list of docking windows within the MDI.

OnApplyTemplate()

Invoked whenever application code or internal processes call ApplyTemplate.

public override void OnApplyTemplate()

OnDockHostChanged(DockHost, DockHost)

Occurs when the value of the DockHost property has changed.

protected virtual void OnDockHostChanged(DockHost oldValue, DockHost newValue)
Parameter Type Description
oldValue DockHost

The old value.
newValue DockHost

The new value.

OnPrimaryWindowChanged(DockingWindow, DockingWindow)

Occurs when the value of the PrimaryWindow property has changed.

protected virtual void OnPrimaryWindowChanged(DockingWindow oldValue, DockingWindow newValue)
Parameter Type Description
oldValue DockingWindow

The old value.
newValue DockingWindow

The new value.

Events

PrimaryWindowChanged

Occurs when PrimaryWindow is changed.

public event EventHandler<DockingWindowEventArgs> PrimaryWindowChanged

Event Type

EventHandler<DockingWindowEventArgs>

Fields

IsEmptyProperty

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

public static readonly DependencyProperty IsEmptyProperty

PrimaryWindowChangedEvent

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

public static readonly RoutedEvent PrimaryWindowChangedEvent

PrimaryWindowProperty

Identifies the PrimaryWindow dependency property key. This field is read-only.

public static readonly DependencyProperty PrimaryWindowProperty