From e114ba0527bf256b061cf445ce06aad6d28fbf09 Mon Sep 17 00:00:00 2001
From: NaBian <836904362@qq.com>
Date: Mon, 3 Aug 2020 22:22:31 +0800
Subject: [PATCH] add dialog doc

---
 .../extend_controls/dialog/index.md           | 104 +++++++++++++++++-
 1 file changed, 102 insertions(+), 2 deletions(-)

diff --git a/doc/source/handycontrol/extend_controls/dialog/index.md b/doc/source/handycontrol/extend_controls/dialog/index.md
index ca12ad62..e1fd778a 100644
--- a/doc/source/handycontrol/extend_controls/dialog/index.md
+++ b/doc/source/handycontrol/extend_controls/dialog/index.md
@@ -1,5 +1,105 @@
 ---
-title: 建设中
+title: Dialog 对话框
 ---
 
-建设中
\ No newline at end of file
+在保留当前页面状态的情况下，告知用户并承载相关操作。
+
+```cs
+public class Dialog : ContentControl
+```
+
+# 属性
+
+|属性|描述|默认值|备注|
+|-|-|-|-|
+|IsClosed|是否关闭||||
+
+# 附加属性
+
+|名称|说明|
+|-|-|
+| Token | 用于设置消息标记 |
+
+# 方法
+
+|名称|说明|
+|-|-|
+| Show(object, string) | 显示承载内容 |
+| Show<T>(string) | 显示承载内容（自动实例化承载内容） |
+| Close( ) | 关闭 |
+| Register(string, FrameworkElement) | 为指定的元素注册消息标记 |
+| Unregister(string, Panel) | 为指定的元素取消消息标记的注册 |
+| Unregister(Panel) | 如果该元素注册了消息标记则取消注册 |
+| Unregister(string) | 如果该消息标记有对应的元素则取消注册 |
+
+# 案例
+
+## 基本用法
+
+```xml
+<Border x:Class="HandyControlDemo.UserControl.TextDialog"
+        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+        xmlns:langs="clr-namespace:HandyControlDemo.Properties.Langs"
+        xmlns:ex="clr-namespace:HandyControlDemo.Tools.Extension"
+        xmlns:hc="https://handyorg.github.io/handycontrol"
+        CornerRadius="10"
+        Width="400"
+        Height="247"
+        Background="{DynamicResource RegionBrush}">
+    <hc:SimplePanel>
+        <TextBlock Style="{StaticResource TextBlockLargeBold}" Text="{ex:Lang Key={x:Static langs:LangKeys.PleaseWait}}"/>
+        <Button Width="22" Height="22" Command="hc:ControlCommands.Close" Style="{StaticResource ButtonIcon}" Foreground="{DynamicResource PrimaryBrush}" hc:IconElement.Geometry="{StaticResource ErrorGeometry}" Padding="0" HorizontalAlignment="Right" VerticalAlignment="Top" Margin="0,4,4,0"/>    
+    </hc:SimplePanel>
+</Border>
+```
+
+```cs
+namespace HandyControlDemo.UserControl
+{
+    public partial class TextDialog
+    {
+        public TextDialog()
+        {
+            InitializeComponent();
+        }
+    }
+}
+```
+
+```cs
+Dialog.Show(new TextDialog());
+```
+
+![Dialog](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Resources/Dialog.png)
+
+## 异步等待结果返回
+
+通过`Initialize`扩展方法初始化vm后，可在此基础上使用`GetResultAsync`方法实现异步等待：
+
+```cs
+Dialog.Show<InteractiveDialog>()
+    .Initialize<InteractiveDialogViewModel>(vm => vm.Message = DialogResult)
+    .GetResultAsync<string>()
+    .ContinueWith(str => DialogResult = str.Result);
+```
+
+## 更简单的异步方式
+
+```cs
+var d = Dialog.Show<ProgressDialog>();
+await Task.Delay(5 * 1000);
+d.Close();
+```
+
+# 弹框行为
+
+如果在调用`Show`方法时，没有给定`token`参数，则默认会在当前激活的窗口弹框。如果`token`给定了值，内部会判断目标元素的类型，如果类型是窗口，则会在该窗口下的装饰层中弹出，否则会寻找目标元素的子元素，直到找到类型为`DialogContainer`的子元素，最后会在该子元素内部弹出。
+
+```cs
+<UserControl hc:Dialog.Token="DialogContainer">
+    <hc:DialogContainer>
+        // 内部控件
+    </hc:DialogContainer>
+</UserControl>
+```
\ No newline at end of file