Skip to content

LayoutDocument

Dirkster99 edited this page Sep 4, 2020 · 21 revisions
Model Control Wrapper
LayoutDocument LayoutDocumentControl LayoutDocumentItem

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

Events

Event Description
Closed Raised when the content is closed (i.e., removed definitively from the layout). (Inherited from LayoutContent)
Closing Raised when the content is about to be closed (i.e. removed definitively from the layout). (Inherited from LayoutContent)
IsActiveChanged Raised when the IsActive property has changed. (Inherited from LayoutContent)
IsSelectedChanged Raised when the IsSelected property has changed. (Inherited from LayoutContent)
PropertyChanged Raised when a property has changed. (Inherited from LayoutElement)
PropertyChanging Raised when a property is about to change. (Inherited from 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 LayoutContent)
Dock Re-dock the content to its previous container. (Inherited from LayoutContent)
DockAsDocument Dock the content as document. (Inherited from LayoutContent)
Float Programmatically creates a floating window of the content. (Inherited from LayoutContent)
GetSchema Returns null. (Inherited from 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