Skip to content

LayoutDocument

Dirkster99 edited this page May 14, 2019 · 21 revisions

A LayoutDocument (document) can be docked in a restricted but flexible manner inside one collection called DocumentsPane. This is usally the kind of content that should be used to display document like content (text, graphics etc).

A LayoutAnchorable (tool window) is in AvalonDock an element that can be anchored into a flexible position (eg.: bottom, top, left, right of MainWindow). Such a flexibility is usually required for a Tool Window since users should be able to dock a tool window around their documents.

Represents a document in the layout model.

Model Control
LayoutDocument LayoutDocumentControl

Properties

Property Description
CanClose Gets or sets whether the content can be closed definitively (removed from the layout and not just hidden). (Inherited from AvalonDock.Layout.LayoutContent)
CanFloat Gets whether the content can be moved to a floating window. (Inherited from AvalonDock.Layout.LayoutContent)
Content Gets or sets the content of the LayoutContent instance. (Inherited from AvalonDock.Layout.LayoutContent)
ContentId Gets or sets the ID of the content, which is used to identify the content during serialization/deserialization. (Inherited from AvalonDock.Layout.LayoutContent)
Description Gets or sets the document's description.
FloatingHeight Gets or sets the height that will be initially used when the content is dragged and then displayed in a floating window. (Inherited from AvalonDock.Layout.LayoutContent)
FloatingLeft Gets or sets the left edge of a floating window that will contain this content. (Inherited from AvalonDock.Layout.LayoutContent)
FloatingTop Gets or sets the top edge of a floating window that will contain this content. (Inherited from AvalonDock.Layout.LayoutContent)
FloatingWidth Gets or sets the width that will be initially used when the content is dragged and then displayed in a floating window. (Inherited from AvalonDock.Layout.LayoutContent)
IconSource Gets the icon source of the content (displayed next on the tab). (Inherited from AvalonDock.Layout.LayoutContent)
IsActive Gets whether the content is active. (Inherited from AvalonDock.Layout.LayoutContent)
IsFloating Gets or sets whether the content is in a floating window. (Inherited from AvalonDock.Layout.LayoutContent)
IsLastFocusedDocument Gets whether the content is the last focused document. (Inherited from AvalonDock.Layout.LayoutContent)
IsMaximized Gets or sets whether a content element is maximized. (Inherited from AvalonDock.Layout.LayoutContent)
IsSelected Gets or sets whether a content element is selected. (Inherited from AvalonDock.Layout.LayoutContent)
IsVisible Gets or sets whether the document is visible.
LastActivationTimeStamp Gets or sets the date and time of the last activation of the content. (Inherited from AvalonDock.Layout.LayoutContent)
Parent Gets or sets the parent container of the element. (Inherited from AvalonDock.Layout.LayoutElement)
PreviousContainerIndex Gets or sets the index of the previous container. (Inherited from AvalonDock.Layout.LayoutContent)
Root Gets or sets the root of the element. (Inherited from AvalonDock.Layout.LayoutElement)
Title Gets or sets the title of the content. (Inherited from AvalonDock.Layout.LayoutContent)
ToolTip Gets or sets the tooltip of the content. (Inherited from AvalonDock.Layout.LayoutContent)

Events

Event Description
Closed Raised when the content is closed (i.e., removed definitively from the layout). (Inherited from AvalonDock.Layout.LayoutContent)
Closing Raised when the content is about to be closed (i.e. removed definitively from the layout). (Inherited from AvalonDock.Layout.LayoutContent)
IsActiveChanged Raised when the IsActive property has changed. (Inherited from AvalonDock.Layout.LayoutContent)
IsSelectedChanged Raised when the IsSelected property has changed. (Inherited from AvalonDock.Layout.LayoutContent)
PropertyChanged Raised when a property has changed. (Inherited from AvalonDock.Layout.LayoutElement)
PropertyChanging Raised when a property is about to change. (Inherited from AvalonDock.Layout.LayoutElement)

Methods

Method Description
CompareTo Compares the content of the current instance with the content of the specified object. If it the content cannot be compared, the titles are compared. (Inherited from AvalonDock.Layout.LayoutContent)
Dock Re-dock the content to its previous container. (Inherited from AvalonDock.Layout.LayoutContent)
DockAsDocument Dock the content as document. (Inherited from AvalonDock.Layout.LayoutContent)
Float Programmatically creates a floating window of the content. (Inherited from AvalonDock.Layout.LayoutContent)
GetSchema Returns null. (Inherited from AvalonDock.Layout.LayoutContent)
ReadXml Overridden. Reads serialized layout information using the specified XmlReader.
WriteXml Overridden. Writes serialized layout information using the specified XmlWriter.

Demo Projects

Controls

Layout Models

Interfaces

Class Designs

Bugs

Manual Tests

Clone this wiki locally