LayoutContent Class

In This Topic

Base class of the LayoutAnchorable and LayoutDocument classes.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
<ContentPropertyAttribute("Content")>
<TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
<NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
<SerializableAttribute()>
Public MustInherit Class LayoutContent 
   Inherits LayoutElement
   Implements ILayoutElement

'Usage
 
Dim instance As LayoutContent

[ContentProperty("Content")]
[TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
[NameScopeProperty("NameScope", System.Windows.NameScope)]
[Serializable()]
public abstract class LayoutContent : LayoutElement, ILayoutElement

Remarks

The LayoutAnchorable and LayoutDocument classes represent the fundamental content-containing classes in AvalonDock.

AvalonDock adheres to an MVVM design.

The Model is represented by the classes contained in the Xceed.Wpf.AvalonDock.Layout namespace. The classes in this namespace are the layout elements in a layout model (for example LayoutAnchorable/LayoutDocument, LayoutAnchorablePane/LayoutDocumentPane, LayoutAnchorablePaneGroup/LayoutDocumentPaneGroup, etc.) that are used directly in XAML within a DockingManager to describe how the layout is composed.

The View is represented by the classes contained in the Xceed.Wpf.AvalonDock.Controls namespace; these classes are a set of stylizable controls that show the user controls. The names of the view controls typically end with "Control" (for example, LayoutAnchorableControl is the view control, whereas LayoutAnchorable is the model element).

The DockingManager uses various classes (such as the LayoutItem and its derived classes) to perform the role of the ViewModel, preparing the model to be consumed by the view.

There is one and only one logical tree, which has the DockingManager as its root. Even if a control is placed in a different window (i.e., autohidden windows or floating windows), it always belong to the same logical tree below the DockingManager.

Inheritance Hierarchy

System.Object
   System.Windows.Threading.DispatcherObject
      System.Windows.DependencyObject
         Xceed.Wpf.AvalonDock.Layout.LayoutElement
            Xceed.Wpf.AvalonDock.Layout.LayoutContent
               Xceed.Wpf.AvalonDock.Layout.LayoutAnchorable
               Xceed.Wpf.AvalonDock.Layout.LayoutDocument

Public Fields

	Name	Description
	ContentIdProperty	Identifies the ContentId dependency property.
	TitleProperty	Identifies the Title dependency property.

Top

Public Properties

	Name	Description
	CanClose	Gets or sets whether the content can be closed definitively (removed from the layout and not just hidden).
	CanFloat	Gets whether the content can be moved to a floating window.
	CanTogglePin	Gets or sets if the LayoutDocument/LayoutAnchorable can use the toggle pin button when placed in a LayoutDocumentPane.
	Content	Gets or sets the content of the LayoutContent instance.
	ContentId	Gets or sets the ID of the content, which is used to identify the content during serialization/deserialization.
	DependencyObjectType	(Inherited from System.Windows.DependencyObject)
	Dispatcher	(Inherited from System.Windows.Threading.DispatcherObject)
	FloatingHeight	Gets or sets the height that will be initially used when the content is dragged and then displayed in a floating window.
	FloatingLeft	Gets or sets the left edge of a floating window that will contain this content.
	FloatingTop	Gets or sets the top edge of a floating window that will contain this content.
	FloatingWidth	Gets or sets the width that will be initially used when the content is dragged and then displayed in a floating window.
	IconSource	Gets the icon source of the content (displayed next on the tab).
	IsActive	Gets or sets whether the content is active.
	IsEnabled	Gets or sets a value indicating whether the LayoutDocument or LayoutAnchorable is enabled.
	IsFloating	Gets or sets whether the content is in a floating window.
	IsFloatingAsTopMost	Gets or sets if the LayoutAnchorable or LayoutDocument will appear over all other windows when floating.
	IsLastFocusedDocument	Gets whether the content is the last focused document.
	IsMaximized	Gets or sets whether a content element is maximized.
	IsPinned	Gets if the LayoutDocument/LayoutAnchorable is currently pinned in a LayoutDocumentPane.
	IsSealed	(Inherited from System.Windows.DependencyObject)
	IsSelected	Gets or sets whether a content element is selected.
	LastActivationTimeStamp	Gets or sets the date and time of the last activation of the content.
	Parent	Gets or sets the parent container of the element. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	PreviousContainer	Gets or sets the previous container of the content.
	PreviousContainerId	Gets or sets the ID of the previous container.
	PreviousContainerIndex	Gets or sets the index of the previous container.
	Root	Gets or sets the root of the element. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	Title	Gets or sets the title of the content.
	ToolTip	Gets or sets the tooltip of the content.

Top

Public Methods

	Name	Description
	ClearValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	Close	Close the content.
	CoerceValue	(Inherited from System.Windows.DependencyObject)
	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.
	Dock	Re-dock the content to its previous container
	DockAsDocument	Dock the content as document
	Equals	(Inherited from System.Windows.DependencyObject)
	Float	Programmatically creates a floating window of the content.
	GetHashCode	(Inherited from System.Windows.DependencyObject)
	GetLocalValueEnumerator	(Inherited from System.Windows.DependencyObject)
	GetSchema	Returns null.
	GetValue	(Inherited from System.Windows.DependencyObject)
	InvalidateProperty	(Inherited from System.Windows.DependencyObject)
	ReadLocalValue	(Inherited from System.Windows.DependencyObject)
	ReadXml	Reads serialized layout information using the specified XmlReader.
	SetCurrentValue	(Inherited from System.Windows.DependencyObject)
	SetValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	TogglePin	Modifies the pin status of the LayoutDocument/LayoutAnchorable from unpinned to pinned (or vice-versa) in a LayoutDocumentPane.
	WriteXml	Writes serialized layout information using the specified XmlWriter.

Top

Protected Methods

	Name	Description
	InternalDock	Docks the content.
	OnClosed	Called when the Closed event has been raised.
	OnClosing	Called when the Closing event has been raised.
	OnIsActiveChanged	Provides derived classes an opportunity to handle changes to the IsActive property.
	OnIsSelectedChanged	Provides derived classes an opportunity to handle changes to the IsSelected property.
	OnParentChanged	Overridden. Called when Parent has changed.
	OnParentChanging	Overridden. Provides an opportunity to execute code before Parent changes.
	OnPropertyChanged	(Inherited from System.Windows.DependencyObject)
	OnRootChanged	Provides derived classes an opportunity to handle changes to the Root property. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	OnToggledPin
	RaisePropertyChanged	Raises the PropertyChanged event for the specified property name. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	RaisePropertyChanging	Raises the PropertyChanging event for the specified property name. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	ShouldSerializeProperty	(Inherited from System.Windows.DependencyObject)

Top

Extension Methods

	Name	Description
	Descendents	Returns the descendents of the specified ILayoutElement.
	FindLogicalAncestor<T>	Finds the logical ancenster
	FindLogicalAncestorsAndSelf
	FindLogicalChildren<T>	Find the logical children.
	FindParent<T>	Finds the parent of the specified type of the specified ILayoutElement.
	FindVisualAncestor<T>	Finds the visual ancestor.
	FindVisualChildren<T>	Finds the visual children.
	FindVisualTreeRoot	Finds the visual tree root.
	GetRoot	Returns the root of the specified ILayoutElement.
	GetSide	Returns the anchor side of the specified ILayoutElement.
	ShowDialog	Overloaded.

Top

Public Events

	Name	Description
	Closed	Raised when the content is closed (i.e., removed definitively from the layout).
	Closing	Raised when the content is about to be closed (i.e. removed definitively from the layout).
	IsActiveChanged	Raised when the IsActive property has changed.
	IsSelectedChanged	Raised when the IsSelected property has changed.
	PropertyChanged	Raised when a property has changed. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	PropertyChanging	Raised when a property is about to change. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	ToggledPin	Raised when a LayoutContent's pin is pinned or unpinned.

Top

Supported Frameworks

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

LayoutContent Members
Xceed.Wpf.AvalonDock.Layout Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference