Added comments for DockWidth/DockHeight

Dirkster99 · Oct 5, 2019 · 382ed52 · 382ed52
1 parent c64de19
commit 382ed52
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/source/Components/Xceed.Wpf.AvalonDock/Layout/LayoutPositionableGroup.cs b/source/Components/Xceed.Wpf.AvalonDock/Layout/LayoutPositionableGroup.cs
@@ -232,6 +232,12 @@ public double CalculatedDockMinWidth()
     #region DockMinWidth
 
     private double _dockMinWidth = 25.0;
+    /// <summary>
+    /// Defines the smallest available width that can be applied to a deriving element.
+    /// 
+    /// The system ensures the minimum width by blocking/limiting <see cref="GridSplitter"/>
+    /// movement when the user resizes a deriving element or resizes the main window.
+    /// </summary>
     public double DockMinWidth
     {
       get
@@ -274,6 +280,12 @@ public double CalculatedDockMinHeight()
     #region DockMinHeight
 
     private double _dockMinHeight = 25.0;
+    /// <summary>
+    /// Defines the smallest available height that can be applied to a deriving element.
+    /// 
+    /// The system ensures the minimum height by blocking/limiting <see cref="GridSplitter"/>
+    /// movement when the user resizes a deriving element or resizes the main window.
+    /// </summary>
     public double DockMinHeight
     {
       get

diff --git a/source/MLibTest/MLibTest/MainWindow.xaml b/source/MLibTest/MLibTest/MainWindow.xaml
@@ -166,7 +166,8 @@
                     <avalonDockLayout:LayoutRoot>
                         <avalonDockLayout:LayoutPanel Orientation="Vertical">
                             <avalonDockLayout:LayoutDocumentPane/>
-                            <avalonDockLayout:LayoutAnchorablePane Name="ToolsPane" DockHeight="150" DockMinWidth="250">
+                            <!-- Use DockMinWidth="250" to limit the size of a LayoutAnchorable -->
+                            <avalonDockLayout:LayoutAnchorablePane Name="ToolsPane" DockHeight="150">
                             </avalonDockLayout:LayoutAnchorablePane>
                         </avalonDockLayout:LayoutPanel>
                     </avalonDockLayout:LayoutRoot>

diff --git a/source/TestApp/MainWindow.xaml b/source/TestApp/MainWindow.xaml
@@ -77,7 +77,7 @@
             </avalonDock:DockingManager.DocumentHeaderTemplate>
             <avalonDock:LayoutRoot PropertyChanged="OnLayoutRootPropertyChanged">
                 <avalonDock:LayoutPanel Orientation="Horizontal">
-                    <avalonDock:LayoutAnchorablePane DockWidth="100">
+                    <avalonDock:LayoutAnchorablePane DockWidth="50">
                         <avalonDock:LayoutAnchorable x:Name="WinFormsWindow"  ContentId="WinFormsWindow" Title="WinForms Window" ToolTip="My WinForms Tool" CanHide="False" CanClose="False" >
                             <winformsIntegration:WindowsFormsHost x:Name="winFormsHost" Background="White"/>
                         </avalonDock:LayoutAnchorable>
@@ -95,7 +95,7 @@
                             </avalonDock:LayoutDocument>
                         </avalonDock:LayoutDocumentPane>
                     </avalonDock:LayoutDocumentPaneGroup>
-                    <avalonDock:LayoutAnchorablePaneGroup DockWidth="150">
+                    <avalonDock:LayoutAnchorablePaneGroup DockWidth="50">
                         <avalonDock:LayoutAnchorablePane>
                             <avalonDock:LayoutAnchorable ContentId="toolWindow1" Title="Tool Window 1" Hiding="OnToolWindow1Hiding">
                                 <StackPanel>