From 790d95cf84096a94dddc021d463d56eb5463a3fe Mon Sep 17 00:00:00 2001 From: NaBian <836904362@qq.com> Date: Sat, 8 Feb 2020 13:58:59 +0800 Subject: [PATCH] update doc --- .../basic_xaml/geometries/index.md | 7 + .../native_controls/frame/index.md | 17 ++ .../native_controls/textBlock/index.md | 36 +++- .../native_controls/textBox/index.md | 39 +++- .../native_controls/toggleButton/index.md | 176 +++++++++++++++++- .../native_controls/toolBar/index.md | 20 +- .../native_controls/toolTip/index.md | 6 +- .../native_controls/treeView/index.md | 34 +++- .../native_controls/window/index.md | 12 +- doc/source/handykeras/index.md | 4 - doc/themes/next/_config.yml | 1 + .../next/source/css/_custom/custom.styl | 1 + .../Themes/Styles/Base/TreeViewBaseStyle.xaml | 1 + .../HandyControl_Shared.projitems | 4 + .../Themes/Basic/Geometries.xaml | 4 +- .../Themes/Styles/Base/FrameBaseStyle.xaml | 4 +- .../Styles/Base/ToggleButtonBaseStyle.xaml | 1 - .../Themes/Styles/Base/ToolTipBaseStyle.xaml | 22 +++ .../Themes/Styles/ToggleButton.xaml | 1 - .../Themes/Styles/ToolTip.xaml | 24 +-- 20 files changed, 372 insertions(+), 42 deletions(-) create mode 100644 doc/source/handycontrol/native_controls/frame/index.md delete mode 100644 doc/source/handykeras/index.md create mode 100644 src/Shared/HandyControl_Shared/Themes/Styles/Base/ToolTipBaseStyle.xaml diff --git a/doc/source/handycontrol/basic_xaml/geometries/index.md b/doc/source/handycontrol/basic_xaml/geometries/index.md index 7304c03f..3d01060e 100644 --- a/doc/source/handycontrol/basic_xaml/geometries/index.md +++ b/doc/source/handycontrol/basic_xaml/geometries/index.md @@ -16,6 +16,7 @@ HandyControl中自带了一些几何形状定义,但要应用于生产中显 | LeftGeometry | 左 | | RightGeometry | 右 | | RotateLeftGeometry | 向左旋转 | +| RotateRightGeometry | 向左旋转 | | EnlargeGeometry | 放大 | | ReduceGeometry | 缩小 | | DownloadGeometry | 下载 | @@ -28,6 +29,12 @@ HandyControl中自带了一些几何形状定义,但要应用于生产中显 | WindowMinGeometry | 窗口最小化 | | WindowRestoreGeometry | 窗口还原 | | WindowMaxGeometry | 窗口最大化 | +| CheckedGeometry | 选中 | +| PageModeGeometry | 单页模式 | +| TwoPageModeGeometry | 双页模式 | +| ScrollModeGeometry | 滚动模式 | +| EyeOpenGeometry | 睁眼 | +| EyeCloseGeometry | 闭眼 | | AudioGeometry | 声音 | | BubbleTailGeometry | 气泡的尾巴 | | StarGeometry | 爱心 | diff --git a/doc/source/handycontrol/native_controls/frame/index.md b/doc/source/handycontrol/native_controls/frame/index.md new file mode 100644 index 00000000..b78c4faa --- /dev/null +++ b/doc/source/handycontrol/native_controls/frame/index.md @@ -0,0 +1,17 @@ +--- +title: Frame 导航框架 +--- + +# FrameBaseStyle + +导航框架默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +案例: + +``` xml + +``` + +效果: + +![FrameBaseStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/FrameBaseStyle.png) \ No newline at end of file diff --git a/doc/source/handycontrol/native_controls/textBlock/index.md b/doc/source/handycontrol/native_controls/textBlock/index.md index ca12ad62..b1baf500 100644 --- a/doc/source/handycontrol/native_controls/textBlock/index.md +++ b/doc/source/handycontrol/native_controls/textBlock/index.md @@ -1,5 +1,37 @@ --- -title: 建设中 +title: TextBlock 文本块 --- -建设中 \ No newline at end of file +# TextBlockBaseStyle + +文本块默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +# TextBlockBoldBaseStyle + +文本块粗体默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +# 案例 + +```xml + + + + + + + + + + + + + + + + + + + +``` + +![TextBlockStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Resources/TextBlock.jpg) \ No newline at end of file diff --git a/doc/source/handycontrol/native_controls/textBox/index.md b/doc/source/handycontrol/native_controls/textBox/index.md index ca12ad62..b9a3dcc8 100644 --- a/doc/source/handycontrol/native_controls/textBox/index.md +++ b/doc/source/handycontrol/native_controls/textBox/index.md @@ -1,5 +1,40 @@ --- -title: 建设中 +title: TextBox 文本框 --- -建设中 \ No newline at end of file +# TextBoxBaseStyle + +原生文本框默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +- 默认样式 +`` +![TextBoxBaseStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/TextBoxBaseStyle.png) + +# TextBoxExtendBaseStyle : TextBoxBaseStyle + +原生文本框扩展默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +# TextBoxExtend : TextBoxExtendBaseStyle + +相对于原生文本框默认样式,它借助于附加属性可以实现标题、水印的功能。 + +- 标题在上 +`` +![TextBoxExtend_1](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/TextBoxExtend_1.png) + +- 标题在左 +`` +![TextBoxExtend_2](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/TextBoxExtend_2.png) + +{% note warning %} +标题在左时,为了多个输入框左侧对齐,需要设置标题宽度,标题宽度无需逐个设置,可在外部容器上统一设置。 +{% endnote %} + +- 标题在上,带有水印 +[参见Combobox](https://handyorg.github.io/handycontrol/native_controls/comboBox/) + +- 标题在上,带有水印,且为必填 +[参见Combobox](https://handyorg.github.io/handycontrol/native_controls/comboBox/) + +- 标题在上,带有水印,且为必填,同时自定义必填提示符 +[参见Combobox](https://handyorg.github.io/handycontrol/native_controls/comboBox/) \ No newline at end of file diff --git a/doc/source/handycontrol/native_controls/toggleButton/index.md b/doc/source/handycontrol/native_controls/toggleButton/index.md index ca12ad62..c2e65ddc 100644 --- a/doc/source/handycontrol/native_controls/toggleButton/index.md +++ b/doc/source/handycontrol/native_controls/toggleButton/index.md @@ -1,5 +1,177 @@ --- -title: 建设中 +title: ToggleButton 切换按钮 --- -建设中 \ No newline at end of file +# ToggleButtonBaseStyle : ButtonBaseBaseStyle + +切换按钮默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +{% note info %} +所有继承此样式的按钮都可以使用`IconElement`中定义的附加属性来控制按钮中几何图形的属性。 +{% endnote %} + +{% note info %} +所有继承此样式的按钮都可以使用`BorderElement.CornerRadius`附加属性来控制按钮的圆角大小。 +{% endnote %} + +## 相关样式 + +| 名称 | 继承自 | 用途描述 | +| - | - | - | +| ToggleButtonPrimary | ToggleButtonBaseStyle | 主要 | +| ToggleButtonSuccess | ToggleButtonBaseStyle | 成功 | +| ToggleButtonInfo | ToggleButtonBaseStyle | 信息 | +| ToggleButtonWarning | ToggleButtonBaseStyle | 警告 | +| ToggleButtonDanger | ToggleButtonBaseStyle | 危险 | + +案例: + +```xml + + + + + + + + +``` + +效果: + +![ToggleButtonBaseStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ToggleButtonBaseStyle.png) + +# ToggleButtonIconBaseStyle : BaseStyle + +只显示图标的切换按钮,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +{% note info %} +所有继承此样式的按钮都可以使用`IconElement`中定义的附加属性来控制按钮中几何图形的属性。 +{% endnote %} + +{% note info %} +所有继承此样式的按钮都可以使用`BorderElement.CornerRadius`附加属性来控制按钮的圆角大小。 +{% endnote %} + +## 相关样式 + +| 名称 | 继承自 | 用途描述 | +| - | - | - | +| ToggleButtonIcon | ToggleButtonIconBaseStyle | 默认 | +| ToggleButtonIconPrimary | ToggleButtonIconBaseStyle | 主要 | +| ToggleButtonIconSuccess | ToggleButtonIconBaseStyle | 成功 | +| ToggleButtonIconInfo | ToggleButtonIconBaseStyle | 信息 | +| ToggleButtonIconWarning | ToggleButtonIconBaseStyle | 警告 | +| ToggleButtonIconDanger | ToggleButtonIconBaseStyle | 危险 | +| ToggleButtonIconTransparent | ToggleButtonIconBaseStyle | 透明 | + +案例: + +```xml + + + + + + + + + +``` + +效果: + +![ToggleButtonIconBaseStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ToggleButtonIconBaseStyle.png) + +# ToggleButtonSwitchBaseStyle : BaseStyle + +开关式切换按钮,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +## 相关样式 + +| 名称 | 继承自 | +| - | - | - | +| ToggleButtonSwitch | ToggleButtonSwitchBaseStyle | + +案例: + +```xml + + + + +``` + +效果: + +![ToggleButtonSwitchBaseStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ToggleButtonSwitchBaseStyle.png) + +# ToggleButtonFlip : BaseStyle + +翻转式切换按钮。 + +案例: + +```xml + + + + + + + + + + + + + + + + + + + + + + +``` + +效果: + +![ToggleButtonFlip](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ToggleButtonFlip.png) + +# ToggleButtonCustom : BaseStyle + +如果想完全自定义按钮的内容,则推荐使用此样式。`ToggleButtonCustom`中的内容完全由你自己决定。 + +案例: + +```xml + + + + + + + + + + + + + + + + + + + + + + +``` + +效果: + +![ToggleButtonCustom](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ToggleButtonCustom.png) \ No newline at end of file diff --git a/doc/source/handycontrol/native_controls/toolBar/index.md b/doc/source/handycontrol/native_controls/toolBar/index.md index ca12ad62..17b6d024 100644 --- a/doc/source/handycontrol/native_controls/toolBar/index.md +++ b/doc/source/handycontrol/native_controls/toolBar/index.md @@ -1,5 +1,21 @@ --- -title: 建设中 +title: ToolBar 工具条 --- -建设中 \ No newline at end of file +# ToolBarBaseStyle + +工具条默认样式,不推荐直接使用,应该始终被其它样式以BasedOn的方式使用。 + +案例: + +```xml + +