LayoutAnchorable
| Model | Control | Wrapper |
|---|---|---|
| LayoutAnchorable | LayoutAnchorableControl | LayoutAnchorableItem |
Represents an anchorable object in the layout model.
A LayoutAnchorable 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 document.
A LayoutDocument (document) in turn, can also be docked in a (less) flexible manner but only inside one collection called DocumentsPane.
| Property | Description |
|---|---|
| AutoHideHeight | Gets or sets the minimal height to use when auto-hidden anchorables are shown for the first time. |
| AutoHideMinHeight | Gets or sets the height to use when auto-hidden anchorables are shown for the first time. |
| AutoHideMinWidth | Gets or sets the minimal width to use when auto-hidden anchorables are shown for the first time. |
| AutoHideWidth | Gets or sets the width to use when auto-hidden anchorables are shown for the first time. |
| CanAutoHide | Gets or sets whether an anchorable can be autohidden. |
| CanClose | Gets or sets whether the content can be closed definitively (removed from the layout and not just hidden). (Inherited from LayoutContent) |
| CanFloat | Gets whether the content can be moved to a floating window. (Inherited from LayoutContent) |
| CanHide | Gets or sets whether an anchorable can be hidden. |
| CanDockAsTabbedDocument | Determines whether a Layoutanchoreable (or inheriting object) can be docked in the document pane or not |
| Content | Gets or sets the content of the LayoutContent instance. (Inherited from LayoutContent) |
| ContentId | Gets or sets the ID of the content, which is used to identify the content during serialization/deserialization. (Inherited from LayoutContent) |
| 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 LayoutContent) |
| FloatingLeft | Gets or sets the left edge of a floating window that will contain this content. (Inherited from LayoutContent) |
| FloatingTop | Gets or sets the top edge of a floating window that will contain this content. (Inherited from 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 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) |
| IsAutoHidden | Gets whether the anchorable is anchored to a border in an autohidden state. |
| IsFloating | Gets or sets whether the content is in a floating window. (Inherited from LayoutContent) |
| IsHidden | Gets whether the anchorable can be hidden. |
| IsLastFocusedDocument | Gets whether the content is the last focused document. (Inherited from LayoutContent) |
| IsMaximized | Gets or sets whether a content element is maximized. (Inherited from LayoutContent) |
| IsSelected | Gets or sets whether a content element is selected. (Inherited from LayoutContent) |
| IsVisible | Gets or sets whether the anchorable is visible. |
| LastActivationTimeStamp | Gets or sets the date and time of the last activation of the content. (Inherited from LayoutContent) |
| Parent | Gets or 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 or sets the root of the element. (Inherited from LayoutElement) |
| Title | Gets or sets the title of the content. (Inherited from LayoutContent) |
| ToolTip | Gets or sets the tooltip of the content. (Inherited from LayoutContent) |
| 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) |
| Hiding | Raised when the anchorable has been hidden (usually by the end-user clicking on the "X" button). |
| IsActiveChanged | Raised when the IsActive property has changed. (Inherited from LayoutContent) |
| IsSelectedChanged | Raised when the IsSelected property has changed. (Inherited from LayoutContent) |
| IsVisibleChanged | Raised when the IsVisible property changes. |
| PropertyChanged | Raised when a property has changed. (Inherited from LayoutElement) |
| PropertyChanging | Raised when a property is about to change. (Inherited from LayoutElement) |
| Method | Description |
|---|---|
| AddToLayout | Add the anchorable to a DockingManager layout. |
| 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) |
| Hide | Hide this content and add it to the ILayoutRoot.Hidden collection of parent root. |
| ReadXml | Overridden. Reads serialized layout information using the specified XmlReader. |
| Show | Shows the content if it was previously hidden. |
| ToggleAutoHide | Toggles autohide state. |
| WriteXml | Overridden. Writes serialized layout information using the specified XmlWriter. |
A LayoutAnchorable (ToolWindow) can initially be collapsed to the side to which it is anchored, displaying only a tab, and the "pin" glyph is pointing to the left. If the pin glyph of an autohide anchorable is clicked so that the pin is pointing down, the anchorable is no longer autohidden and remains visible. Only LayoutAnchorable elements can be autohidden (LayoutDocument cannot AutoHide by design).
See also CanAutoHide, AutoHideHeight, AutoHideHeight, AutoHideMinWidth, AutoHideMinWidth properties of the Layoutanchorable class on this page