From 625aeba450b57b0a00851e06f171a335d0f86ee4 Mon Sep 17 00:00:00 2001 From: NaBian <836904362@qq.com> Date: Sat, 22 Aug 2020 11:19:49 +0800 Subject: [PATCH] update docs --- .../extend_controls/transfer/index.md | 43 ++++++++- .../transitioningContentControl/index.md | 93 ++++++++++++++++++- .../extend_controls/waterfallPanel/index.md | 69 +++++++++++++- .../extend_controls/waveProgressBar/index.md | 39 +++++++- .../extend_controls/window/index.md | 53 ++++++++++- doc/themes/next/_config.yml | 4 +- 6 files changed, 289 insertions(+), 12 deletions(-) diff --git a/doc/source/handycontrol/extend_controls/transfer/index.md b/doc/source/handycontrol/extend_controls/transfer/index.md index ca12ad62..9e01dcee 100644 --- a/doc/source/handycontrol/extend_controls/transfer/index.md +++ b/doc/source/handycontrol/extend_controls/transfer/index.md @@ -1,5 +1,44 @@ --- -title: 建设中 +title: Transfer 穿梭框 --- -建设中 \ No newline at end of file +穿梭选择框用直观的方式在两栏中移动元素,完成选择行为。 + +```cs +[DefaultProperty("Items")] +[ContentProperty("Items")] +[TemplatePart(Name = ElementPanel, Type = typeof(Panel))] +public class SimpleItemsControl : Control +``` + +```cs +[TemplatePart(Name = ElementItemsOrigin, Type = typeof(SimpleItemsControl))] +[TemplatePart(Name = ElementItemsSelected, Type = typeof(SimpleItemsControl))] +public class Transfer : SimpleItemsControl +``` + +# 属性 + +|属性|描述|默认值|备注| +|-|-|-|-| +|SelectedItems|选中项|||| + +# 事件 + +|名称|说明| +|-|-| +| SelectionChanged | 选中项改变时触发 | + +# 案例 + +```xml + + + + + + + +``` + +![Transfer](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Resources/Transfer.png) \ No newline at end of file diff --git a/doc/source/handycontrol/extend_controls/transitioningContentControl/index.md b/doc/source/handycontrol/extend_controls/transitioningContentControl/index.md index ca12ad62..f0339dbe 100644 --- a/doc/source/handycontrol/extend_controls/transitioningContentControl/index.md +++ b/doc/source/handycontrol/extend_controls/transitioningContentControl/index.md @@ -1,5 +1,94 @@ --- -title: 建设中 +title: TransitioningContentControl 内容过渡控件 --- -建设中 \ No newline at end of file +主要用于变化内容的过渡呈现效果. + +```cs +public class TransitioningContentControl : ContentControl +``` + +# 属性 + +|属性|描述|默认值|备注| +|-|-|-|-| +|TransitionMode|过渡模式|TransitionMode.Right2Left|| +|TransitionStoryboard|过渡动画|||| + +# 案例 + +```xml + + + + + + + + + + + + + + + + + + + + + + + +``` + +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +![TransitioningContentControl](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Resources/TransitioningContentControl.gif) \ No newline at end of file diff --git a/doc/source/handycontrol/extend_controls/waterfallPanel/index.md b/doc/source/handycontrol/extend_controls/waterfallPanel/index.md index ca12ad62..3f2c48ad 100644 --- a/doc/source/handycontrol/extend_controls/waterfallPanel/index.md +++ b/doc/source/handycontrol/extend_controls/waterfallPanel/index.md @@ -1,5 +1,70 @@ --- -title: 建设中 +title: WaterfallPanel 瀑布流 --- -建设中 \ No newline at end of file +该面板可使元素按照等宽不等高或者等高不等宽进行布局. + +```cs +public class WaterfallPanel : Panel +``` + +# 属性 + +|属性|描述|默认值|备注| +|-|-|-|-| +|Groups|组数|2|等宽不等高时即为列数,等高不等宽即为行数| +|Orientation|排列方向|Orientation.Horizontal|Horizontal为等宽不等高,Vertical为等高不等宽|| + +# 案例 + +```xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +![WaterfallPanel](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Resources/WaterfallPanel.png) \ No newline at end of file diff --git a/doc/source/handycontrol/extend_controls/waveProgressBar/index.md b/doc/source/handycontrol/extend_controls/waveProgressBar/index.md index ca12ad62..a177df07 100644 --- a/doc/source/handycontrol/extend_controls/waveProgressBar/index.md +++ b/doc/source/handycontrol/extend_controls/waveProgressBar/index.md @@ -1,5 +1,40 @@ --- -title: 建设中 +title: WaveProgressBar 波形进度条 --- -建设中 \ No newline at end of file +进度条的一种特殊效果,可用于增强用户体验. + +```cs +[TemplatePart(Name = ElementWave, Type = typeof(FrameworkElement))] +[TemplatePart(Name = ElementClip, Type = typeof(FrameworkElement))] +public class WaveProgressBar : RangeBase +``` + +# 属性 + +|属性|描述|默认值|备注| +|-|-|-|-| +|Text|进度文本||| +|ShowText|是否显示进度文本|true|| +|WaveFill|波浪画刷||| +|WaveThickness|波浪边框粗细|0|| +|WaveStroke|波浪边框画刷|||| + +# 案例 + +```xml + + + + + + + + + + + + +``` + +![WaveProgressBar](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Resources/WaveProgressBar.gif) \ No newline at end of file diff --git a/doc/source/handycontrol/extend_controls/window/index.md b/doc/source/handycontrol/extend_controls/window/index.md index ca12ad62..1b962e8b 100644 --- a/doc/source/handycontrol/extend_controls/window/index.md +++ b/doc/source/handycontrol/extend_controls/window/index.md @@ -1,5 +1,54 @@ --- -title: 建设中 +title: Window 窗口 --- -建设中 \ No newline at end of file +HC 对wpf原生 `Window` 的扩展. + +```cs +[TemplatePart(Name = ElementNonClientArea, Type = typeof(UIElement))] +public class Window : System.Windows.Window +``` + +# 属性 + +|属性|描述|默认值|备注| +|-|-|-|-| +|CloseButtonBackground|关闭按钮背景色||| +|CloseButtonForeground|关闭按钮前景色||| +|CloseButtonHoverBackground|关闭按钮鼠标悬浮背景色||| +|CloseButtonHoverForeground|关闭按钮鼠标悬浮前景色||| +|OtherButtonBackground|其它按钮背景色||| +|OtherButtonForeground|其它按钮前景色||| +|OtherButtonHoverBackground|其它按钮鼠标悬浮背景色||| +|OtherButtonHoverForeground|其它按钮鼠标悬浮前景色||| +|NonClientAreaContent|非客户端区域内容||| +|NonClientAreaBackground|非客户端区域背景色||| +|NonClientAreaForeground|非客户端区域前景色||| +|NonClientAreaHeight|非客户端区域高度||| +|ShowNonClientArea|是否显示非客户端区域|true|| +|ShowTitle|是否显示窗口标题|true|| +|IsFullScreen|窗口是否处于全屏|false||| + +# 案例 + +```xml + + + +``` + +![Window](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/Window.png) \ No newline at end of file diff --git a/doc/themes/next/_config.yml b/doc/themes/next/_config.yml index 1635e865..ee00fab0 100644 --- a/doc/themes/next/_config.yml +++ b/doc/themes/next/_config.yml @@ -158,7 +158,7 @@ baidu_push: false # External url should start with http:// or https:// menu: 主页: / || - HandyControl - 2.4.0: + HandyControl - 3.0.0: default: /handycontrol/ || 鸣谢: /tnx/ || 快速开始: /quick_start/ || @@ -294,7 +294,7 @@ menu: TimeBar 时间条: /timeBar/ || TimePicker 时间选择器: /timePicker/ || Transfer 穿梭框: /transfer/ || - TransitioningContentControl 内容过度控件: /transitioningContentControl/ || + TransitioningContentControl 内容过渡控件: /transitioningContentControl/ || WaterfallPanel 瀑布流: /waterfallPanel/ || WaveProgressBar 波形进度条: /waveProgressBar/ || Window 窗口: /window/ ||