LayoutDocumentFloatingWindow Class

In This Topic

Represents a floating window containing one or more documents in the layout model.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
<ContentPropertyAttribute("RootDocument")>
<TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
<NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
<SerializableAttribute()>
Public Class LayoutDocumentFloatingWindow 
   Inherits LayoutFloatingWindow
   Implements ILayoutContainer, ILayoutElement

'Usage
 
Dim instance As LayoutDocumentFloatingWindow

[ContentProperty("RootDocument")]
[TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
[NameScopeProperty("NameScope", System.Windows.NameScope)]
[Serializable()]
public class LayoutDocumentFloatingWindow : LayoutFloatingWindow, ILayoutContainer, ILayoutElement

Remarks

A LayoutDocumentFloatingWindow is created automatically when the end-user drags a document over the DockingManager (it can also be created programmatically using the Float method).

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.LayoutFloatingWindow
               Xceed.Wpf.AvalonDock.Layout.LayoutDocumentFloatingWindow

Public Constructors

	Name	Description
	LayoutDocumentFloatingWindow Constructor	Initializes a new instance of the LayoutAnchorableFloatingWindow class

Top

Public Properties

	Name	Description
	Children	Overridden. Gets the children of the floating window.
	ChildrenCount	Overridden. Gets the number of children.
	DependencyObjectType	(Inherited from System.Windows.DependencyObject)
	Dispatcher	(Inherited from System.Windows.Threading.DispatcherObject)
	IsSealed	(Inherited from System.Windows.DependencyObject)
	IsValid	Overridden. Gets whether the floating window is valid (whether RootDocument is null).
	Parent	Gets or sets the parent container of the element. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	Root	Gets or sets the root of the element. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	RootDocument	Gets or sets the root document contained in the floating window.

Top

Public Methods

	Name	Description
	ClearValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	CoerceValue	(Inherited from System.Windows.DependencyObject)
	Equals	(Inherited from System.Windows.DependencyObject)
	GetHashCode	(Inherited from System.Windows.DependencyObject)
	GetLocalValueEnumerator	(Inherited from System.Windows.DependencyObject)
	GetSchema	(Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutFloatingWindow)
	GetValue	(Inherited from System.Windows.DependencyObject)
	InvalidateProperty	(Inherited from System.Windows.DependencyObject)
	ReadLocalValue	(Inherited from System.Windows.DependencyObject)
	ReadXml	Overridden.
	RemoveChild	Overridden. Removes the child element
	ReplaceChild	Overridden. Replaces a specified child element with a specified new element.
	SetCurrentValue	(Inherited from System.Windows.DependencyObject)
	SetValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	WriteXml	(Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutFloatingWindow)

Top

Protected Methods

	Name	Description
	OnParentChanged	Provides derived classes an opportunity to handle changes to the Parent property. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	OnParentChanging	Provides derived classes an opportunity to execute code before the Parent property changes. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
	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)
	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
	ContainsChildOfType	Overloaded. Indicates whether a child of a specified type is contained in the ILayoutContainer.
	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.
	IsOfType<T,S>	Returns whether the specified container is of either of the specified types.
	ShowDialog	Overloaded.

Top

Public Events

	Name	Description
	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)
	RootDocumentChanged	Raised when RootDocument has changed.

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

LayoutDocumentFloatingWindow Members
Xceed.Wpf.AvalonDock.Layout Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference