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

MdiHostBase Class

Namespace:
ActiproSoftware.Windows.Controls.Docking.Primitives
Assembly:
ActiproSoftware.Docking.Wpf.dll

Represents the base class for a container that hosts docking windows in an 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

The DockHost that contains this control.

public DockHost? DockHost { get; }

Property Value

DockHost

DockSite

The DockSite that is managing this control.

public DockSite? DockSite { get; }

Property Value

DockSite

IsEmpty

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

public bool IsEmpty { get; protected set; }

Property Value

bool:

The default value is true.

PrimaryWindow

The primary DockingWindow within the host.

public DockingWindow? PrimaryWindow { get; }

Property Value

DockingWindow:

The default value is null.

Methods

GetDocuments()

Returns the list of docking windows within the MDI.

public abstract IList<DockingWindow> GetDocuments()

Returns

IList<DockingWindow>

OnApplyTemplate()

When overridden in a derived class, is 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

Raised when PrimaryWindow is changed.

public event EventHandler<DockingWindowEventArgs> PrimaryWindowChanged

Event Type

EventHandler<DockingWindowEventArgs>

Fields

IsEmptyProperty

Defines the IsEmpty property.

public static readonly DependencyProperty IsEmptyProperty

PrimaryWindowChangedEvent

Defines the PrimaryWindowChanged event.

public static readonly RoutedEvent PrimaryWindowChangedEvent

PrimaryWindowProperty

Defines the PrimaryWindow property.

public static readonly DependencyProperty PrimaryWindowProperty

Extension Methods