Table of Contents

Class LayoutAnchorable

Namespace
HeBianGu.Control.Dock.Layout
Assembly
HeBianGu.Control.Dock.dll

Implements the model for a layout anchorable control (tool window). A LayoutAnchorable can be anchored to the left, right, top, or bottom side of the Layout property of the DockingManager. It can contain custom application content (WPF controls) and other children elements.

[Serializable]
public class LayoutAnchorable : LayoutContent, ILayoutElement, INotifyPropertyChanged, INotifyPropertyChanging, IXmlSerializable, IComparable<LayoutContent>
Inheritance
LayoutAnchorable
Implements
Inherited Members
Extension Methods

Constructors

LayoutAnchorable()

Class constructor

public LayoutAnchorable()

Properties

AutoHideHeight

Gets/sets the height for this anchorable in AutoHide mode.

public double AutoHideHeight { get; set; }

Property Value

double

AutoHideMinHeight

Gets/sets the minimum height for this anchorable in AutoHide mode.

public double AutoHideMinHeight { get; set; }

Property Value

double

AutoHideMinWidth

Gets/sets the minimum width for this anchorable in AutoHide mode.

public double AutoHideMinWidth { get; set; }

Property Value

double

AutoHideWidth

Gets/sets the width for this anchorable in AutoHide mode.

public double AutoHideWidth { get; set; }

Property Value

double

CanAutoHide

Gets/sets whether the anchorable can be anchored to an achor side in an AutoHide status or not.

public bool CanAutoHide { get; set; }

Property Value

bool

CanDockAsTabbedDocument

Gets/sets whether the anchorable can be docked as a tabbed document or not.

public bool CanDockAsTabbedDocument { get; set; }

Property Value

bool

CanHide

Gets/sets whether the anchorable can hide (be invisible in the UI) or not.

public bool CanHide { get; set; }

Property Value

bool

CanMove

Gets/sets whether a document can be dragged (to be dropped in a different location) or not. Use this property in conjunction with CanMove and CanClose and CanDock to lock an anchorable in its layout position.

public bool CanMove { get; set; }

Property Value

bool

IsAutoHidden

Get a value indicating if the anchorable is anchored to an achor side in an AutoHide status or not.

public bool IsAutoHidden { get; }

Property Value

bool

IsHidden

Gets whether this object is in a state where it is not visible in the UI or not.

public bool IsHidden { get; }

Property Value

bool

IsVisible

Gets/sets whether this object is in a state where it is visible in the UI or not.

public bool IsVisible { get; set; }

Property Value

bool

Methods

AddToLayout(DockingManager, AnchorableShowStrategy)

Add the anchorable to a DockingManager layout.

public void AddToLayout(DockingManager manager, AnchorableShowStrategy strategy)

Parameters

manager DockingManager
strategy AnchorableShowStrategy

Close()

Close the content

public override void Close()

Remarks

Note that the anchorable is only hidden (not closed). By default when user click the X button it only hides the content.

ConsoleDump(int) 

public override void ConsoleDump(int tab)

Parameters

tab int

Hide() 

public void Hide()

InternalDock() 

protected override void InternalDock()

OnHiding(CancelEventArgs)

Method can be invoked to fire the Hiding event.

protected virtual void OnHiding(CancelEventArgs args)

Parameters

args CancelEventArgs

OnParentChanged(ILayoutContainer, ILayoutContainer)

Provides derived classes an opportunity to handle changes to the Parent property.

protected override void OnParentChanged(ILayoutContainer oldValue, ILayoutContainer newValue)

Parameters

oldValue ILayoutContainer
newValue ILayoutContainer

ReadXml(XmlReader)

Generates an object from its XML representation.

public override void ReadXml(XmlReader reader)

Parameters

reader XmlReader

The XmlReader stream from which the object is deserialized.

Show()

Show the content.

public void Show()

Remarks

Try to show the content where it was previously hidden.

ToggleAutoHide()

Reduce this object into an achored side panel position if it is currently docked or dock this object in the parent group if it is currently anchored in a side panel (AutoHide is active).

public void ToggleAutoHide()

WriteXml(XmlWriter)

Converts an object into its XML representation.

public override void WriteXml(XmlWriter writer)

Parameters

writer XmlWriter

The XmlWriter stream to which the object is serialized.

Events

Hiding 

public event EventHandler<CancelEventArgs> Hiding

Event Type

EventHandler<CancelEventArgs>

IsVisibleChanged

Event is invoked when the visibility of this object has changed.

public event EventHandler IsVisibleChanged

Event Type

EventHandler
Edit this page