Table of Contents

Class LayoutContent

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

Provides an abstract base class for common properties and methods of the LayoutAnchorable and LayoutDocument classes.

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

Fields

ContentIdProperty 

public static readonly DependencyProperty ContentIdProperty

Field Value

DependencyProperty

TitleProperty 

public static readonly DependencyProperty TitleProperty

Field Value

DependencyProperty

Properties

CanClose 

public bool CanClose { get; set; }

Property Value

bool

CanFloat 

public bool CanFloat { get; set; }

Property Value

bool

CanShowOnHover

Set to false to disable the behavior of auto-showing a LayoutAnchorableControl on mouse over. When true, hovering the mouse over an anchorable tab will cause the anchorable to show itself.

public bool CanShowOnHover { get; set; }

Property Value

bool

Remarks

Defaults to true

Content 

public object Content { get; set; }

Property Value

object

ContentId 

public string ContentId { get; set; }

Property Value

string

FloatingHeight

Gets/sets the height of the floating window.

public double FloatingHeight { get; set; }

Property Value

double

FloatingLeft

Gets/sets the left position of the floating window.

public double FloatingLeft { get; set; }

Property Value

double

FloatingTop

Gets/sets the top position of the floating window.

public double FloatingTop { get; set; }

Property Value

double

FloatingWidth

Gets/sets the width of the floating window.

public double FloatingWidth { get; set; }

Property Value

double

IconSource 

public ImageSource IconSource { get; set; }

Property Value

ImageSource

IsActive 

public bool IsActive { get; set; }

Property Value

bool

IsEnabled 

public bool IsEnabled { get; set; }

Property Value

bool

IsFloating

Gets whether the content is currently floating or not.

[Bindable(true)]
public bool IsFloating { get; }

Property Value

bool

IsLastFocusedDocument 

public bool IsLastFocusedDocument { get; }

Property Value

bool

IsMaximized

Gets/sets whether the floating window is maximized or not.

public bool IsMaximized { get; set; }

Property Value

bool

IsSelected 

public bool IsSelected { get; set; }

Property Value

bool

LastActivationTimeStamp 

public DateTime? LastActivationTimeStamp { get; set; }

Property Value

DateTime?

PreviousContainer 

protected ILayoutContainer PreviousContainer { get; set; }

Property Value

ILayoutContainer

PreviousContainerId 

protected string PreviousContainerId { get; set; }

Property Value

string

PreviousContainerIndex 

public int PreviousContainerIndex { get; set; }

Property Value

int

TabItem 

public LayoutDocumentTabItem TabItem { get; }

Property Value

LayoutDocumentTabItem

Title 

public string Title { get; set; }

Property Value

string

ToolTip 

public object ToolTip { get; set; }

Property Value

object

Methods

Close()

Close the content

public abstract 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.

CompareTo(LayoutContent)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(LayoutContent other)

Parameters

other LayoutContent

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value Meaning
Less than zero This instance precedes other in the sort order.
Zero This instance occurs in the same position in the sort order as other.
Greater than zero This instance follows other in the sort order.

Dock()

Re-dock the content to its previous container

public void Dock()

DockAsDocument()

Dock the content as document.

public void DockAsDocument()

Float()

Float the content in a popup window

public void Float()

GetSchema()

This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.

public XmlSchema GetSchema()

Returns

XmlSchema

An XmlSchema that describes the XML representation of the object that is produced by the WriteXml(XmlWriter) method and consumed by the ReadXml(XmlReader) method.

InternalDock() 

protected virtual void InternalDock()

OnClosed() 

protected virtual void OnClosed()

OnClosing(CancelEventArgs) 

protected virtual void OnClosing(CancelEventArgs args)

Parameters

args CancelEventArgs

OnIsActiveChanged(bool, bool)

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

protected virtual void OnIsActiveChanged(bool oldValue, bool newValue)

Parameters

oldValue bool
newValue bool

OnIsSelectedChanged(bool, bool)

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

protected virtual void OnIsSelectedChanged(bool oldValue, bool newValue)

Parameters

oldValue bool
newValue bool

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

OnParentChanging(ILayoutContainer, ILayoutContainer)

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

protected override void OnParentChanging(ILayoutContainer oldValue, ILayoutContainer newValue)

Parameters

oldValue ILayoutContainer
newValue ILayoutContainer

ReadXml(XmlReader)

Generates an object from its XML representation.

public virtual void ReadXml(XmlReader reader)

Parameters

reader XmlReader

The XmlReader stream from which the object is deserialized.

WriteXml(XmlWriter)

Converts an object into its XML representation.

public virtual void WriteXml(XmlWriter writer)

Parameters

writer XmlWriter

The XmlWriter stream to which the object is serialized.

Events

Closed

Event fired when the content is closed (i.e. removed definitely from the layout).

public event EventHandler Closed

Event Type

EventHandler

Closing

Event fired when the content is about to be closed (i.e. removed definitely from the layout)

public event EventHandler<CancelEventArgs> Closing

Event Type

EventHandler<CancelEventArgs>

Remarks

Please note that LayoutAnchorable also can be hidden. Usually user hide anchorables when click the 'X' button. To completely close an anchorable the user should click the 'Close' menu item from the context menu. When an LayoutAnchorable is hidden its visibility changes to false and IsHidden property is set to true. Handle the Hiding event for the LayoutAnchorable to cancel the hide operation.

FloatingPropertiesUpdated

Event fired when floating properties were updated.

public event EventHandler FloatingPropertiesUpdated

Event Type

EventHandler

IsActiveChanged 

public event EventHandler IsActiveChanged

Event Type

EventHandler

IsSelectedChanged 

public event EventHandler IsSelectedChanged

Event Type

EventHandler
Edit this page