From dc7ce06e6a64a388954b96834c769beea93b0637 Mon Sep 17 00:00:00 2001 From: DinoChan Date: Fri, 10 Jan 2020 13:06:45 +0800 Subject: [PATCH] update doc --- .../calendarWithClock/index.md | 65 ++++++++++++- .../extend_controls/datePicker/index.md | 12 +-- .../extend_controls/dateTimePicker/index.md | 81 +++++++++++++++- .../extend_controls/timePicker/index.md | 94 ++++++++++++++++++- 4 files changed, 240 insertions(+), 12 deletions(-) diff --git a/doc/source/handycontrol/extend_controls/calendarWithClock/index.md b/doc/source/handycontrol/extend_controls/calendarWithClock/index.md index ca12ad62..1705ddf9 100644 --- a/doc/source/handycontrol/extend_controls/calendarWithClock/index.md +++ b/doc/source/handycontrol/extend_controls/calendarWithClock/index.md @@ -1,5 +1,66 @@ --- -title: 建设中 +title: CalendarWithClock --- -建设中 \ No newline at end of file + +CalendarWithClock 控件由日历和时钟组成，允许用户通过鼠标选择日期和时间。 + +``` CS +[TemplatePart(Name = ElementButtonConfirm, Type = typeof(Button))] +[TemplatePart(Name = ElementClockPresenter, Type = typeof(ContentPresenter))] +[TemplatePart(Name = ElementCalendarPresenter, Type = typeof(ContentPresenter))] +public class CalendarWithClock : Control +``` + +# 创建日期选取器 + +``` XML + +``` + +``` CS +var dateTimePicker = new CalendarWithClock(); +``` + +生成的CalendarWithClock如下图所示： + +![DateTimePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/CalendarWithClock_1.png) + + + +# 选择日期和时间 + +通过鼠标分别在日历和时钟上选择日期和时间，然后点击 **确定** 按钮即可更新CalendarWithClock控件的日期和时间。 + + +也可以在XAML钟或代码中这样设置日期。 + +``` XML + +``` + +``` CS +calendarWithClock.SelectedDateTime = DateTime.Now; +``` + + + +# 属性 + +| 属性 | 描述 | +| ---------------- | ------------------ | +| SelectedDateTime | 获取或设置当前选中的日期和时间 | +| DateTimeFormat | 获取或设置用于显示选定日期和时间的格式 | +| DisplayDateTime | 获取或设置要显示的日期 | +| ShowConfirmButton | 获取或设置一个值，该值指示是是否显示 **确定** 按钮 | +| VerifyFunc | 获取或设置数据验证委托 | +| IsError | 获取或设置数据是否错误 | +| ErrorStr | 获取或设置错误提示 | +| TextType | 获取或设置文本类型 | +| ShowClearButton | 获取或设置是否显示清除按钮 | + +# 方法 + +| 方法 | 描述 | +| ---------------- | ------------------ | +| VerifyData() | 验证数据 | \ No newline at end of file diff --git a/doc/source/handycontrol/extend_controls/datePicker/index.md b/doc/source/handycontrol/extend_controls/datePicker/index.md index 91806da6..f61a8282 100644 --- a/doc/source/handycontrol/extend_controls/datePicker/index.md +++ b/doc/source/handycontrol/extend_controls/datePicker/index.md @@ -9,7 +9,7 @@ DatePicker 控件允许用户通过在文本框中键入日期或使用下拉的 public class DatePicker : System.Windows.Controls.DatePicker, IDataInput ``` -# 创建日期选取器 +# 创建DatePicker ``` XML @@ -21,15 +21,15 @@ var datePicker = new DatePicker(); 生成的DatePicker如下图所示： -![DatePicker](https://raw.githubusercontent.com/DinoChan/HandyOrgResource/master/HandyControl/Doc/extend_controls/DatePicker_1.png) +![DatePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/DatePicker_1.png) # 选择日期 -可以通过文本框输入日期，或者点击文本框右边的按钮打开下来的日历控件选择日期。 +可以通过文本框输入日期，或者点击文本框右边的按钮打开下拉的日历控件选择日期。 -![DatePicker](https://raw.githubusercontent.com/DinoChan/HandyOrgResource/master/HandyControl/Doc/extend_controls/DatePicker_2.png) +![DatePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/DatePicker_2.png) 也可以在XAML钟或代码中这样设置日期。 @@ -57,7 +57,7 @@ datePicker.SelectedDate = DateTime.Now; # 属性 -| 属性 | | +| 属性 | 描述 | | ---------------- | ------------------ | | SelectedDate | 获取或设置当前选中的日期 | | VerifyFunc | 获取或设置数据验证委托 | @@ -68,7 +68,7 @@ datePicker.SelectedDate = DateTime.Now; # 方法 -| 方法 | | +| 方法 | 描述 | | ---------------- | ------------------ | | VerifyData() | 验证数据 | diff --git a/doc/source/handycontrol/extend_controls/dateTimePicker/index.md b/doc/source/handycontrol/extend_controls/dateTimePicker/index.md index ca12ad62..f7e35f45 100644 --- a/doc/source/handycontrol/extend_controls/dateTimePicker/index.md +++ b/doc/source/handycontrol/extend_controls/dateTimePicker/index.md @@ -1,5 +1,82 @@ --- -title: 建设中 +title: DateTimePicker --- -建设中 \ No newline at end of file + +DatePicker 控件允许用户通过在文本框中键入日期和时间，或使用下拉的日历控件来选择日期和时间。 + +``` CS +[TemplatePart(Name = ElementRoot, Type = typeof(Grid))] +[TemplatePart(Name = ElementTextBox, Type = typeof(WatermarkTextBox))] +[TemplatePart(Name = ElementButton, Type = typeof(Button))] +[TemplatePart(Name = ElementPopup, Type = typeof(Popup))] +public class DateTimePicker : Control, IDataInput +``` + +# 创建DateTimePicker + +``` XML + +``` + +``` CS +var dateTimePicker = new DateTimePicker(); +``` + +生成的DateTimePicker如下图所示： + +![DateTimePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/DateTimePicker_1.png) + + + +# 选择日期和时间 + +可以通过文本框输入日期和时间，或者点击文本框右边的按钮打开下拉的日历和时钟控件选择日期和时间。 + +![DateTimePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/DateTimePicker_2.png) + +也可以在XAML钟或代码中这样设置日期。 + +``` XML + +``` + +``` CS +dateTimePicker.SelectedDateTime = DateTime.Now; +``` + +# 设置标题和占位符文本 + +你可以将 Header（标题）和 Placeholder（占位符）添加到DatePicker，以向用户指示其用途。要使用这两个属性，首先需要应用 **DateTimePickerExtend** 或 **DateTimePickerPlus** 样式。 + +``` XML + +``` + + + + +# 属性 + +| 属性 | 描述 | +| ---------------- | ------------------ | +| SelectedDateTime | 获取或设置当前选中的日期和时间 | +| DateTimeFormat | 获取或设置用于显示选定日期和时间的格式 | +| CalendarStyle | 获取或设置在呈现日历时使用的样式 | +| DisplayDateTime | 获取或设置要显示的日期 | +| IsDropDownOpen | 获取或设置一个值，该值指示是打开还是关闭下拉 Calendar | +| Text | 获取由 **DateTimePicker** 显示的文本，或设置选定日期和时间 | +| VerifyFunc | 获取或设置数据验证委托 | +| IsError | 获取或设置数据是否错误 | +| ErrorStr | 获取或设置错误提示 | +| TextType | 获取或设置文本类型 | +| ShowClearButton | 获取或设置是否显示清除按钮 | + +# 方法 + +| 方法 | 描述 | +| ---------------- | ------------------ | +| VerifyData() | 验证数据 | \ No newline at end of file diff --git a/doc/source/handycontrol/extend_controls/timePicker/index.md b/doc/source/handycontrol/extend_controls/timePicker/index.md index ca12ad62..9012c589 100644 --- a/doc/source/handycontrol/extend_controls/timePicker/index.md +++ b/doc/source/handycontrol/extend_controls/timePicker/index.md @@ -1,5 +1,95 @@ --- -title: 建设中 +title: TimePicker --- -建设中 \ No newline at end of file +TimePicker 控件允许用户通过在文本框中键入时间或使用下拉的日历控件来选择时间。 + +``` CS +[TemplatePart(Name = ElementRoot, Type = typeof(Grid))] +[TemplatePart(Name = ElementTextBox, Type = typeof(WatermarkTextBox))] +[TemplatePart(Name = ElementButton, Type = typeof(Button))] +[TemplatePart(Name = ElementPopup, Type = typeof(Popup))] +public class TimePicker : Control, IDataInput +``` + +# 创建DatePicker + +``` XML + +``` + +``` CS +var timePicker = new TimePicker(); +``` + +生成的TimePicker如下图所示： + +![TimePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/TimePicker_1.png) + + + +# 选择时间 + +可以通过文本框输入时间，或者点击文本框右边的按钮打开下拉的时钟控件选择时间。 + +![DatePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/TimePicker_2.png) + +也可以在XAML钟或代码中这样设置日期。 + +``` XML + +``` + +``` CS +timePicker.SelectedTime = DateTime.Now; +``` + +# 更改时钟样式 + +通过更改Clock属性，TimePicker可以更改时钟的样式。 + +``` XML + + + + + +``` + +![DatePicker](https://raw.githubusercontent.com/HandyOrg/HandyOrgResource/master/HandyControl/Doc/extend_controls/TimePicker_3.png) + +# 设置标题和占位符文本 + +你可以将 Header（标题）和 Placeholder（占位符）添加到DatePicker，以向用户指示其用途。要使用这两个属性，首先需要应用 **TimePickerExtend** 或 **TimePickerPlus** 样式。 + +``` XML + +``` + + + + +# 属性 + +| 属性 | 描述 | +| ---------------- | ------------------ | +| SelectedTime | 获取或设置当前选中的时间 | +| Clock | 获取或设置下拉时钟 | +| TimeFormat | 获取或设置用于显示选定的时间的格式 | +| DisplayTime | 获取或设置要显示的时间 | +| IsDropDownOpen | 获取或设置一个值，该值指示是打开还是关闭下拉时钟 | +| Text | 获取由 **TimePicker** 显示的文本，或设置选定的时间 | +| VerifyFunc | 获取或设置数据验证委托 | +| IsError | 获取或设置数据是否错误 | +| ErrorStr | 获取或设置错误提示 | +| TextType | 获取或设置文本类型 | +| ShowClearButton | 获取或设置是否显示清除按钮 | + +# 方法 + +| 方法 | 描述 | +| ---------------- | ------------------ | +| VerifyData() | 验证数据 | +