Browse Source
git-svn-id: svn://svn.sharpdevelop.net/sharpdevelop/trunk@58 1ccf3a8d-04fe-1044-b7c0-cef0b8235c61shortcuts
67 changed files with 2417 additions and 383 deletions
After Width: | Height: | Size: 318 B |
Binary file not shown.
@ -0,0 +1,39 @@
@@ -0,0 +1,39 @@
|
||||
<project SchemaVersion="1.3"> |
||||
<assemblies> |
||||
<assembly location=".\WinFormsUI\bin\Debug\WeifenLuo.WinFormsUI.Docking.dll" documentation=".\WinFormsUI\bin\Debug\CodeDoc.xml" /> |
||||
</assemblies> |
||||
<documenters> |
||||
<documenter name="JavaDoc"> |
||||
<property name="OutputDirectory" value=".\doc\" /> |
||||
</documenter> |
||||
<documenter name="LaTeX"> |
||||
<property name="OutputDirectory" value=".\doc\" /> |
||||
<property name="TextFileFullName" value="Documentation.tex" /> |
||||
<property name="TexFileBaseName" value="Documentation" /> |
||||
<property name="LatexCompiler" value="latex" /> |
||||
<property name="TexFileFullPath" value=".\doc\Documentation.tex" /> |
||||
</documenter> |
||||
<documenter name="LinearHtml"> |
||||
<property name="OutputDirectory" value=".\doc\" /> |
||||
<property name="Title" value="An NDoc Documented Class Library" /> |
||||
</documenter> |
||||
<documenter name="MSDN"> |
||||
<property name="OutputDirectory" value="..\doc\" /> |
||||
<property name="HtmlHelpName" value="DockPanel" /> |
||||
<property name="Title" value="DockPanel Class Library" /> |
||||
<property name="OutputTarget" value="HtmlHelp" /> |
||||
<property name="CopyrightText" value="Copyright Weifen Luo, All Rights Reserved." /> |
||||
<property name="FeedbackEmailAddress" value="weifenluo@yahoo.com" /> |
||||
<property name="Preliminary" value="True" /> |
||||
<property name="CleanIntermediates" value="True" /> |
||||
</documenter> |
||||
<documenter name="VS.NET 2003"> |
||||
<property name="OutputDirectory" value=".\doc\" /> |
||||
<property name="HtmlHelpName" value="Documentation" /> |
||||
<property name="Title" value="An NDoc documented library" /> |
||||
</documenter> |
||||
<documenter name="XML"> |
||||
<property name="OutputFile" value=".\doc\doc.xml" /> |
||||
</documenter> |
||||
</documenters> |
||||
</project> |
Binary file not shown.
@ -0,0 +1,75 @@
@@ -0,0 +1,75 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="InertButton"> |
||||
<ClassDef> |
||||
<summary>Image button with flat appearance, border visible only when activated by mouse.</summary> |
||||
</ClassDef> |
||||
<Constructor name="Overloads"> |
||||
<overloads> |
||||
<summary>Initializes a new instance of the <see cref="WeifenLuo.WinFormsUI.InertButton" /> class.</summary> |
||||
</overloads> |
||||
</Constructor> |
||||
<Constructor name="()"> |
||||
<summary>Initializes a new instance of the <see cref="WeifenLuo.WinFormsUI.InertButton" /> class, with default settings.</summary> |
||||
</Constructor> |
||||
<Constructor name="(Image)"> |
||||
<summary>Initializes a new instance of the <see cref="WeifenLuo.WinFormsUI.InertButton" /> class, with specified image for enabled button.</summary> |
||||
<param name="imageEnabled"> |
||||
The <see cref="System.Drawing.Image" /> object to show when the button is enabled. The disabled image will be draw based on this image. |
||||
</param> |
||||
</Constructor> |
||||
<Constructor name="(Image, Image)"> |
||||
<summary>Initializes a new instance of the <see cref="WeifenLuo.WinFormsUI.InertButton" /> class, with specified images for enabled and disabled button.</summary> |
||||
<param name="imageEnabled"> |
||||
The <see cref="System.Drawing.Image" /> object to show when the button is enabled. |
||||
</param> |
||||
<param name="imageDisabled"> |
||||
The <see cref="System.Drawing.Image" /> object to show when the button is disabled. |
||||
</param> |
||||
</Constructor> |
||||
<Property name="BorderColor"> |
||||
<summary>Gets or sets the border color for the control.</summary> |
||||
<value>A <see cref="System.Drawing.Color" /> object that represents the border color of the control.</value> |
||||
</Property> |
||||
<Property name="BorderWidth"> |
||||
<summary>Gets or sets the border width for the control.</summary> |
||||
<value>A integer that represents the border width for the control, in pixel. The default is <b>1</b>.</value> |
||||
</Property> |
||||
<Property name="ImageDisabled"> |
||||
<summary>Gets or sets the image to display for the control when disabled.</summary> |
||||
<value>A <see cref="System.Drawing.Image" /> object to display for the control when disabled.</value> |
||||
</Property> |
||||
<Property name="ImageEnabled"> |
||||
<summary>Gets or sets the image to display for the control when enabled.</summary> |
||||
<value>A <see cref="System.Drawing.Image" /> object to display for the control when enabled.</value> |
||||
</Property> |
||||
<Property name="ImageIndexDisabled"> |
||||
<summary>Gets or sets the index of the image to display for the control when disabled.</summary> |
||||
<value>The zero-base index of the image in the <see cref="System.Windows.Forms.ImageList" /> to display for the control when disabled.</value> |
||||
</Property> |
||||
<Property name="ImageIndexEnabled"> |
||||
<summary>Gets or sets the index of the image to display for the control when enabled.</summary> |
||||
<value>The zero-base index of the image in the <see cref="System.Windows.Forms.ImageList" /> to display for the control when enabled.</value> |
||||
</Property> |
||||
<Property name="ImageList"> |
||||
<summary>Gets or sets the <see cref="System.Windows.Forms.ImageList" /> that contains the images to display.</summary> |
||||
<value>The <see cref="System.Windows.Forms.ImageList" /> that contains the images to display.</value> |
||||
</Property> |
||||
<Property name="IsPopup"> |
||||
<summary>Determines if the buttons is displayed as popup when activated.</summary> |
||||
<value><b>True</b> if the button is displayed as popup when activated; otherwise <b>false</b>. The default value is <b>true</b>.</value> |
||||
</Property> |
||||
<Property name="Monochrome"> |
||||
<summary>Determines if the button is displayed as black and white.</summary> |
||||
<value><b>True</b> if the button is displayed as as black and white; otherwise <b>false</b>. The default value is <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="TextAlign"> |
||||
<summary>Gets or sets the alignment of the text in the button.</summary> |
||||
<value>One of the <see cref="System.Drawing.ContentAlignment" /> values. The default is <b>MiddleCenter</b>.</value> |
||||
</Property> |
||||
<Property name="ToolTipText"> |
||||
<summary>Gets or sets the ToolTip text for this button.</summary> |
||||
<value>The ToolTip text for this button.</value> |
||||
</Property> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,73 @@
@@ -0,0 +1,73 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name='DisplayingDockList'> |
||||
<ClassDef> |
||||
<summary>Maintains a list of visible nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<remarks> |
||||
<include file='Interfaces.xml' path='//Interface[@name="IDockListContainer"]/InterfaceDef/remarks/*' /> |
||||
</remarks> |
||||
<seealso cref="WeifenLuo.WinFormsUI.DockPane">DockPane Class</seealso> |
||||
</ClassDef> |
||||
<Property name="DockList"> |
||||
<summary>Gets the associated <b>DockList</b> object.</summary> |
||||
<value>A <see cref="WeifenLuo.WinFormsUI.DockList" /> object which associates with this <B>DisplayingDockList</B> object.</value> |
||||
</Property> |
||||
<Property name="Container"> |
||||
<summary>Gets the container which owns the associated <see cref="WeifenLuo.WinFormsUI.DockList" /> object.</summary> |
||||
<value>A <see cref="WeifenLuo.WinFormsUI.IDockListContainer" /> which contains the associated |
||||
<see cref="WeifenLuo.WinFormsUI.DockList" /> object.</value> |
||||
<seealso cref='WeifenLuo.WinFormsUI.DockList'>DockList Class</seealso> |
||||
</Property> |
||||
<Property name="DockState"> |
||||
<summary>Gets the docking state from the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList.Container" />.</summary> |
||||
<include file='Interfaces.xml' path='//Interface[@name="IDockListContainer"]/Property[@name="DockState"]/value' /> |
||||
</Property> |
||||
<Property name="IsFloat"> |
||||
<summary>Determines whether the the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList.Container" /> is floating.</summary> |
||||
<include file='Interfaces.xml' path='//Interface[@name="IDockListContainer"]/Property[@name="IsFloat"]/value' /> |
||||
</Property> |
||||
<Property name="Item"> |
||||
<summary> |
||||
<para>Gets a <see cref="WeifenLuo.WinFormsUI.DockPane"/> at the specified index.</para> |
||||
<para>In C#, this property is the indexer for the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList"/> class.</para> |
||||
</summary> |
||||
<param name="index"> |
||||
The zero-based <see cref="WeifenLuo.WinFormsUI.DockPane"/> to get. |
||||
</param> |
||||
<value> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> at the specified index. |
||||
</value> |
||||
</Property> |
||||
<Method name="Contains(DockPane)"> |
||||
<summary> |
||||
Determines whether a <see cref="WeifenLuo.WinFormsUI.DockPane" /> is in the |
||||
<see cref="WeifenLuo.WinFormsUI.DisplayingDockList" />. |
||||
</summary> |
||||
<param name="pane"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> to locate in |
||||
<see cref="WeifenLuo.WinFormsUI.DisplayingDockList" />. |
||||
</param> |
||||
<returns> |
||||
<b>true</b> if <paramref name="pane" /> is found in the |
||||
<see cref="WeifenLuo.WinFormsUI.DisplayingDockList" />; |
||||
otherwise, <b>false</b>. |
||||
</returns> |
||||
</Method> |
||||
<Method name="IndexOf(DockPane)"> |
||||
<summary> |
||||
Searches for the specified <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
and returns the zero-based index within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DisplayingDockList" />. |
||||
</summary> |
||||
<param name="pane"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
to locate in the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> |
||||
</param> |
||||
<returns> |
||||
The zero-based index of <paramref name="pane" /> within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DisplayingDockList" />, if found; |
||||
otherwise, -1. |
||||
</returns> |
||||
</Method> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,203 @@
@@ -0,0 +1,203 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="DockContent"> |
||||
<ClassDef> |
||||
<summary>The smallest dockable unit within the docking framework.</summary> |
||||
<remarks> |
||||
<para> |
||||
<see cref="DockContent" /> derives from <see cref="Form" /> class. |
||||
To use the DockPanel library, derive your form from <see cref="DockContent" /> class, |
||||
and implement your user interface in this class. There are several overloaded |
||||
<see cref="DockContent.Show" /> methods to show <see cref="DockContent" /> as specified docking state. |
||||
If <see cref="WeifenLuo.WinFormsUI.DockPanel.MdiIntegration" /> property is set to <b>true</b> and <see cref="DockContent.DockState" /> |
||||
is <see cref="WeifenLuo.WinFormsUI.DockState.Document" />, the menu of the form will be merged into to the main form automatically. |
||||
</para> |
||||
</remarks> |
||||
</ClassDef> |
||||
<Constructor name="()"> |
||||
<summary>Initialize a new DockContent instance.</summary> |
||||
</Constructor> |
||||
<Property name="AllowRedocking"> |
||||
<summary>Gets or sets to specify whether drag and drop re-docking is allowed.</summary> |
||||
<value><b>True</b> if drag and drop re-docking is allowed, otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="AutoHidePortion"> |
||||
<summary>Gets or sets to specify the portion of the screen size when showing in auto-hide mode.</summary> |
||||
<value>A value between 0 and 1 to specify the portion of the DockPanel to determine the size of the window when |
||||
displaying in auto-hide mode. The default value is 0.25 (25%).</value> |
||||
<exception cref="ArgumentOutOfRangeException">Thrown when value is not between 0 and 1.</exception> |
||||
</Property> |
||||
<Property name="CloseButton"> |
||||
<summary>Gets or sets to enalbe/disable the close button for this DockContent in the DockPane.</summary> |
||||
<value><b>True</b> to enable the close button; <b>false</b> to disable.</value> |
||||
</Property> |
||||
<Property name="DockableAreas"> |
||||
<summary>Gets or sets to specify the areas this DockContent can be displayed.</summary> |
||||
<value> |
||||
Combination of <see cref="DockAreas" /> values. |
||||
If <see cref="DockContent.DockState" /> conflicts with this value, a exception will be thrown. |
||||
</value> |
||||
</Property> |
||||
<Property name="DockPanel"> |
||||
<summary>Gets or sets to attach/detach the DockContent to DockPanel.</summary> |
||||
<value><see cref="WeifenLuo.WinFormsUI.DockPanel" /> object to attach. <b>Null</b> to detach this DockContent to any DockPanel.</value> |
||||
</Property> |
||||
<Property name="DockState"> |
||||
<summary>Gets or sets the docking state of <see cref="WeifenLuo.WinFormsUI.DockContent" />.</summary> |
||||
<value> |
||||
One of the <see cref="WeifenLuo.WinFormsUI.DockState" /> values: |
||||
<list type="table"> |
||||
<listheader> |
||||
<term>Value</term> |
||||
<term>Description</term> |
||||
</listheader> |
||||
<item> |
||||
<description> |
||||
<see cref="WeifenLuo.WinFormsUI.DockState.Unknown" /> |
||||
</description> |
||||
<description>Valid only when the <see cref="WeifenLuo.WinFormsUI.DockContent" /> is newly |
||||
initialized or detached from <see cref="WeifenLuo.WinFormsUI.DockPanel" />. Can not |
||||
be explicitly set.</description> |
||||
</item> |
||||
<item> |
||||
<description> |
||||
<see cref="WeifenLuo.WinFormsUI.DockState.Hidden" /> |
||||
</description> |
||||
<description>Synchronized with the <see cref="WeifenLuo.WinFormsUI.DockContent.IsHidden" /> property.</description> |
||||
</item> |
||||
<item> |
||||
<description> |
||||
<b>Others</b> |
||||
</description> |
||||
<description>Synchronized with the docking state of |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.Pane" />.</description> |
||||
</item> |
||||
</list> |
||||
</value> |
||||
<include file='DockContent.xml' path='//CodeDoc/Class[@name="DockContent"]/Property[@name="Pane"]/remarks' /> |
||||
</Property> |
||||
<Property name="FloatPane"> |
||||
<summary>Gets or sets the containing <see cref="WeifenLuo.WinFormsUI.DockPane" /> object when floating.</summary> |
||||
<value>The containing <see cref="WeifenLuo.WinFormsUI.DockPane" /> object when floating.</value> |
||||
<include file='DockContent.xml' path='//CodeDoc/Class[@name="DockContent"]/Property[@name="Pane"]/remarks' /> |
||||
</Property> |
||||
<Property name="HideOnClose"> |
||||
<summary>Gets or sets to determine when clicking the close button, the DockContent form should be closed or hidden.</summary> |
||||
<value><b>True</b> to hide the form when clicking the close button; otherwise, <b>false</b>. The default value is <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="IsActivated"> |
||||
<summary>Gets to specified the DockContent object is currently activated.</summary> |
||||
<value><b>True</b> if the DockContent object is currently activated, otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="IsFloat"> |
||||
<summary>Gets or sets whether the DockContent object is floating.</summary> |
||||
<value><b>True</b> if the DockContent object is floating; otherwise, false.</value> |
||||
</Property> |
||||
<Property name="IsHidden"> |
||||
<summary>Gets or sets whether the DockContent object is hidden.</summary> |
||||
<value><b>True</b> if the DockContent object is hidden; otherwise, false.</value> |
||||
</Property> |
||||
<Property name="Pane"> |
||||
<summary>Gets or sets the displayed containing <see cref="WeifenLuo.WinFormsUI.DockPane" /> object.</summary> |
||||
<value>The currently displayed containing <see cref="WeifenLuo.WinFormsUI.DockPane" /> object.</value> |
||||
<remarks> |
||||
A <see cref="WeifenLuo.WinFormsUI.DockContent" /> object can have two containing |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" /> objects: <see cref="WeifenLuo.WinFormsUI.DockContent.PanelPane" /> and |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.FloatPane" />. The <see cref="WeifenLuo.WinFormsUI.DockContent.Pane" /> |
||||
property returns currently displaying containing <see cref="WeifenLuo.WinFormsUI.DockPane" />. The docking state of a |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent" /> object is always synchronized with its displaying containing |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />. |
||||
</remarks> |
||||
</Property> |
||||
<Property name="PanelPane"> |
||||
<summary>Gets or sets the containing <see cref="WeifenLuo.WinFormsUI.DockPane" /> object when docked.</summary> |
||||
<value>The containing <see cref="WeifenLuo.WinFormsUI.DockPane" /> object when docked.</value> |
||||
<include file='DockContent.xml' path='//CodeDoc/Class[@name="DockContent"]/Property[@name="Pane"]/remarks' /> |
||||
</Property> |
||||
<Property name="ShowHint"> |
||||
<summary>Gets or sets the desired docking state for this DockContent object.</summary> |
||||
<value>One of the valid <see cref="WeifenLuo.WinFormsUI.DockState" /> values. This value should not |
||||
conflicts with <see cref="WeifenLuo.WinFormsUI.DockContent.DockableAreas" /> property.</value> |
||||
</Property> |
||||
<Property name="TabPageContextMenu"> |
||||
<summary>Gets or sets the context menu for the DockPane tab page.</summary> |
||||
<value>The <see cref="System.Windows.Forms.ContextMenu" /> for the DockPane tab page.</value> |
||||
</Property> |
||||
<Property name="TabText"> |
||||
<summary>Gets or sets the text to display for the DockPane tab strip.</summary> |
||||
<value>The text to display for the DockPane tab strip.</value> |
||||
<remarks>If this value is not set, the value of <see cref="Control.Text" /> will be used.</remarks> |
||||
</Property> |
||||
<Property name="ToolTipText"> |
||||
<summary>Gets or sets the tooltip text for this form.</summary> |
||||
<value>The tooltip text for this form.</value> |
||||
</Property> |
||||
<Property name="VisibleState"> |
||||
<summary>Gets or sets the visible docking state for this form.</summary> |
||||
<value>One of the <see cref="WeifenLuo.WinFormsUI.DockState" /> values for visible docking state of this form.</value> |
||||
</Property> |
||||
<Method name="Activate()"> |
||||
<summary>Activates the DockContent form and gives it focus.</summary> |
||||
<remarks>Activating the DockContent form makes it the <see cref="WeifenLuo.WinFormsUI.DockPane.ActiveContent" /> of its |
||||
containing <see cref="WeifenLuo.WinFormsUI.DockPane" />. To determine the active DockContent in an application, |
||||
use <see cref="WeifenLuo.WinFormsUI.DockPanel.ActiveContent" /> property. To determine the active document |
||||
content, use <see cref="WeifenLuo.WinFormsUI.DockPanel.ActiveDocument" /> property.</remarks> |
||||
</Method> |
||||
<Method name="GetPersistString()"> |
||||
<summary>Gets the string to persist this DockContent object.</summary> |
||||
<returns>The string to persist this DockContent object.</returns> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks' /> |
||||
</Method> |
||||
<Method name="IsDockStateValid(DockState)"> |
||||
<summary>Test with <see cref="WeifenLuo.WinFormsUI.DockContent.DockableAreas" /> to see whether the specified |
||||
<see cref="WeifenLuo.WinFormsUI.DockState" /> is valid.</summary> |
||||
<param name="dockState">The specified <see cref="WeifenLuo.WinFormsUI.DockState" /> value to test.</param> |
||||
</Method> |
||||
<Method name="OnDockStateChanged(EventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockContent.DockStateChanged" /> event.</summary> |
||||
<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="Show"> |
||||
<overloads> |
||||
<summary>Displays the form. Overloaded.</summary> |
||||
</overloads> |
||||
</Method> |
||||
<Method name="Show()"> |
||||
<summary>Displays the form, with default settings.</summary> |
||||
<remarks>If <see cref="WeifenLuo.WinFormsUI.DockContent.DockPanel"/> property is set, the form |
||||
will be displayed as <see cref="WeifenLuo.WinFormsUI.DockContent.ShowHint"/> docking state; |
||||
otherwise it will be displayed as normal form.</remarks> |
||||
</Method> |
||||
<Method name="Show(DockPane, DockAlignment, double)"> |
||||
<summary>Displays the form, as specified nested docking.</summary> |
||||
<param name="prevPane">The target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock.</param> |
||||
<param name="alignment">The edge of the target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock.</param> |
||||
<param name="proportion">The proportion size of the source <see cref="WeifenLuo.WinFormsUI.DockPane"/> to take |
||||
inside the target <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</param> |
||||
</Method> |
||||
<Method name="Show(DockPane, DockContent)"> |
||||
<summary>Displays the form, at the specified tab location of DockPane</summary> |
||||
<param name="pane">The target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to contain this DockContent.</param> |
||||
<param name="beforeContent">The position to show in the tab strip of the <see cref="WeifenLuo.WinFormsUI.DockPane"/>. |
||||
<b>Null</b> to show at the last position in the tab strip. |
||||
</param> |
||||
</Method> |
||||
<Method name="Show(DockPanel)"> |
||||
<summary>Displays the form, attaching to specified DockPanel.</summary> |
||||
<param name="dockPanel">The <see cref="WeifenLuo.WinFormsUI.DockPanel"/> object to attach.</param> |
||||
</Method> |
||||
<Method name="Show(DockPanel, Rectangle)"> |
||||
<summary>Displays the form, as floating window at the specified location and size.</summary> |
||||
<param name="dockPanel">The <see cref="WeifenLuo.WinFormsUI.DockPanel"/> object to attach.</param> |
||||
<param name="floatWindowBounds">The bounds of the floating window.</param> |
||||
</Method> |
||||
<Method name="Show(DockPanel, DockState)"> |
||||
<summary>Displays the form, with specified docking state.</summary> |
||||
<param name="dockPanel">The <see cref="WeifenLuo.WinFormsUI.DockPanel"/> object to attach.</param> |
||||
<param name="dockState">The docking state to display.</param> |
||||
</Method> |
||||
<Event name="DockStateChanged"> |
||||
<summary>Occurs when the <see cref="WeifenLuo.WinFormsUI.DockContent.DockState"/> property changed.</summary> |
||||
</Event> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,46 @@
@@ -0,0 +1,46 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="DockContentCollection"> |
||||
<ClassDef> |
||||
<summary>Provides methods to manage a collection of <see cref="WeifenLuo.WinFormsUI.DockContent" /> objects.</summary> |
||||
</ClassDef> |
||||
<Property name="Item"> |
||||
<summary> |
||||
<para>Gets a <see cref="WeifenLuo.WinFormsUI.DockContent" /> at the specified index.</para> |
||||
<para>In C#, this property is the indexer for the <see cref="WeifenLuo.WinFormsUI.DockContentCollection" /> class.</para> |
||||
</summary> |
||||
</Property> |
||||
<Method name="Contains(DockContent)"> |
||||
<summary> |
||||
Determines whether a <see cref="WeifenLuo.WinFormsUI.DockContent" /> is in the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContentCollection" />. |
||||
</summary> |
||||
<param name="content"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockContent" /> to locate in |
||||
<see cref="WeifenLuo.WinFormsUI.DockContentCollection" />. |
||||
</param> |
||||
<returns> |
||||
<b>true</b> if <paramref name="content" /> is found in the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContentCollection" />; |
||||
otherwise, <b>false</b>. |
||||
</returns> |
||||
</Method> |
||||
<Method name="IndexOf(DockContent)"> |
||||
<summary> |
||||
Searches for the specified <see cref="WeifenLuo.WinFormsUI.DockContent" /> |
||||
and returns the zero-based index within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DockContentCollection" />. |
||||
</summary> |
||||
<param name="content"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockContent" /> |
||||
to locate in the <see cref="WeifenLuo.WinFormsUI.DockContentCollection" /> |
||||
</param> |
||||
<returns> |
||||
The zero-based index of <paramref name="content" /> within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DockContentCollection" />, if found; |
||||
otherwise, -1. |
||||
</returns> |
||||
</Method> |
||||
<Method name="Select(DockState)"></Method> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,86 @@
@@ -0,0 +1,86 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name='DockList'> |
||||
<ClassDef> |
||||
<summary>Maintains a list of nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<remarks> |
||||
<include file='Interfaces.xml' path='//Interface[@name="IDockListContainer"]/InterfaceDef/remarks/*' /> |
||||
</remarks> |
||||
<seealso cref="WeifenLuo.WinFormsUI.DockPane">DockPane Class</seealso> |
||||
</ClassDef> |
||||
<Property name="DisplayingList"> |
||||
<summary>Gets the associated <b>DisplayingDockList</b> object.</summary> |
||||
<value>A <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> object which associates with this <B>DockList</B> object.</value> |
||||
</Property> |
||||
<Property name="Container"> |
||||
<summary>Gets the container which owns this <see cref='WeifenLuo.WinFormsUI.DockList' /> object.</summary> |
||||
<value>A <see cref='WeifenLuo.WinFormsUI.IDockListContainer' /> which contains this <see cref='WeifenLuo.WinFormsUI.DockList' /> object.</value> |
||||
<seealso cref='WeifenLuo.WinFormsUI.DisplayingDockList'>DisplayingDockList Class</seealso> |
||||
</Property> |
||||
<Property name="DockState"> |
||||
<summary>Gets the docking state from the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList.Container" />.</summary> |
||||
<include file='Interfaces.xml' path='//Interface[@name="IDockListContainer"]/Property[@name="DockState"]/value' /> |
||||
</Property> |
||||
<Property name="IsFloat"> |
||||
<summary>Determines whether the the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList.Container" /> is floating.</summary> |
||||
<include file='Interfaces.xml' path='//Interface[@name="IDockListContainer"]/Property[@name="IsFloat"]/value' /> |
||||
</Property> |
||||
<Property name="Item"> |
||||
<summary> |
||||
<para>Gets a <see cref="WeifenLuo.WinFormsUI.DockPane" /> at the specified index.</para> |
||||
<para>In C#, this property is the indexer for the <see cref="WeifenLuo.WinFormsUI.DockList" /> class.</para> |
||||
</summary> |
||||
<param name="index"> |
||||
The zero-based <see cref="WeifenLuo.WinFormsUI.DockPane" /> to get. |
||||
</param> |
||||
<value> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> at the specified index. |
||||
</value> |
||||
</Property> |
||||
<Method name="Contains(DockPane)"> |
||||
<summary> |
||||
Determines whether a <see cref="WeifenLuo.WinFormsUI.DockPane" /> is in the |
||||
<see cref="WeifenLuo.WinFormsUI.DockList" />. |
||||
</summary> |
||||
<param name="pane"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> to locate in |
||||
<see cref="WeifenLuo.WinFormsUI.DockList" />. |
||||
</param> |
||||
<returns> |
||||
<b>true</b> if <paramref name="pane" /> is found in the |
||||
<see cref="WeifenLuo.WinFormsUI.DockList" />; |
||||
otherwise, <b>false</b>. |
||||
</returns> |
||||
</Method> |
||||
<Method name="IndexOf(DockPane)"> |
||||
<summary> |
||||
Searches for the specified <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
and returns the zero-based index within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DockList" />. |
||||
</summary> |
||||
<param name="pane"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
to locate in the <see cref="WeifenLuo.WinFormsUI.DockList" /> |
||||
</param> |
||||
<returns> |
||||
The zero-based index of <paramref name="pane" /> within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DockList" />, if found; |
||||
otherwise, -1. |
||||
</returns> |
||||
</Method> |
||||
<Method name="GetDefaultPrevPane(DockPane)"> |
||||
<summary> |
||||
Gets the default <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
in this <see cref="WeifenLuo.WinFormsUI.DockList" /> to dock inside. |
||||
</summary> |
||||
<param name="pane"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
to add to this <see cref="WeifenLuo.WinFormsUI.DockList" />. |
||||
</param> |
||||
<returns> |
||||
The default <see cref="WeifenLuo.WinFormsUI.DockPane" /> for <paramref name="pane" /> to dock inside, |
||||
<b>null</b> if this <see cref="WeifenLuo.WinFormsUI.DockList" /> is empty. |
||||
</returns> |
||||
</Method> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,276 @@
@@ -0,0 +1,276 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="DockPane"> |
||||
<ClassDef> |
||||
<summary>The containing window for a collection of <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms |
||||
displayed in a tabbed manner.</summary> |
||||
<remarks> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="Contents"]/remarks/*' /> |
||||
<para> |
||||
There are two types of <see cref="WeifenLuo.WinFormsUI.DockPane" /> in appearance: |
||||
<see cref="AppearanceStyle.ToolWindow" /> and <see cref="AppearanceStyle.Document" />, |
||||
determined by the docking state of the <see cref="WeifenLuo.WinFormsUI.DockPane" />. |
||||
</para> |
||||
<para> |
||||
You can derive your own class from <see cref="WeifenLuo.WinFormsUI.DockPane" /> to make |
||||
your own customizations. If so, you need to override the <see cref="WeifenLuo.WinFormsUI.DockPanel.DockPaneFactory" /> |
||||
property to return the instance of your own class. |
||||
</para> |
||||
</remarks> |
||||
</ClassDef> |
||||
<Constructor name="Overloads"> |
||||
<overloads> |
||||
<summary>Initializes a new instance of DockPane class.</summary> |
||||
</overloads> |
||||
</Constructor> |
||||
<Constructor name="(DockContent, DockState, bool)"> |
||||
<summary>Initializes a new instance of DockPane class, with specified visible docking state.</summary> |
||||
<param name="content">The first DockContent for this DockPane.</param> |
||||
<param name="visibleState">The visible docking state for this DockPane.</param> |
||||
<param name="show"><b>True</b> to show the <paramref name="content" />, otherwise, <b>false</b>.</param> |
||||
</Constructor> |
||||
<Constructor name="(DockContent, FloatWindow, bool)"> |
||||
<summary>Initializes a new instance of DockPane class, as nested docking to specified FloatWindow.</summary> |
||||
<param name="content">The first DockContent for this DockPane.</param> |
||||
<param name="floatWindow">The <see cref="WeifenLuo.WinFormsUI.FloatWindow"/> for nested docking.</param> |
||||
<param name="show"><b>True</b> to show the <paramref name="content" />, otherwise, <b>false</b>.</param> |
||||
</Constructor> |
||||
<Constructor name="(DockContent, DockPane, DockAlignment, double, bool)"> |
||||
<summary>Initializes a new instance of DockPane class, as specified nested docking.</summary> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, DockState, bool)"]/param[@name="content"]' /> |
||||
<param name="prevPane">The target <see cref="WeifenLuo.WinFormsUI.DockPane" /> to dock.</param> |
||||
<param name="alignment">The edge of the target <see cref="WeifenLuo.WinFormsUI.DockPane" /> to dock.</param> |
||||
<param name="proportion">The proportion size of the source <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
to take inside the target <see cref="WeifenLuo.WinFormsUI.DockPane" />.</param> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, DockState, bool)"]/param[@name="show"]' /> |
||||
</Constructor> |
||||
<Constructor name="(DockContent, Rectangle, bool)"> |
||||
<summary>Initializes a new instance of DockPane class, as floating at the specified bounds.</summary> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, DockState, bool)"]/param[@name="content"]' /> |
||||
<param name="floatWindowBounds">The bounds of the floating window.</param> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, DockState, bool)"]/param[@name="show"]' /> |
||||
</Constructor> |
||||
<Property name="ActiveContent"> |
||||
<summary>Gets or sets the currently active <see cref="WeifenLuo.WinFormsUI.DockContent" /> form.</summary> |
||||
<value>The currently active <see cref="WeifenLuo.WinFormsUI.DockContent" /> form.</value> |
||||
</Property> |
||||
<Property name="AllowRedocking"> |
||||
<summary>Gets or sets to specify whether drag and drop re-docking is allowed.</summary> |
||||
<value><b>True</b> if drag and drop re-docking is allowed, otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="CaptionText"> |
||||
<summary>Gets the text displayed for the caption.</summary> |
||||
<value>The text displayed for the caption.</value> |
||||
<remarks>The default implementation returns the <see cref="System.Windows.Forms.Control.Text" /> property |
||||
of current active <see cref="WeifenLuo.WinFormsUI.DockContent" /> form. You can override this |
||||
property to provide your own implementation.</remarks> |
||||
</Property> |
||||
<Property name="Contents"> |
||||
<summary>Gets the collection of contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockContentCollection" /> which contains all the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent" /> forms for this <see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
<remarks> |
||||
<para> |
||||
A <see cref="WeifenLuo.WinFormsUI.DockContent" /> object can be added to the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" /> by various of ways: |
||||
<list type="number"> |
||||
<item> |
||||
<description>Calling one of <see cref="WeifenLuo.WinFormsUI.DockPane" /> class's constructors, |
||||
providing the <see cref="WeifenLuo.WinFormsUI.DockContent" /> object as parameter. |
||||
</description> |
||||
</item> |
||||
<item> |
||||
<description>Explicitly setting one of the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.Pane" />, |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.PanelPane" /> or |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.FloatPane" /> properties |
||||
of <see cref="WeifenLuo.WinFormsUI.DockContent" /> class. |
||||
</description> |
||||
</item> |
||||
<item> |
||||
<description>Implicitly setting the docking state of the <see cref="WeifenLuo.WinFormsUI.DockContent" />, |
||||
for example, calling one of the <see cref="WeifenLuo.WinFormsUI.DockContent.Show" /> methods. |
||||
</description> |
||||
</item> |
||||
</list> |
||||
You can access the contained collection of |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent" /> forms through the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane.Contents" /> property of class |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />, and you can access a |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent" />'s containing |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" /> through its |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.Pane" />, |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.PanelPane" /> or |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.FloatPane" /> properties. |
||||
</para> |
||||
<para>If there is no <see cref="WeifenLuo.WinFormsUI.DockContent" /> in |
||||
this <see cref="WeifenLuo.WinFormsUI.DockPane" />, |
||||
this <see cref="WeifenLuo.WinFormsUI.DockPane" /> will be disposed automatically. |
||||
</para> |
||||
</remarks> |
||||
</Property> |
||||
<Property name="CountOfVisibleContents"> |
||||
<summary>Gets the count of visible <see cref="WeifenLuo.WinFormsUI.DockContent" /> objects.</summary> |
||||
<value>Gets the count of visible <see cref="WeifenLuo.WinFormsUI.DockContent" /> objects.</value> |
||||
</Property> |
||||
<Property name="DockListContainer"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.IDockListContainer" /> which contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.IDockListContainer" /> which contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="IsFloat"]/remarks' /> |
||||
</Property> |
||||
<Property name="DockPanel"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DockPanel" /> associated with this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</summary> |
||||
<value>the <see cref="WeifenLuo.WinFormsUI.DockPanel" /> associated with this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
</Property> |
||||
<Property name="DockState"> |
||||
<summary>Gets the docking state of this <see cref="WeifenLuo.WinFormsUI.DockPane" />.</summary> |
||||
<value>The docking state of this <see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
</Property> |
||||
<Property name="DockWindow"> |
||||
<summary>Gets or sets the <see cref="WeifenLuo.WinFormsUI.DockWindow" /> contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</summary> |
||||
<value>Gets or sets the <see cref="WeifenLuo.WinFormsUI.DockWindow" /> contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="IsFloat"]/remarks' /> |
||||
</Property> |
||||
<Property name="FloatWindow"> |
||||
<summary>Gets or sets the <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</summary> |
||||
<value>Gets or sets the <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Property[@name="IsFloat"]/remarks' /> |
||||
</Property> |
||||
<Property name="IsActivated"> |
||||
<summary>Gets whether this <see cref="WeifenLuo.WinFormsUI.DockPane" /> is activated.</summary> |
||||
<value><b>True</b> if this <see cref="WeifenLuo.WinFormsUI.DockPane" /> is activated, |
||||
otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="IsActiveDocumentPane"> |
||||
<summary>Gets whether this <see cref="WeifenLuo.WinFormsUI.DockPane" /> is active document pane.</summary> |
||||
<value><b>True</b> if this <see cref="WeifenLuo.WinFormsUI.DockPane" /> is active document pan, |
||||
otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="IsAutoHide"> |
||||
<summary>Gets whether the docking state is auto hide.</summary> |
||||
<value><b>True</b> if the docking state is auto hide, |
||||
otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="IsFloat"> |
||||
<summary>Gets whether this <see cref="WeifenLuo.WinFormsUI.DockPane" /> is floating.</summary> |
||||
<value><b>True</b> if this <see cref="WeifenLuo.WinFormsUI.DockPane" /> is floating, |
||||
otherwise, <b>false</b>.</value> |
||||
<remarks> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane.IsFloat" /> property is fixed during the construction |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" /> class, based on the initial docking state. If this |
||||
property returns <b>true</b>, it can only be contained by a <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> |
||||
as its <see cref="WeifenLuo.WinFormsUI.DockPane.DockListContainer" />; otherwise it can only be contained |
||||
by a <see cref="WeifenLuo.WinFormsUI.DockWindow" /> as its |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane.DockListContainer" />. |
||||
</remarks> |
||||
</Property> |
||||
<Property name="IsHidden"> |
||||
<summary>Gets whether all the contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms |
||||
are invisible in this <see cref="WeifenLuo.WinFormsUI.DockPane" />.</summary> |
||||
<value><b>True</b> if all the contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms |
||||
are invisible in this <see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
</Property> |
||||
<Property name="NestedDockingStatus"> |
||||
<summary>Gets the nested docking status for this <see cref="WeifenLuo.WinFormsUI.NestedDockingStatus" />.</summary> |
||||
<value>A <see cref="WeifenLuo.WinFormsUI.NestedDockingStatus" /> object to represent |
||||
the nested docking status for this <see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
</Property> |
||||
<Method name="Activate()"> |
||||
<summary>Activates the DockPane and gives it focus.</summary> |
||||
</Method> |
||||
<Method name="AddToDockList"> |
||||
<overloads> |
||||
<summary>Nested docks this <see cref="WeifenLuo.WinFormsUI.DockPane" /> to the specified |
||||
<see cref="WeifenLuo.WinFormsUI.IDockListContainer" />.</summary> |
||||
</overloads> |
||||
</Method> |
||||
<Method name="AddToDockList(IDockListContainer)"> |
||||
<summary>Nested docks this <see cref="WeifenLuo.WinFormsUI.DockPane" /> to the specified |
||||
<see cref="WeifenLuo.WinFormsUI.IDockListContainer" />, with default settings.</summary> |
||||
<param name="container">The <see cref="WeifenLuo.WinFormsUI.IDockListContainer" /> for the |
||||
nested docking.</param> |
||||
<returns>If the <see cref="WeifenLuo.WinFormsUI.DockPane.IsFloat" /> property conforms to |
||||
the container's docking state, the current <see cref="WeifenLuo.WinFormsUI.DockPane" /> object |
||||
will be returned; otherwise, a new instance of <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
object will be created and returned.</returns> |
||||
</Method> |
||||
<Method name="AddToDockList(IDockListContainer, DockPane, DockAlignment, double)"> |
||||
<summary>Nested docks this <see cref="WeifenLuo.WinFormsUI.DockPane" /> to the specified |
||||
<see cref="WeifenLuo.WinFormsUI.IDockListContainer" />, with specified settings.</summary> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Method[@name="AddToDockList(IDockListContainer)"]/param[@name="container"]' /> |
||||
<param name="prevPane"></param> |
||||
<param name="alignment"></param> |
||||
<param name="proportion"></param> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Method[@name="AddToDockList(IDockListContainer)"]/returns' /> |
||||
</Method> |
||||
<Method name="Float()"> |
||||
<summary>Shows all contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms as floating.</summary> |
||||
<returns>The new floating <see cref="WeifenLuo.WinFormsUI.DockPane" /> for the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent" /> forms.</returns> |
||||
</Method> |
||||
<Method name="GetVisibleContent(int)"> |
||||
<summary>Gets the visible <see cref="WeifenLuo.WinFormsUI.DockContent" /> form at the specified |
||||
index.</summary> |
||||
<param name="index">The zero-based index for the visible <see cref="WeifenLuo.WinFormsUI.DockContent" /> form to |
||||
retrieve.</param> |
||||
<returns>The visible <see cref="WeifenLuo.WinFormsUI.DockContent" /> form at the specified |
||||
index.</returns> |
||||
</Method> |
||||
<Method name="IsDockStateValid(DockState)"> |
||||
<summary>Tests if the giving docking state conforms to the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.DockableAreas" /> property of all the |
||||
contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms.</summary> |
||||
<param name="dockState"></param> |
||||
<returns><b>True</b> if the giving docking state conforms to the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.DockableAreas" /> property of all the |
||||
contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms; otherwise, <b>false</b>.</returns> |
||||
</Method> |
||||
<Method name="OnDockStateChanged(EventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPane.DockStateChanged" /> event.</summary> |
||||
<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="OnIsActivatedChanged(EventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPane.IsActivatedChanged" /> event.</summary> |
||||
<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="OnIsActiveDocumentPaneChanged(EventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPane.IsActiveDocumentPaneChanged" /> event.</summary> |
||||
<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="RestoreToPanel()"> |
||||
<summary>Shows all contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms as non-floating.</summary> |
||||
</Method> |
||||
<Method name="SetContentIndex(DockContent, int)"> |
||||
<summary>Moves the specified <see cref="WeifenLuo.WinFormsUI.DockContent" /> form to the |
||||
specified position in the tab strip.</summary> |
||||
<param name="content">The specified <see cref="WeifenLuo.WinFormsUI.DockContent" /> form.</param> |
||||
<param name="index">The zero-based index represents the new position in the tab strip.</param> |
||||
</Method> |
||||
<Method name="SetDockState(DockState)"> |
||||
<summary>Shows all contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms as specified docking state.</summary> |
||||
<param name="value">The specified docking state to display.</param> |
||||
<returns>The <see cref="WeifenLuo.WinFormsUI.DockPane" /> for the new docking state.</returns> |
||||
</Method> |
||||
<Method name="SetNestedDockingProportion(double)"> |
||||
<summary>Sets the proportion size of this DockPane for nested docking.</summary> |
||||
<param name="proportion">The proportion size to set. Value must between 0 and 1.</param> |
||||
</Method> |
||||
<Event name="DockStateChanged"> |
||||
<summary>Occurs when the <see cref="WeifenLuo.WinFormsUI.DockPane.DockState"/> property changed.</summary> |
||||
</Event> |
||||
<Event name="IsActivatedChanged"> |
||||
<summary>Occurs when the <see cref="WeifenLuo.WinFormsUI.DockPane.IsActivated"/> property changed.</summary> |
||||
</Event> |
||||
<Event name="IsActiveDocumentPaneChanged"> |
||||
<summary>Occurs when the <see cref="WeifenLuo.WinFormsUI.DockPane.IsActiveDocumentPane"/> property changed.</summary> |
||||
</Event> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,45 @@
@@ -0,0 +1,45 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="DockPaneCollection"> |
||||
<ClassDef> |
||||
<summary>Provides methods to manage a collection of <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
</ClassDef> |
||||
<Property name="Item"> |
||||
<summary> |
||||
<para>Gets a <see cref="WeifenLuo.WinFormsUI.DockPane" /> at the specified index.</para> |
||||
<para>In C#, this property is the indexer for the <see cref="WeifenLuo.WinFormsUI.DockPaneCollection" /> class.</para> |
||||
</summary> |
||||
</Property> |
||||
<Method name="Contains(DockPane)"> |
||||
<summary> |
||||
Determines whether a <see cref="WeifenLuo.WinFormsUI.DockPane" /> is in the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPaneCollection" />. |
||||
</summary> |
||||
<param name="pane"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> to locate in |
||||
<see cref="WeifenLuo.WinFormsUI.DockPaneCollection" />. |
||||
</param> |
||||
<returns> |
||||
<b>true</b> if <paramref name="pane" /> is found in the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPaneCollection" />; |
||||
otherwise, <b>false</b>. |
||||
</returns> |
||||
</Method> |
||||
<Method name="IndexOf(DockPane)"> |
||||
<summary> |
||||
Searches for the specified <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
and returns the zero-based index within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DockPaneCollection" />. |
||||
</summary> |
||||
<param name="pane"> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockPane" /> |
||||
to locate in the <see cref="WeifenLuo.WinFormsUI.DockPaneCollection" /> |
||||
</param> |
||||
<returns> |
||||
The zero-based index of <paramref name="pane" /> within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.DockPaneCollection" />, if found; |
||||
otherwise, -1. |
||||
</returns> |
||||
</Method> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,238 @@
@@ -0,0 +1,238 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Delegate name="DeserializeDockContent"> |
||||
<summary> |
||||
Callback used by <see cref="WeifenLuo.WinFormsUI.DockPanel.LoadFromXml"/> |
||||
to get a instance of <see cref="WeifenLuo.WinFormsUI.DockContent"/> from a |
||||
serialized string. |
||||
</summary> |
||||
<param name="persistString"> |
||||
The serialized string of the <see cref="WeifenLuo.WinFormsUI.DockContent"/> object. |
||||
</param> |
||||
<returns> |
||||
The <see cref="WeifenLuo.WinFormsUI.DockContent"/> object. |
||||
</returns> |
||||
<remarks> |
||||
<para> |
||||
The layout of <see cref="WeifenLuo.WinFormsUI.DockPanel"/> |
||||
can be saved to and loaded from XML data by calling |
||||
<see cref="WeifenLuo.WinFormsUI.DockPanel.SaveAsXml"/> and |
||||
<see cref="WeifenLuo.WinFormsUI.DockPanel.LoadFromXml"/>. |
||||
When saving, the system will persist the <see cref="WeifenLuo.WinFormsUI.DockContent"/> |
||||
object to a string by calling its |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent.GetPersistString"/> method; |
||||
when loading, the system will call the <see cref="WeifenLuo.WinFormsUI.DeserializeDockContent"/> |
||||
call back to get the instance of <see cref="WeifenLuo.WinFormsUI.DockContent"/> object. |
||||
</para> |
||||
<para> |
||||
The default implementation of <see cref="WeifenLuo.WinFormsUI.DockContent.GetPersistString"/> |
||||
returns the type name of the <see cref="WeifenLuo.WinFormsUI.DockContent"/> class. You can overwrite |
||||
this method for your own implementation. |
||||
</para> |
||||
<para> |
||||
You always need to provide a <see cref="WeifenLuo.WinFormsUI.DeserializeDockContent"/> |
||||
callback when loading the layout. |
||||
</para> |
||||
</remarks> |
||||
</Delegate> |
||||
<Delegate name="DockContentEventHandler"> |
||||
<summary>Represents the method that will handle the <see cref="WeifenLuo.WinFormsUI.DockPanel.ContentAdded"/> or |
||||
<see cref="WeifenLuo.WinFormsUI.DockPanel.ContentRemoved"/> event of <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</summary> |
||||
<param name="sender">The source of the event.</param> |
||||
<param name="e">A <see cref="WeifenLuo.WinFormsUI.DockContentEventArgs" /> that contains the event data.</param> |
||||
</Delegate> |
||||
<Class name="DockPanel"> |
||||
<ClassDef> |
||||
<summary>Represents a control that acts as container for the docking windows.</summary> |
||||
<remarks>The <see cref="WeifenLuo.WinFormsUI.DockPanel"/> contains 5 <see cref="WeifenLuo.WinFormsUI.DockWindow"/>: |
||||
top, bottom, left, right and document. It also displays tab strip for auto-hide window(s) if there is any.</remarks> |
||||
</ClassDef> |
||||
<Constructor name="()"> |
||||
<summary>Initializes a new instance of <see cref="WeifenLuo.WinFormsUI.DockPanel"/> class.</summary> |
||||
</Constructor> |
||||
<Property name="ActiveAutoHideContent"> |
||||
<summary>Gets or sets the active auto-hide <see cref="WeifenLuo.WinFormsUI.DockContent"/>.</summary> |
||||
<value>The auto-hide <see cref="WeifenLuo.WinFormsUI.DockContent"/> is currently active.</value> |
||||
</Property> |
||||
<Property name="ActiveContent"> |
||||
<summary>Gets the active <see cref="WeifenLuo.WinFormsUI.DockContent"/>.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockContent"/> is currently active.</value> |
||||
</Property> |
||||
<Property name="ActiveDocument"> |
||||
<summary>Gets the active document <see cref="WeifenLuo.WinFormsUI.DockContent"/>.</summary> |
||||
<value>The document <see cref="WeifenLuo.WinFormsUI.DockContent"/> is currently active.</value> |
||||
</Property> |
||||
<Property name="ActiveDocumentPane"> |
||||
<summary>Gets the active document <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</summary> |
||||
<value>The document <see cref="WeifenLuo.WinFormsUI.DockPane"/> is currently active.</value> |
||||
</Property> |
||||
<Property name="ActivePane"> |
||||
<summary>Gets the active <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockPane"/> is currently active.</value> |
||||
</Property> |
||||
<Property name="AllowRedocking"> |
||||
<summary>Sets or gets a value indicating whether drag and drop redocking is allowed.</summary> |
||||
<value><b>True</b>, if drag and drop redocking is allowed, otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="Contents"> |
||||
<summary>Gets the collection of contained <see cref="WeifenLuo.WinFormsUI.DockContent" /> forms.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockContentCollection" /> which contains all the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent" /> forms for this <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</value> |
||||
<remarks>A <see cref="WeifenLuo.WinFormsUI.DockContent" /> object is added to <see cref="WeifenLuo.WinFormsUI.DockPanel.Contents" /> |
||||
collection by setting the value of its <see cref="WeifenLuo.WinFormsUI.DockContent.DockPanel" /> property.</remarks> |
||||
</Property> |
||||
<Property name="DockBottomPortion"> |
||||
<summary>Gets or sets the size of the bottom side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</summary> |
||||
<value>A value between 0 and 1 to determine the size of the bottom side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</value> |
||||
</Property> |
||||
<Property name="DockLeftPortion"> |
||||
<summary>Gets or sets the size of the left side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</summary> |
||||
<value>A value between 0 and 1 to determine the size of the left side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</value> |
||||
</Property> |
||||
<Property name="DockRightPortion"> |
||||
<summary>Gets or sets the size of the right side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</summary> |
||||
<value>A value between 0 and 1 to determine the size of the right side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</value> |
||||
</Property> |
||||
<Property name="DockTopPortion"> |
||||
<summary>Gets or sets the size of the top side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</summary> |
||||
<value>A value between 0 and 1 to determine the size of the top side <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</value> |
||||
</Property> |
||||
<Property name="DockPaneFactory"> |
||||
<summary>Provides class factory to initialize <see cref="WeifenLuo.WinFormsUI.DockPane"/> objects.</summary> |
||||
<value>An object implements <see cref="WeifenLuo.WinFormsUI.IDockPaneFactory"/> to initialize <see cref="WeifenLuo.WinFormsUI.DockPane"/> objects.</value> |
||||
<remarks>Override this property can implement your own class derived from <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</remarks> |
||||
</Property> |
||||
<Property name="FloatWindowFactory"> |
||||
<summary>Provides class factory to initialize <see cref="WeifenLuo.WinFormsUI.FloatWindow"/> objects.</summary> |
||||
<value>An object implements <see cref="WeifenLuo.WinFormsUI.IFloatWindowFactory"/> to initialize <see cref="WeifenLuo.WinFormsUI.FloatWindow"/> objects.</value> |
||||
<remarks>Override this property can implement your own class derived from <see cref="WeifenLuo.WinFormsUI.FloatWindow"/>.</remarks> |
||||
</Property> |
||||
<Property name="DockWindows"> |
||||
<summary>Gets the collection of contained <see cref="WeifenLuo.WinFormsUI.DockWindow" /> controls.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockWindowCollection" /> which contains all the |
||||
<see cref="WeifenLuo.WinFormsUI.DockWindow" /> controls for this <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</value> |
||||
</Property> |
||||
<Property name="FloatWindows"> |
||||
<summary>Gets the collection of contained <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> forms.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" /> which contains all the |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindow" /> forms for this <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</value> |
||||
</Property> |
||||
<Property name="Panes"> |
||||
<summary>Gets the collection of contained <see cref="WeifenLuo.WinFormsUI.DockPane" /> windows.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockPaneCollection" /> which contains all the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane" /> windows for this <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</value> |
||||
</Property> |
||||
<Property name="Documents"> |
||||
<summary>Gets the document <see cref="WeifenLuo.WinFormsUI.DockContent"/> forms.</summary> |
||||
<value>An array of the document <see cref="WeifenLuo.WinFormsUI.DockContent"/> forms.</value> |
||||
</Property> |
||||
<Property name="MdiIntegration"> |
||||
<summary>Gets or sets a value indicating whether all the document <see cref="WeifenLuo.WinFormsUI.DockContent"/> forms are treated as MDI forms.</summary> |
||||
<value><b>True</b>, if all the document <see cref="WeifenLuo.WinFormsUI.DockContent"/> forms are treated as MDI forms, otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="SdiDocument"> |
||||
<summary>Gets or sets a value indicating whether the tab strip of document <see cref="WeifenLuo.WinFormsUI.DockPane"/> will be displayed when there is only one document <see cref="WeifenLuo.WinFormsUI.DockContent"/> form.</summary> |
||||
<value><b>False</b>, if the tab strip of document <see cref="WeifenLuo.WinFormsUI.DockPane"/> will be displayed when there is only one document <see cref="WeifenLuo.WinFormsUI.DockContent"/> form, otherwise, <b>true</b>.</value> |
||||
</Property> |
||||
<Method name="OnActiveContentChanged(EventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPanel.ActiveContentChanged" /> event.</summary> |
||||
<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="OnActiveDocumentChanged(EventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPanel.ActiveDocumentChanged" /> event.</summary> |
||||
<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="OnActivePaneChanged(EventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPanel.ActivePaneChanged" /> event.</summary> |
||||
<param name="e">An <see cref="System.EventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="OnContentAdded(DockContentEventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPanel.ContentAdded" /> event.</summary> |
||||
<param name="e">An <see cref="WeifenLuo.WinFormsUI.DockContentEventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="OnContentRemoved(DockContentEventArgs)"> |
||||
<summary>Raises the <see cref="WeifenLuo.WinFormsUI.DockPanel.ContentRemoved" /> event.</summary> |
||||
<param name="e">An <see cref="WeifenLuo.WinFormsUI.DockContentEventArgs" /> that contains the event data.</param> |
||||
</Method> |
||||
<Method name="SaveAsXml"> |
||||
<overloads> |
||||
<summary>Save the layout to XML data. Overloaded.</summary> |
||||
<remarks> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks/*'/> |
||||
</remarks> |
||||
</overloads> |
||||
</Method> |
||||
<Method name="SaveAsXml(string)"> |
||||
<summary>Save the layout to XML data, using the specified file.</summary> |
||||
<param name="filename">The file name to write to. If the file exsists, it will truncate it and |
||||
overwrite it with new content.</param> |
||||
<remarks> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks/*'/> |
||||
</remarks> |
||||
</Method> |
||||
<Method name="SaveAsXml(string, Encoding)"> |
||||
<summary>Save the layout to XML data, using the specified file and encoding.</summary> |
||||
<param name="filename">The file name to write to. If the file exsists, it will truncate it and |
||||
overwrite it with new content.</param> |
||||
<param name="encoding">The encoding to generate.</param> |
||||
<remarks> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks/*'/> |
||||
</remarks> |
||||
</Method> |
||||
<Method name="SaveAsXml(Stream, Encoding)"> |
||||
<summary>Save the layout to XML data, using the specified stream and encoding.</summary> |
||||
<param name="stream">The stream to which you want to write.</param> |
||||
<param name="encoding">The encoding to generate.</param> |
||||
<remarks> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks/*'/> |
||||
</remarks> |
||||
</Method> |
||||
<Method name="LoadFromXml"> |
||||
<overloads> |
||||
<summary>Load the layout from XML data. Overloaded</summary> |
||||
<remarks> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks/*'/> |
||||
</remarks> |
||||
</overloads> |
||||
</Method> |
||||
<Method name="LoadFromXml(string, DeserializeDockContent)"> |
||||
<summary>Load the layout from XML file.</summary> |
||||
<param name="filename">The file name to read XML data from.</param> |
||||
<param name="deserializeContent">The callback function to get the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent"/> instance from the persistent string.</param> |
||||
<remarks> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks/*'/> |
||||
</remarks> |
||||
</Method> |
||||
<Method name="LoadFromXml(Stream, DeserializeDockContent)"> |
||||
<summary>Load the layout from XML stream.</summary> |
||||
<param name="stream">The stream to read XML data from.</param> |
||||
<param name="deserializeContent">The callback function to get the |
||||
<see cref="WeifenLuo.WinFormsUI.DockContent"/> instance from the persistent string.</param> |
||||
<remarks> |
||||
<include file='DockPanel.xml' path='//CodeDoc/Delegate[@name="DeserializeDockContent"]/remarks/*'/> |
||||
</remarks> |
||||
</Method> |
||||
<Method name="SetPaneIndex(DockPane, int)"> |
||||
<summary>Moves the specified <see cref="WeifenLuo.WinFormsUI.DockPane" /> window to the |
||||
specified position in the auto-hide tab strip.</summary> |
||||
<param name="pane">The specified <see cref="WeifenLuo.WinFormsUI.DockPane" /> window.</param> |
||||
<param name="index">The zero-based index represents the new position in the auto-hide tab strip.</param> |
||||
</Method> |
||||
<Event name="ActiveContentChanged"> |
||||
<summary>Occurs when the <see cref="WeifenLuo.WinFormsUI.DockPanel.ActiveContent"/> property changed.</summary> |
||||
</Event> |
||||
<Event name="ActiveDocumentChanged"> |
||||
<summary>Occurs when the <see cref="WeifenLuo.WinFormsUI.DockPanel.ActiveDocument"/> property changed.</summary> |
||||
</Event> |
||||
<Event name="ActivePaneChanged"> |
||||
<summary>Occurs when the <see cref="WeifenLuo.WinFormsUI.DockPanel.ActivePane"/> property changed.</summary> |
||||
</Event> |
||||
<Event name="ContentAdded"> |
||||
<summary>Occurs when a <see cref="WeifenLuo.WinFormsUI.DockContent"/> form added to <see cref="WeifenLuo.WinFormsUI.DockPanel.Contents"/> collection.</summary> |
||||
</Event> |
||||
<Event name="ContentRemoved"> |
||||
<summary>Occurs when a <see cref="WeifenLuo.WinFormsUI.DockContent"/> form removed from <see cref="WeifenLuo.WinFormsUI.DockPanel.Contents"/> collection.</summary> |
||||
</Event> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,48 @@
@@ -0,0 +1,48 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="DockWindow"> |
||||
<ClassDef> |
||||
<summary>Represents the docking zone of the <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</summary> |
||||
<remarks> |
||||
<para>The <see cref="WeifenLuo.WinFormsUI.DockPanel" /> is divided into 5 |
||||
<see cref="WeifenLuo.WinFormsUI.DockWindow" />s: Top, Bottom, Left, Right and Document. |
||||
The document <see cref="WeifenLuo.WinFormsUI.DockWindow" /> is always positioned in the central of the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPanel" />. Other 4 <see cref="WeifenLuo.WinFormsUI.DockWindow" />s’ positions |
||||
are determined by the Z-order. The last displayed <see cref="WeifenLuo.WinFormsUI.DockWindow" /> will be sent to the back of the |
||||
Z-order.</para> |
||||
<para>The <see cref="WeifenLuo.WinFormsUI.DockWindow" /> implements <see cref="WeifenLuo.WinFormsUI.IDockListContainer" />, |
||||
it can contain a list of nested <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</para> |
||||
</remarks> |
||||
</ClassDef> |
||||
<Property name="DisplayingList"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> which contains |
||||
a list of visible nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> which contains |
||||
a list of visible nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</value> |
||||
</Property> |
||||
<Property name="DisplayingRectangle"> |
||||
<summary>Gets the rectangle represents the displaying area for nested docking DockPane objects.</summary> |
||||
<value>A <see cref="System.Drawing.Rectangle" /> represents the displaying area for nested docking DockPane objects.</value> |
||||
</Property> |
||||
<Property name="DockList"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DockList" /> which contains |
||||
a list of nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockList" /> which contains |
||||
a list of nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</value> |
||||
</Property> |
||||
<Property name="DockPanel"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DockPanel"/> which contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockPanel"/> which contains this |
||||
<see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</value> |
||||
</Property> |
||||
<Property name="DockState"> |
||||
<summary>Gets the docking state of this <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</summary> |
||||
<value>The docking state of this <see cref="WeifenLuo.WinFormsUI.DockWindow"/>.</value> |
||||
</Property> |
||||
<Property name="IsFloat"> |
||||
<summary>Gets to determine if this <see cref="WeifenLuo.WinFormsUI.DockWindow"/> is floating.</summary> |
||||
<value>The value of this property is always <b>false</b>.</value> |
||||
</Property> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,14 @@
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="DockWindowCollection"> |
||||
<ClassDef> |
||||
<summary>Provides methods to manage a collection of <see cref="WeifenLuo.WinFormsUI.DockWindow" /> objects.</summary> |
||||
</ClassDef> |
||||
<Property name="Item"> |
||||
<summary> |
||||
<para>Gets a <see cref="WeifenLuo.WinFormsUI.DockWindow" /> at the specified docking state.</para> |
||||
<para>In C#, this property is the indexer for the <see cref="WeifenLuo.WinFormsUI.DockWindowCollection" /> class.</para> |
||||
</summary> |
||||
</Property> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,88 @@
@@ -0,0 +1,88 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Enum name="DockAlignment"> |
||||
<EnumDef> |
||||
<summary>Specifies the edge for nested docking.</summary> |
||||
</EnumDef> |
||||
<Member name="Left"> |
||||
<summary>The <see cref="WeifenLuo.WinFormsUI.DockPane" />'s left edge is docked to its |
||||
containing <see cref="WeifenLuo.WinFormsUI.DockPane" />'s left edge.</summary> |
||||
</Member> |
||||
<Member name="Right"> |
||||
<summary>The <see cref="WeifenLuo.WinFormsUI.DockPane" />'s right edge is docked to its |
||||
containing <see cref="WeifenLuo.WinFormsUI.DockPane" />'s right edge.</summary> |
||||
</Member> |
||||
<Member name="Top"> |
||||
<summary>The <see cref="WeifenLuo.WinFormsUI.DockPane" />'s top edge is docked to its |
||||
containing <see cref="WeifenLuo.WinFormsUI.DockPane" />'s top edge.</summary> |
||||
</Member> |
||||
<Member name="Bottom"> |
||||
<summary>The <see cref="WeifenLuo.WinFormsUI.DockPane" />'s bottom edge is docked to its |
||||
containing <see cref="WeifenLuo.WinFormsUI.DockPane" />'s bottom edge.</summary> |
||||
</Member> |
||||
</Enum> |
||||
<Enum name="DockAreas"> |
||||
<EnumDef> |
||||
<summary>Specifies all the available docking areas.</summary> |
||||
</EnumDef> |
||||
<Member name="Float"> |
||||
<summary>The floating window docking area.</summary> |
||||
</Member> |
||||
<Member name="DockTop"> |
||||
<summary>The top docking area of the <see cref="WeifenLuo.WinFormsUI.DockPanel" /></summary> |
||||
</Member> |
||||
<Member name="DockLeft"> |
||||
<summary>The left docking area of the <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</summary> |
||||
</Member> |
||||
<Member name="DockRight"> |
||||
<summary>The right docking area of the <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</summary> |
||||
</Member> |
||||
<Member name="DockBottom"> |
||||
<summary>The bottom docking area of the <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</summary> |
||||
</Member> |
||||
<Member name="Document"> |
||||
<summary>The document area of the <see cref="WeifenLuo.WinFormsUI.DockPanel" />.</summary> |
||||
</Member> |
||||
</Enum> |
||||
<Enum name="DockState"> |
||||
<EnumDef> |
||||
<summary>Specifies the docking state for docking windows.</summary> |
||||
</EnumDef> |
||||
<Member name="Unknown"> |
||||
<summary>Unknown docking state.</summary> |
||||
</Member> |
||||
<Member name="Float"> |
||||
<summary>Displayed inside float window.</summary> |
||||
</Member> |
||||
<Member name="DockTopAutoHide"> |
||||
<summary>Displayed as auto-hide window, on the top edge.</summary> |
||||
</Member> |
||||
<Member name="DockLeftAutoHide"> |
||||
<summary>Displayed as auto-hide window, on the left edge.</summary> |
||||
</Member> |
||||
<Member name="DockBottomAutoHide"> |
||||
<summary>Displayed as auto-hide window, on the bottom edge.</summary> |
||||
</Member> |
||||
<Member name="DockRightAutoHide"> |
||||
<summary>Displayed as auto-hide window, on the right edge.</summary> |
||||
</Member> |
||||
<Member name="Document"> |
||||
<summary>Displayed as document window.</summary> |
||||
</Member> |
||||
<Member name="DockTop"> |
||||
<summary>Docked to the top edge.</summary> |
||||
</Member> |
||||
<Member name="DockLeft"> |
||||
<summary>Docked to the left edge.</summary> |
||||
</Member> |
||||
<Member name="DockRight"> |
||||
<summary>Docked to the right edge.</summary> |
||||
</Member> |
||||
<Member name="DockBottom"> |
||||
<summary>Docked to the bottom edge.</summary> |
||||
</Member> |
||||
<Member name="Hidden"> |
||||
<summary>The window is hidden.</summary> |
||||
</Member> |
||||
</Enum> |
||||
</CodeDoc> |
@ -0,0 +1,18 @@
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
|
||||
<CodeDoc> |
||||
<Class name="DockContentEventArgs"> |
||||
<ClassDef> |
||||
<summary>Provides data for <see cref="WeifenLuo.WinFormsUI.DockPanel.ContentAdded"/> and |
||||
<see cref="WeifenLuo.WinFormsUI.DockPanel.ContentRemoved"/> events.</summary> |
||||
</ClassDef> |
||||
<Constructor name="(DockContent)"> |
||||
<summary>Initializes a new instance of <see cref="WeifenLuo.WinFormsUI.DockContentEventArgs"/> class.</summary> |
||||
<param name="content">The <see cref="WeifenLuo.WinFormsUI.DockContent"/> object.</param> |
||||
</Constructor> |
||||
<Property name="Content"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DockContent"/> object.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockContent"/> object.</value> |
||||
</Property> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,66 @@
@@ -0,0 +1,66 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="FloatWindow"> |
||||
<ClassDef> |
||||
<summary>Represents the floating window to contain the nested docking DockPane.</summary> |
||||
<remarks> |
||||
The <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> implements <see cref="WeifenLuo.WinFormsUI.IDockListContainer" />, |
||||
it can contain a list of nested <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects. |
||||
</remarks> |
||||
</ClassDef> |
||||
<Constructor name="Overloads"> |
||||
<overloads> |
||||
<summary>Initializes a new instance of <see cref="WeifenLuo.WinFormsUI.FloatWindow" />.</summary> |
||||
</overloads> |
||||
</Constructor> |
||||
<Constructor name="(DockPanel, DockPane)"> |
||||
<summary>Initializes a new instance of <see cref="WeifenLuo.WinFormsUI.FloatWindow" />, |
||||
with default size and location.</summary> |
||||
<param name="dockPanel">The <see cref="WeifenLuo.WinFormsUI.DockPanel" /> which owns this |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindow" />.</param> |
||||
<param name="pane">The first <see cref="WeifenLuo.WinFormsUI.DockPane" /> in this |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindow" />.</param> |
||||
</Constructor> |
||||
<Constructor name="(DockPanel, DockPane, Rectangle)"> |
||||
<summary>Initializes a new instance of <see cref="WeifenLuo.WinFormsUI.FloatWindow" />, |
||||
with specified size and location.</summary> |
||||
<include file='FloatWindow.xml' path='//CodeDoc/Class[@name="FloatWindow"]/Constructor[@name="(DockPanel, DockPane)"]/param[@name="dockPanel"]' /> |
||||
<include file='FloatWindow.xml' path='//CodeDoc/Class[@name="FloatWindow"]/Constructor[@name="(DockPanel, DockPane)"]/param[@name="pane"]' /> |
||||
<param name="bounds">A <see cref="System.Drawing.Rectangle" /> for the location and size of the window.</param> |
||||
</Constructor> |
||||
<Property name="AllowRedocking"> |
||||
<summary>Gets or sets if the drag and drop re-docking is allowed.</summary> |
||||
<value><b>True</b> if drag and drop re-docking is allowed; otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="DisplayingList"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> which contains |
||||
a list of visible nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> which contains |
||||
a list of visible nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</value> |
||||
</Property> |
||||
<Property name="DisplayingRectangle"> |
||||
<summary>Gets the rectangle represents the displaying area for nested docking DockPane objects.</summary> |
||||
<value>A <see cref="System.Drawing.Rectangle" /> represents the displaying area for nested docking DockPane objects.</value> |
||||
</Property> |
||||
<Property name="DockList"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DockList" /> which contains |
||||
a list of nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockList" /> which contains |
||||
a list of nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</value> |
||||
</Property> |
||||
<Property name="DockPanel"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DockPanel" /> which contains this |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindow" />.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockPanel" /> which contains this |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindow" />.</value> |
||||
</Property> |
||||
<Property name="DockState"> |
||||
<summary>Gets the docking state of this <see cref="WeifenLuo.WinFormsUI.FloatWindow" />.</summary> |
||||
<value>The value of this property is always <see cref="WeifenLuo.WinFormsUI.DockState.Float" />.</value> |
||||
</Property> |
||||
<Property name="IsFloat"> |
||||
<summary>Gets to determine if this <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> is floating.</summary> |
||||
<value>The value of this property is always <b>true</b>.</value> |
||||
</Property> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,45 @@
@@ -0,0 +1,45 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Class name="FloatWindowCollection"> |
||||
<ClassDef> |
||||
<summary>Provides methods to manage a collection of <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> objects.</summary> |
||||
</ClassDef> |
||||
<Property name="Item"> |
||||
<summary> |
||||
<para>Gets a <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> at the specified index.</para> |
||||
<para>In C#, this property is the indexer for the <see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" /> class.</para> |
||||
</summary> |
||||
</Property> |
||||
<Method name="Contains(FloatWindow)"> |
||||
<summary> |
||||
Determines whether a <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> is in the |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" />. |
||||
</summary> |
||||
<param name="fw"> |
||||
The <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> to locate in |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" />. |
||||
</param> |
||||
<returns> |
||||
<b>true</b> if <paramref name="fw" /> is found in the |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" />; |
||||
otherwise, <b>false</b>. |
||||
</returns> |
||||
</Method> |
||||
<Method name="IndexOf(FloatWindow)"> |
||||
<summary> |
||||
Searches for the specified <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> |
||||
and returns the zero-based index within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" />. |
||||
</summary> |
||||
<param name="fw"> |
||||
The <see cref="WeifenLuo.WinFormsUI.FloatWindow" /> |
||||
to locate in the <see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" /> |
||||
</param> |
||||
<returns> |
||||
The zero-based index of <paramref name="fw" /> within the entire |
||||
<see cref="WeifenLuo.WinFormsUI.FloatWindowCollection" />, if found; |
||||
otherwise, -1. |
||||
</returns> |
||||
</Method> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,89 @@
@@ -0,0 +1,89 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CodeDoc> |
||||
<Interface name="IDockListContainer"> |
||||
<InterfaceDef> |
||||
<summary>Container for nested docking <see cref='WeifenLuo.WinFormsUI.DockPane' /> objects.</summary> |
||||
<remarks> |
||||
<para> |
||||
<b>IDockListContainer</b> contains a list of <b>DockPane</b> objects |
||||
for nested docking. It maintans two lists: <see cref='WeifenLuo.WinFormsUI.DockList' /> |
||||
and <see cref='WeifenLuo.WinFormsUI.DisplayingDockList' />. <b>DockList</b> |
||||
contains all <b>DockPane</b> objects, no matter it's visible or not; <b>DisplayingDockList</b> contains only |
||||
visible <b>DockPane</b> objects for this container. |
||||
</para> |
||||
<para> |
||||
Internally, <b>IDockListContainer</b> creates <b>DockList</b>, this <b>DockList</b> then creates <b>DisplayingDockList</b>, |
||||
and these two lists are always synchronized. |
||||
</para> |
||||
</remarks> |
||||
</InterfaceDef> |
||||
<Property name="DisplayingList"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> which contains |
||||
a list of visible nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DisplayingDockList" /> which contains |
||||
a list of visible nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</value> |
||||
</Property> |
||||
<Property name="DisplayingRectangle"> |
||||
<summary>Gets the rectangle represents the displaying area for nested docking DockPane objects.</summary> |
||||
<value>A <see cref="System.Drawing.Rectangle" /> represents the displaying area for nested docking DockPane objects.</value> |
||||
</Property> |
||||
<Property name="DockList"> |
||||
<summary>Gets the <see cref="WeifenLuo.WinFormsUI.DockList" /> which contains |
||||
a list of nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</summary> |
||||
<value>The <see cref="WeifenLuo.WinFormsUI.DockList" /> which contains |
||||
a list of nested docking <see cref="WeifenLuo.WinFormsUI.DockPane" /> objects.</value> |
||||
</Property> |
||||
<Property name="DockState"> |
||||
<summary>Gets the docking state of this container.</summary> |
||||
<value>One of the <see cref='WeifenLuo.WinFormsUI.DockState' /> values.</value> |
||||
</Property> |
||||
<Property name="IsDisposed"> |
||||
<summary>Gets a value indicates the control has been disposed of.</summary> |
||||
<value><b>True</b> if the control has been disposed of, otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="IsFloat"> |
||||
<summary>Determines if this container window is floating.</summary> |
||||
<value><b>True</b> if is floating; otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
</Interface> |
||||
<Interface name="IDockPaneFactory"> |
||||
<InterfaceDef> |
||||
<summary>Provides methods to initialize a instance of <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</summary> |
||||
<remarks>You can derive your own class from <see cref="WeifenLuo.WinFormsUI.DockPane"/>, and |
||||
override the <see cref="WeifenLuo.WinFormsUI.DockPanel.DockPaneFactory"/> property to create instance |
||||
of the derived class.</remarks> |
||||
</InterfaceDef> |
||||
<Method name="CreateDockPane"> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="Overloads"]/*' /> |
||||
</Method> |
||||
<Method name="CreateDockPane(DockContent, DockState, bool)"> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, DockState, bool)"]/*' /> |
||||
</Method> |
||||
<Method name="CreateDockPane(DockContent, FloatWindow, bool)"> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, FloatWindow, bool)"]/*' /> |
||||
</Method> |
||||
<Method name="CreateDockPane(DockContent, DockPane, DockAlignment, double, bool)"> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, DockPane, DockAlignment, double, bool)"]/*' /> |
||||
</Method> |
||||
<Method name="CreateDockPane(DockContent, Rectangle, bool)"> |
||||
<include file='DockPane.xml' path='//CodeDoc/Class[@name="DockPane"]/Constructor[@name="(DockContent, Rectangle, bool)"]/*' /> |
||||
</Method> |
||||
</Interface> |
||||
<Interface name="IFloatWindowFactory"> |
||||
<InterfaceDef> |
||||
<summary>Provides methods to initialize a instance of <see cref="WeifenLuo.WinFormsUI.FloatWindow"/>.</summary> |
||||
<remarks>You can derive your own class from <see cref="WeifenLuo.WinFormsUI.FloatWindow"/>, and |
||||
override the <see cref="WeifenLuo.WinFormsUI.DockPanel.FloatWindowFactory"/> property to create instance |
||||
of the derived class.</remarks> |
||||
</InterfaceDef> |
||||
<Method name="CreateFloatWindow"> |
||||
<include file='FloatWindow.xml' path='//CodeDoc/Class[@name="FloatWindow"]/Constructor[@name="Overloads"]/*' /> |
||||
</Method> |
||||
<Method name="CreateFloatWindow(DockPanel, DockPane)"> |
||||
<include file='FloatWindow.xml' path='//CodeDoc/Class[@name="FloatWindow"]/Constructor[@name="(DockPanel, DockPane)"]/*' /> |
||||
</Method> |
||||
<Method name="CreateFloatWindow(DockPanel, DockPane, Rectangle)"> |
||||
<include file='FloatWindow.xml' path='//CodeDoc/Class[@name="FloatWindow"]/Constructor[@name="(DockPanel, DockPane, Rectangle)"]/*' /> |
||||
</Method> |
||||
</Interface> |
||||
</CodeDoc> |
@ -0,0 +1,60 @@
@@ -0,0 +1,60 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
|
||||
<CodeDoc> |
||||
<Class name="NestedDockingStatus"> |
||||
<ClassDef> |
||||
<summary>Provides nested docking information for a <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</summary> |
||||
</ClassDef> |
||||
<Property name="Alignment"> |
||||
<summary>Gets the edge of the target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock.</summary> |
||||
<value>One of the <see cref="WeifenLuo.WinFormsUI.DockAlignment"/> values.</value> |
||||
</Property> |
||||
<Property name="DisplayingAlignment"> |
||||
<summary>Gets the edge of the target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock, when displaying.</summary> |
||||
<value>One of the <see cref="WeifenLuo.WinFormsUI.DockAlignment"/> values.</value> |
||||
</Property> |
||||
<Property name="DisplayingPrevPane"> |
||||
<summary>Gets the target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock, when displaying.</summary> |
||||
<value>A <see cref="WeifenLuo.WinFormsUI.DockPane"/> object that represents the target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock, when displaying.</value> |
||||
</Property> |
||||
<Property name="DisplayingProportion"> |
||||
<summary>Gets the size for the nested docking, when displaying.</summary> |
||||
<value>A value between 0 and 1 to indicate the size for the nested docking.</value> |
||||
</Property> |
||||
<Property name="DockList"> |
||||
<summary>Gets the containing <see cref="WeifenLuo.WinFormsUI.DockList"/>.</summary> |
||||
<value>The containing <see cref="WeifenLuo.WinFormsUI.DockList"/>.</value> |
||||
</Property> |
||||
<Property name="DockPane"> |
||||
<summary>Gets the containing <see cref="WeifenLuo.WinFormsUI.DockPane" />.</summary> |
||||
<value>The containing <see cref="WeifenLuo.WinFormsUI.DockPane" />.</value> |
||||
</Property> |
||||
<Property name="IsDisplaying"> |
||||
<summary>Gets the value to indicate if current <see cref="WeifenLuo.WinFormsUI.DockPane"/> is being displayed.</summary> |
||||
<value><b>true</b> if current <see cref="WeifenLuo.WinFormsUI.DockPane"/> is being displayed, otherwise, <b>false</b>.</value> |
||||
</Property> |
||||
<Property name="LogicalBounds"> |
||||
<summary>Gets the logical location and size of the <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</summary> |
||||
<value>The <see cref="System.Drawing.Rectangle"/> to represent the logical location and size of the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane"/>.</value> |
||||
</Property> |
||||
<Property name="PaneBounds"> |
||||
<summary>Gets the actual location and size of the <see cref="WeifenLuo.WinFormsUI.DockPane"/>.</summary> |
||||
<value>The <see cref="System.Drawing.Rectangle"/> to represent the actual location and size of the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane"/>.</value> |
||||
</Property> |
||||
<Property name="PrevPane"> |
||||
<summary>Gets the target Gets the target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock.</summary> |
||||
<value>A <see cref="WeifenLuo.WinFormsUI.DockPane"/> object that represents the target <see cref="WeifenLuo.WinFormsUI.DockPane"/> to dock.</value> |
||||
</Property> |
||||
<Property name="Proportion"> |
||||
<summary>Gets the size for the nested docking.</summary> |
||||
<value>A value between 0 and 1 to indicate the size for the nested docking.</value> |
||||
</Property> |
||||
<Property name="SplitterBounds"> |
||||
<summary>Gets the location and size of the <see cref="WeifenLuo.WinFormsUI.DockPane"/> splitter.</summary> |
||||
<value>The <see cref="System.Drawing.Rectangle"/> to represent the location and size of the |
||||
<see cref="WeifenLuo.WinFormsUI.DockPane"/> splitter.</value> |
||||
</Property> |
||||
</Class> |
||||
</CodeDoc> |
@ -0,0 +1,78 @@
@@ -0,0 +1,78 @@
|
||||
// *****************************************************************************
|
||||
//
|
||||
// Copyright 2004, Weifen Luo
|
||||
// All rights reserved. The software and associated documentation
|
||||
// supplied hereunder are the proprietary information of Weifen Luo
|
||||
// and are supplied subject to licence terms.
|
||||
//
|
||||
// WinFormsUI Library Version 1.0
|
||||
// *****************************************************************************
|
||||
|
||||
using System; |
||||
using System.ComponentModel; |
||||
using System.Windows.Forms; |
||||
|
||||
namespace WeifenLuo.WinFormsUI |
||||
{ |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAreas"]/EnumDef/*'/>
|
||||
[Flags] |
||||
[Serializable] |
||||
[Editor(typeof(DockAreasEditor), typeof(System.Drawing.Design.UITypeEditor))] |
||||
public enum DockAreas |
||||
{ |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAreas"]/Member[@name="Float"]/*'/>
|
||||
Float = 1, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAreas"]/Member[@name="DockLeft"]/*'/>
|
||||
DockLeft = 2, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAreas"]/Member[@name="DockRight"]/*'/>
|
||||
DockRight = 4, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAreas"]/Member[@name="DockTop"]/*'/>
|
||||
DockTop = 8, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAreas"]/Member[@name="DockBottom"]/*'/>
|
||||
DockBottom = 16, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAreas"]/Member[@name="Document"]/*'/>
|
||||
Document = 32 |
||||
} |
||||
|
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/EnumDef/*'/>
|
||||
public enum DockState |
||||
{ |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="Unknown"]/*'/>
|
||||
Unknown = 0, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="Float"]/*'/>
|
||||
Float = 1, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockTopAutoHide"]/*'/>
|
||||
DockTopAutoHide = 2, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockLeftAutoHide"]/*'/>
|
||||
DockLeftAutoHide = 3, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockBottomAutoHide"]/*'/>
|
||||
DockBottomAutoHide = 4, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockRightAutoHide"]/*'/>
|
||||
DockRightAutoHide = 5, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="Document"]/*'/>
|
||||
Document = 6, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockTop"]/*'/>
|
||||
DockTop = 7, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockLeft"]/*'/>
|
||||
DockLeft = 8, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockBottom"]/*'/>
|
||||
DockBottom = 9, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="DockRight"]/*'/>
|
||||
DockRight = 10, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockState"]/Member[@name="Hidden"]/*'/>
|
||||
Hidden = 11 |
||||
} |
||||
|
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAlignment"]/EnumDef/*'/>
|
||||
public enum DockAlignment |
||||
{ |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAlignment"]/Member[@name="Left"]/*'/>
|
||||
Left, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAlignment"]/Member[@name="Right"]/*'/>
|
||||
Right, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAlignment"]/Member[@name="Top"]/*'/>
|
||||
Top, |
||||
/// <include file='CodeDoc\Enums.xml' path='//CodeDoc/Enum[@name="DockAlignment"]/Member[@name="Bottom"]/*'/>
|
||||
Bottom |
||||
} |
||||
} |
@ -0,0 +1,92 @@
@@ -0,0 +1,92 @@
|
||||
// *****************************************************************************
|
||||
//
|
||||
// Copyright 2004, Weifen Luo
|
||||
// All rights reserved. The software and associated documentation
|
||||
// supplied hereunder are the proprietary information of Weifen Luo
|
||||
// and are supplied subject to licence terms.
|
||||
//
|
||||
// WinFormsUI Library Version 1.0
|
||||
// *****************************************************************************
|
||||
|
||||
using System; |
||||
using System.Drawing; |
||||
|
||||
namespace WeifenLuo.WinFormsUI |
||||
{ |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockListContainer"]/InterfaceDef/*'/>
|
||||
public interface IDockListContainer |
||||
{ |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockListContainer"]/Property[@name="DockState"]/*'/>
|
||||
DockState DockState { get; } |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockListContainer"]/Property[@name="DisplayingRectangle"]/*'/>
|
||||
Rectangle DisplayingRectangle { get; } |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockListContainer"]/Property[@name="DockList"]/*'/>
|
||||
DockList DockList { get; } |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockListContainer"]/Property[@name="DisplayingList"]/*'/>
|
||||
DisplayingDockList DisplayingList { get; } |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockListContainer"]/Property[@name="IsDisposed"]/*'/>
|
||||
bool IsDisposed { get; } |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockListContainer"]/Property[@name="IsFloat"]/*'/>
|
||||
bool IsFloat { get; } |
||||
} |
||||
|
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockPaneFactory"]/InterfaceDef/*'/>
|
||||
public interface IDockPaneFactory |
||||
{ |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockPaneFactory"]/Method[@name="CreateDockPane"]/*'/>
|
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockPaneFactory"]/Method[@name="CreateDockPane(DockContent, DockState, bool)"]/*'/>
|
||||
DockPane CreateDockPane(DockContent content, DockState visibleState, bool show); |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockPaneFactory"]/Method[@name="CreateDockPane(DockContent, FloatWindow, bool)"]/*'/>
|
||||
DockPane CreateDockPane(DockContent content, FloatWindow floatWindow, bool show); |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockPaneFactory"]/Method[@name="CreateDockPane(DockContent, DockPane, DockAlignment, double, bool)"]/*'/>
|
||||
DockPane CreateDockPane(DockContent content, DockPane prevPane, DockAlignment alignment, double proportion, bool show); |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IDockPaneFactory"]/Method[@name="CreateDockPane(DockContent, Rectangle, bool)"]/*'/>
|
||||
DockPane CreateDockPane(DockContent content, Rectangle floatWindowBounds, bool show); |
||||
} |
||||
|
||||
internal class DefaultDockPaneFactory : IDockPaneFactory |
||||
{ |
||||
public DockPane CreateDockPane(DockContent content, DockState visibleState, bool show) |
||||
{ |
||||
return new DockPane(content, visibleState, show); |
||||
} |
||||
|
||||
public DockPane CreateDockPane(DockContent content, FloatWindow floatWindow, bool show) |
||||
{ |
||||
return new DockPane(content, floatWindow, show); |
||||
} |
||||
|
||||
public DockPane CreateDockPane(DockContent content, DockPane prevPane, DockAlignment alignment, double proportion, bool show) |
||||
{ |
||||
return new DockPane(content, prevPane, alignment, proportion, show); |
||||
} |
||||
|
||||
public DockPane CreateDockPane(DockContent content, Rectangle floatWindowBounds, bool show) |
||||
{ |
||||
return new DockPane(content, floatWindowBounds, show); |
||||
} |
||||
} |
||||
|
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IFloatWindowFactory"]/InterfaceDef/*'/>
|
||||
public interface IFloatWindowFactory |
||||
{ |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IFloatWindowFactory"]/Method[@name="CreateFloatWindow"]/*'/>
|
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IFloatWindowFactory"]/Method[@name="CreateFloatWindow(DockPanel, DockPane)"]/*'/>
|
||||
FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane); |
||||
/// <include file='CodeDoc\Interfaces.xml' path='//CodeDoc/Interface[@name="IFloatWindowFactory"]/Method[@name="CreateFloatWindow(DockPanel, DockPane, Rectangle)"]/*'/>
|
||||
FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane, Rectangle bounds); |
||||
} |
||||
|
||||
internal class DefaultFloatWindowFactory : IFloatWindowFactory |
||||
{ |
||||
public FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane) |
||||
{ |
||||
return new FloatWindow(dockPanel, pane); |
||||
} |
||||
|
||||
public FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane, Rectangle bounds) |
||||
{ |
||||
return new FloatWindow(dockPanel, pane, bounds); |
||||
} |
||||
} |
||||
} |
@ -1,60 +0,0 @@
@@ -1,60 +0,0 @@
|
||||
// *****************************************************************************
|
||||
//
|
||||
// Copyright 2004, Weifen Luo
|
||||
// All rights reserved. The software and associated documentation
|
||||
// supplied hereunder are the proprietary information of Weifen Luo
|
||||
// and are supplied subject to licence terms.
|
||||
//
|
||||
// WinFormsUI Library Version 1.0
|
||||
// *****************************************************************************
|
||||
|
||||
using System; |
||||
using System.ComponentModel; |
||||
using System.Windows.Forms; |
||||
|
||||
namespace WeifenLuo.WinFormsUI |
||||
{ |
||||
[Flags] |
||||
[Serializable] |
||||
[Editor(typeof(DockAreasEditor), typeof(System.Drawing.Design.UITypeEditor))] |
||||
public enum DockAreas |
||||
{ |
||||
Float = 1, |
||||
DockLeft = 2, |
||||
DockRight = 4, |
||||
DockTop = 8, |
||||
DockBottom = 16, |
||||
Document = 32 |
||||
} |
||||
|
||||
public enum DockState |
||||
{ |
||||
Unknown = 0, |
||||
Float = 1, |
||||
DockTopAutoHide = 2, |
||||
DockLeftAutoHide = 3, |
||||
DockBottomAutoHide = 4, |
||||
DockRightAutoHide = 5, |
||||
Document = 6, |
||||
DockTop = 7, |
||||
DockLeft = 8, |
||||
DockBottom = 9, |
||||
DockRight = 10, |
||||
Hidden = 11 |
||||
} |
||||
|
||||
public enum DockPaneType |
||||
{ |
||||
AutoHide, |
||||
Dock, |
||||
Float |
||||
} |
||||
|
||||
public enum DockAlignment |
||||
{ |
||||
Left, |
||||
Right, |
||||
Top, |
||||
Bottom |
||||
} |
||||
} |
@ -1,69 +0,0 @@
@@ -1,69 +0,0 @@
|
||||
// *****************************************************************************
|
||||
//
|
||||
// Copyright 2004, Weifen Luo
|
||||
// All rights reserved. The software and associated documentation
|
||||
// supplied hereunder are the proprietary information of Weifen Luo
|
||||
// and are supplied subject to licence terms.
|
||||
//
|
||||
// WinFormsUI Library Version 1.0
|
||||
// *****************************************************************************
|
||||
|
||||
using System; |
||||
using System.Drawing; |
||||
|
||||
namespace WeifenLuo.WinFormsUI |
||||
{ |
||||
public interface IDockListContainer |
||||
{ |
||||
DockState DockState { get; } |
||||
Rectangle DisplayingRectangle { get; } |
||||
DockList DockList { get; } |
||||
DisplayingDockList DisplayingList { get; } |
||||
bool IsDisposed { get; } |
||||
bool IsFloat { get; } |
||||
} |
||||
|
||||
public interface IDockPaneFactory |
||||
{ |
||||
DockPane CreateDockPane(DockContent content, DockState visibleState, bool show); |
||||
DockPane CreateDockPane(DockContent content, FloatWindow floatWindow, bool show); |
||||
DockPane CreateDockPane(DockContent content, Rectangle floatWindowBounds, bool show); |
||||
} |
||||
|
||||
internal class DefaultDockPaneFactory : IDockPaneFactory |
||||
{ |
||||
public DockPane CreateDockPane(DockContent content, DockState visibleState, bool show) |
||||
{ |
||||
return new DockPane(content, visibleState, show); |
||||
} |
||||
|
||||
public DockPane CreateDockPane(DockContent content, FloatWindow floatWindow, bool show) |
||||
{ |
||||
return new DockPane(content, floatWindow, show); |
||||
} |
||||
|
||||
public DockPane CreateDockPane(DockContent content, Rectangle floatWindowBounds, bool show) |
||||
{ |
||||
return new DockPane(content, floatWindowBounds, show); |
||||
} |
||||
} |
||||
|
||||
public interface IFloatWindowFactory |
||||
{ |
||||
FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane); |
||||
FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane, Rectangle bounds); |
||||
} |
||||
|
||||
internal class DefaultFloatWindowFactory : IFloatWindowFactory |
||||
{ |
||||
public FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane) |
||||
{ |
||||
return new FloatWindow(dockPanel, pane); |
||||
} |
||||
|
||||
public FloatWindow CreateFloatWindow(DockPanel dockPanel, DockPane pane, Rectangle bounds) |
||||
{ |
||||
return new FloatWindow(dockPanel, pane, bounds); |
||||
} |
||||
} |
||||
} |
Loading…
Reference in new issue