chfei/HandyControl
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modified doc

Browse Source 
uniform doc structure
This commit is contained in:
NaBian committed 2020-01-05 22:31:29 +08:00
1 parent 1fef31fbd2
commit cef6fd433e
5 files changed
+49 -115
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/source/handycontrol/native_controls/label/index.md
+1 -1
View File
@@ -4,7 +4,7 @@ title: Lable标签
# LabelBaseStyle
Label标签 默认样式，不推荐直接使用，应该始终被其它样式以BasedOn的方式使用。
Label标签默认样式，不推荐直接使用，应该始终被其它样式以BasedOn的方式使用。
{% note info no-icon %}
用例：
doc/source/handycontrol/native_controls/listView/index.md
+7 -7
View File
@@ -2,11 +2,11 @@
title: ListView 列表视图
---
`HandyControl`中仅仅提供了一个默认的`ListView`的资源样式，可根据个人需求，自行定义
`HandyControl`中仅提供了一个默认的`ListView`样式，可根据个人需求，自行定义。
# 案例
```
{% note info no-icon %}
用例：
{% code %}
<ListView ItemsSource="{Binding DataList}" Margin="20">
<ListView.View>
<GridView>
@@ -16,8 +16,8 @@ title: ListView 列表视图
</GridView>
</ListView.View>
</ListView>
```
{% endcode %}
![ListView.DefaultStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ListView.DefaultStyle.png)
![ListView.DefaultStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/ListView.DefaultStyle.png)
{% endnote %}
doc/source/handycontrol/native_controls/menu/index.md
+7 -66
View File
@@ -4,79 +4,20 @@ title: Menu 菜单
# MenuBaseStyle
`HandyControl`中的菜单默认样式，一般不建议直接使用，而是选择继承，便于个人自定义风格
菜单默认样式，不推荐直接使用，应该始终被其它样式以BasedOn的方式使用。
样式
```xml
<Style BasedOn="{StaticResource MenuItemBaseStyle}" TargetType="MenuItem"/>
<Style BasedOn="{StaticResource MenuBaseStyle}" TargetType="Menu"/>
```
使用
```
<Menu ItemsSource="{Binding Menus}">
{% note info no-icon %}
用例：
{% code %}
<Menu ItemsSource="{Binding Menus}">
<Menu.ItemTemplate>
<HierarchicalDataTemplate ItemsSource="{Binding Children}">
<TextBlock Text="{Binding Name}"></TextBlock>
</HierarchicalDataTemplate>
</Menu.ItemTemplate>
</Menu>
```
数据视图
```c#
//菜单子项视图类
public class MenuItemViewModel
{
public List<MenuItemViewModel> Children { get; set; }
public MenuItemViewModel Parent { get; set; }
public string Name { get; set; }
public string Remark { get; set; }
}
//菜单数据视图类
public class MenuViewModel
{
public MenuViewModel()
{
Menus = new List<MenuItemViewModel>
{
new MenuItemViewModel
{
Name="一级菜单",
Children = new List<MenuItemViewModel>{
new MenuItemViewModel{
Name="二级菜单"
}
}
},
new MenuItemViewModel
{
Name="一级菜单",
Children = new List<MenuItemViewModel>{
new MenuItemViewModel{
Name="二级菜单"
}
}
},
new MenuItemViewModel
{
Name="一级菜单",
Children = new List<MenuItemViewModel>{
new MenuItemViewModel{
Name="二级菜单"
}
}
}
};
}
public List<MenuItemViewModel> Menus { get; set; }
}
```
效果
{% endcode %}
![Menu.BaseStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/Menu.BaseStyle.png)
{% endnote %}
doc/source/handycontrol/native_controls/passwordBox/index.md
+19 -20
View File
@@ -4,29 +4,29 @@ title: PasswordBox 密码框
# PasswordBoxBaseStyle
控件默认样式，该样式不建议直接使用，而是选择继承的方式进行个人控件样式的处理，参考在线资源[PasswordBoxBaseStyle](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/Base/PasswordBoxBaseStyle.xaml)
原生密码框默认样式，不推荐直接使用，应该始终被其它样式以BasedOn的方式使用。
```
<Style BasedOn="{StaticResource PasswordBoxBaseStyle}" TargetType="PasswordBox"/>
```
使用
```
<PasswordBox PasswordChar="*"
VerticalAlignment="Center"
Width="120"></PasswordBox>
```
效果
{% note info no-icon %}
用例：
{% code %}
<PasswordBox PasswordChar="*" VerticalAlignment="Center" Width="120"></PasswordBox>
{% endcode %}
![PasswordBox.BaseStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/PasswordBox.BaseStyle.png)
# PasswordBoxExtendBaseStyle
{% endnote %}
控件拓展基础样式，是样式`PasswordBoxExtend`的基本样式，不建议直接使用，而是选择使用`PasswordBoxExtend`，该样式支持添加`PasswordBox`专用附加属性`PasswordBoxAttach`、额外信息元素`InfoElement`和标题元素`TitleElement`
# PasswordBoxExtendBaseStyle : PasswordBoxBaseStyle
```
原生密码框扩展默认样式，不推荐直接使用，应该始终被其它样式以BasedOn的方式使用。
# PasswordBoxExtend : PasswordBoxExtendBaseStyle
相对于原生密码框默认样式，它借助于附加属性可以实现标题、水印的功能。
{% note info no-icon %}
用例：
{% code %}
<!--为使普通密码输入文本框显示水印,需要设定PasswordBoxAttach.PasswordLength="0"-->
<PasswordBox Style="{DynamicResource PasswordBoxExtend}" PasswordChar="*"
hc:PasswordBoxAttach.PasswordLength="0"
@@ -38,9 +38,8 @@ title: PasswordBox 密码框
hc:TitleElement.TitleAlignment="Top"
VerticalAlignment="Center"
Width="120"></PasswordBox>
```
效果
{% endcode %}
![PasswordBox.ExtendStyle](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/native_controls/PasswordBox.ExtendStyle.png)
{% endnote %}
doc/source/handycontrol/native_controls/progressBar/index.md
+15 -21
View File
@@ -4,30 +4,25 @@ title: ProgressBar 进度条
# ProgressBarBaseStyle
`HandyControl`中自带的默认样式，不建议直接使用而是选择继承的方式，案例如下：
```
<Style BasedOn="{StaticResource ProgressBarBaseStyle}" TargetType="ProgressBar">
<Setter Property="Foreground" Value="{DynamicResource PrimaryBrush}"/>
</Style>
```
进度条默认样式，不推荐直接使用，应该始终被其它样式以BasedOn的方式使用。
# 其他样式
`HandyControl`中自带的其他样式和效果，其中包含如下样式：
| 样式Key | 用途 |
| ------------------ | ---- |
| ProgressBarSuccess | 成功色进度条 |
| ProgressBarInfo | 提示色进度条 |
| ProgressBarWarning | 警告色进度条 |
| ProgressBarDanger | 危险色进度条 |
| ProgressBarPrimaryStripe | 主题色条纹进度条 |
| ProgressBarSuccessStripe | 成功色条纹进度条 |
| ProgressBarInfoStripe | 信息色条纹进度条 |
| ProgressBarWarningStripe | 警告色条纹进度条 |
| ProgressBarDangerStripe | 危险色条纹进度条 |
| ProgressBarFlat | 扁平风格 |
| 样式Key | 用途 |父样式|
| ------------------ | ---- ||
| ProgressBarSuccess | 成功色进度条 |ProgressBarBaseStyle|
| ProgressBarInfo | 提示色进度条 |ProgressBarBaseStyle|
| ProgressBarWarning | 警告色进度条 |ProgressBarBaseStyle|
| ProgressBarDanger | 危险色进度条 |ProgressBarBaseStyle|
| ProgressBarStripeBaseStyle | 条纹进度条默认样式（不推荐直接使用） |-|
| ProgressBarPrimaryStripe | 主题色条纹进度条 |ProgressBarStripeBaseStyle|
| ProgressBarSuccessStripe | 成功色条纹进度条 |ProgressBarStripeBaseStyle|
| ProgressBarInfoStripe | 信息色条纹进度条 |ProgressBarStripeBaseStyle|
| ProgressBarWarningStripe | 警告色条纹进度条 |ProgressBarStripeBaseStyle|
| ProgressBarDangerStripe | 危险色条纹进度条 |ProgressBarStripeBaseStyle|
| ProgressBarFlat | 扁平风格 |-|
案例：
```xml
@@ -81,5 +76,4 @@ title: ProgressBar 进度条
# 温馨提示
对于进度条进度颜色、圆角以及其他样式的个人使用需求，可查看`HandyControl`开源目中的[源码样式部分](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/ProgressBar.xaml)自行定义
对于颜色、圆角或其它自定义需求，可参考[进度条样式源码](https://github.com/HandyOrg/HandyControl/blob/master/src/Shared/HandyControl_Shared/Themes/Styles/ProgressBar.xaml)自行定义。