Xceed Logo
Shop
Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.AvalonDock Assembly / Xceed.Wpf.AvalonDock.Layout Namespace / LayoutDocument Class
Members Example


In This Topic
    LayoutDocument Class
    In This Topic

    Represents a document in the layout model

    Syntax
    'Declaration
 
<ContentPropertyAttribute("Content")>
<TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
<NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
<SerializableAttribute()>
Public Class LayoutDocument 
   Inherits LayoutContent
   Implements ILayoutElement 
    'Usage
 
Dim instance As LayoutDocument
    [ContentProperty("Content")]
[TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
[NameScopeProperty("NameScope", System.Windows.NameScope)]
[Serializable()]
public class LayoutDocument : LayoutContent, ILayoutElement 
    Remarks

    A document is content that can be hosted only in a LayoutDocumentPane. This contrasts with the behavior of LayoutAnchorable, which can be hosted both in a LayoutDocumentPane and a LayoutAnchorablePane. Also, unlike anchorables, documents can't be anchored to a DockingManager border and can't be autohidden: they can only be positioned into a LayoutDocumentPane or floated in a LayoutDocumentFloatingWindow.

    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.

    Example
    The following shows how to use documents, as well as various other elements.
    <xcad:DockingManager Grid.Row="1" MaxHeight="425"
                     AllowMixedOrientation="True"
                     BorderBrush="Black"
                     BorderThickness="1">
  <xcad:DockingManager.DocumentHeaderTemplate>
    <DataTemplate>
      <StackPanel Orientation="Horizontal">
        <Image Source="{Binding IconSource}" Margin="0,0,4,0"/>
        <TextBlock Text="{Binding Title}" />
      </StackPanel>
    </DataTemplate>
  </xcad:DockingManager.DocumentHeaderTemplate>
  <xcad:LayoutRoot x:Name="_layoutRoot">
    <xcad:LayoutPanel Orientation="Horizontal">
      <xcad:LayoutAnchorablePane DockWidth="200">
        <xcad:LayoutAnchorable ContentId="properties" Title="Properties" CanHide="False" CanClose="False"
                                  AutoHideWidth="240"
                               IconSource="../Images/property-blue.png">
          <xctk:PropertyGrid NameColumnWidth="110"
             SelectedObject="{Binding ElementName=_layoutRoot, Path=LastFocusedDocument.Content}"/>
        </xcad:LayoutAnchorable>
      </xcad:LayoutAnchorablePane>
      <xcad:LayoutDocumentPaneGroup >
        <xcad:LayoutDocumentPane>
          <xcad:LayoutDocument ContentId="document1" Title="Document 1" IconSource="../Images/document.png" >
            <Button Content="Document 1 Content" HorizontalAlignment="Center" VerticalAlignment="Center"/>
          </xcad:LayoutDocument>
          <xcad:LayoutDocument ContentId="document2" Title="Document 2" IconSource="../Images/document.png">
            <TextBox Text="Document 2 Content" AcceptsReturn="True"/>
          </xcad:LayoutDocument>
        </xcad:LayoutDocumentPane>
      </xcad:LayoutDocumentPaneGroup >
      <xcad:LayoutAnchorablePaneGroup DockWidth="125">
        <xcad:LayoutAnchorablePane>
          <xcad:LayoutAnchorable ContentId="alarms" Title="Alarms" IconSource="../Images/alarm-clock-blue.png" >
            <ListBox>
              <s:String>Alarm 1</s:String>
              <s:String>Alarm 2</s:String>
              <s:String>Alarm 3</s:String>
            </ListBox>
          </xcad:LayoutAnchorable>
          <xcad:LayoutAnchorable ContentId="journal" Title="Journal" >
            <RichTextBox>
              <FlowDocument>
                <Paragraph FontSize="14" FontFamily="Segoe">
                  This is the content of the Journal Pane.
                  <LineBreak/>
                  A
                  <Bold>RichTextBox</Bold> has been added here
                </Paragraph>
              </FlowDocument>
            </RichTextBox>
          </xcad:LayoutAnchorable>
        </xcad:LayoutAnchorablePane>
      </xcad:LayoutAnchorablePaneGroup>
    </xcad:LayoutPanel>

    <xcad:LayoutRoot.LeftSide>
      <xcad:LayoutAnchorSide>
        <xcad:LayoutAnchorGroup>
          <xcad:LayoutAnchorable Title="Agenda" ContentId="agenda" IconSource="../Images/address-book-open.png">
            <TextBlock Text="Agenda Content" Margin="10" FontSize="18" FontWeight="Black" TextWrapping="Wrap"/>
          </xcad:LayoutAnchorable>
          <xcad:LayoutAnchorable Title="Contacts" ContentId="contacts" IconSource="../Images/address-book--pencil.png" >
            <TextBlock Text="Contacts Content" Margin="10" FontSize="18" FontWeight="Black" TextWrapping="Wrap"/>
          </xcad:LayoutAnchorable>
        </xcad:LayoutAnchorGroup>
      </xcad:LayoutAnchorSide>
    </xcad:LayoutRoot.LeftSide>
  </xcad:LayoutRoot>
</xcad: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.LayoutDocument

    Public Constructors
     NameDescription
    Public ConstructorLayoutDocument ConstructorInitializes a new instance of the LayoutDocument class.  
    Top
    Public Properties
     NameDescription
    Public PropertyCanCloseGets or sets whether the content can be closed definitively (removed from the layout and not just hidden). (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyCanFloatGets whether the content can be moved to a floating window. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyCanMoveGets or sets if the LayoutDocument can be re-ordered with the other LayoutDocuments.  
    Public PropertyCanTogglePinGets or sets if the LayoutDocument/LayoutAnchorable can use the toggle pin button when placed in a LayoutDocumentPane. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyContentGets or sets the content of the LayoutContent instance. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyContentId

    Gets or sets the ID of the content, which is used to identify the content during serialization/deserialization.

    (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyDependencyObjectType (Inherited from System.Windows.DependencyObject)
    Public PropertyDescription

    Gets or sets the document's description.

     
    Public PropertyDispatcher (Inherited from System.Windows.Threading.DispatcherObject)
    Public PropertyFloatingHeightGets or sets the height that will be initially used when the content is dragged and then displayed in a floating window. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyFloatingLeftGets or sets the left edge of a floating window that will contain this content. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyFloatingTopGets or sets the top edge of a floating window that will contain this content. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyFloatingWidthGets or sets the width that will be initially used when the content is dragged and then displayed in a floating window. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIconSourceGets the icon source of the content (displayed next on the tab). (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsActiveGets whether the content is active. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsEnabled

    Gets or sets a value indicating whether the LayoutDocument or LayoutAnchorable is enabled.

    (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsFloatingGets or sets whether the content is in a floating window. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsFloatingAsTopMostGets or sets if the LayoutAnchorable or LayoutDocument will appear over all other windows when floating. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsLastFocusedDocumentGets whether the content is the last focused document. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsMaximizedGets or sets whether a content element is maximized. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsPinnedGets if the LayoutDocument/LayoutAnchorable is currently pinned in a LayoutDocumentPane. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsSealed (Inherited from System.Windows.DependencyObject)
    Public PropertyIsSelectedGets or sets whether a content element is selected. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyIsVisibleGets or sets whether the document is visible.  
    Public PropertyLastActivationTimeStampGets or sets the date and time of the last activation of the content. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyParentGets or sets the parent container of the element. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
    Public PropertyPreviousContainerGets or sets the previous container of the content. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyPreviousContainerIdGets or sets the ID of the previous container. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyPreviousContainerIndexGets or sets the index of the previous container. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyRootGets or sets the root of the element. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
    Public PropertyTitleGets or sets the title of the content. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public PropertyToolTipGets or sets the tooltip of the content. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Top
    Public Methods
     NameDescription
    Public MethodClearValueOverloaded.  (Inherited from System.Windows.DependencyObject)
    Public MethodCloseOverridden.   
    Public MethodCoerceValue (Inherited from System.Windows.DependencyObject)
    Public MethodCompareToCompares 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 Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public MethodDockRe-dock the content to its previous container (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public MethodDockAsDocumentDock the content as document (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public MethodEquals (Inherited from System.Windows.DependencyObject)
    Public MethodFloatProgrammatically creates a floating window of the content. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public MethodGetHashCode (Inherited from System.Windows.DependencyObject)
    Public MethodGetLocalValueEnumerator (Inherited from System.Windows.DependencyObject)
    Public MethodGetSchemaReturns null. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public MethodGetValue (Inherited from System.Windows.DependencyObject)
    Public MethodInvalidateProperty (Inherited from System.Windows.DependencyObject)
    Public MethodReadLocalValue (Inherited from System.Windows.DependencyObject)
    Public MethodReadXmlOverridden. 

    Reads serialized layout information using the specified XmlReader

     
    Public MethodSetCurrentValue (Inherited from System.Windows.DependencyObject)
    Public MethodSetValueOverloaded.  (Inherited from System.Windows.DependencyObject)
    Public MethodTogglePinModifies the pin status of the LayoutDocument/LayoutAnchorable from unpinned to pinned (or vice-versa) in a LayoutDocumentPane. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public MethodWriteXmlOverridden. 

    Writes serialized layout information using the specified XmlWriter

     
    Top
    Protected Methods
     NameDescription
    Protected MethodInternalDockOverridden. 

    Docks the layout document.

     
    Protected MethodOnClosedCalled when the Closed event has been raised. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Protected MethodOnClosingCalled when the Closing event has been raised. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Protected MethodOnIsActiveChangedProvides derived classes an opportunity to handle changes to the IsActive property. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Protected MethodOnIsSelectedChangedProvides derived classes an opportunity to handle changes to the IsSelected property. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Protected MethodOnParentChangedCalled when Parent has changed. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Protected MethodOnParentChangingProvides an opportunity to execute code before Parent changes. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Protected MethodOnPropertyChanged (Inherited from System.Windows.DependencyObject)
    Protected MethodOnRootChangedProvides derived classes an opportunity to handle changes to the Root property. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
    Protected MethodOnToggledPin (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Protected MethodRaisePropertyChangedRaises the PropertyChanged event for the specified property name. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
    Protected MethodRaisePropertyChangingRaises the PropertyChanging event for the specified property name. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
    Protected Internal MethodShouldSerializeProperty (Inherited from System.Windows.DependencyObject)
    Top
    Public Events
     NameDescription
    Public EventClosedRaised when the content is closed (i.e., removed definitively from the layout). (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public EventClosingRaised when the content is about to be closed (i.e. removed definitively from the layout). (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public EventIsActiveChangedRaised when the IsActive property has changed. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public EventIsSelectedChangedRaised when the IsSelected property has changed. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Public EventPropertyChangedRaised when a property has changed. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
    Public EventPropertyChangingRaised when a property is about to change. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutElement)
    Public EventToggledPinRaised when a LayoutContent's pin is pinned or unpinned. (Inherited from Xceed.Wpf.AvalonDock.Layout.LayoutContent)
    Top
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    LayoutDocument Members
    Xceed.Wpf.AvalonDock.Layout Namespace

    Send Feedback