如何在WPF（C#）中动态修改DatePicker的字符串格式？

问题描述 #

现有如下WPF DatePicker的XAML代码：

<DatePicker
    Name="DataSelected"
    Grid.Column="1" Grid.Row="2"
    SelectedDate="{Binding DataSelected, Mode=TwoWay}"
    CalendarOpened="DatePicker_Opened">
    <DatePicker.Resources>
        <Style TargetType="DatePickerTextBox">
            <Setter Property="Control.Template">
                <Setter.Value>
                    <ControlTemplate>
                        <TextBox x:Name="PART_TextBox"
                             Text="{Binding Path=SelectedDate, 
                                    RelativeSource={RelativeSource AncestorType={x:Type DatePicker}}, 
                                    StringFormat={x:Static local:MyView.DateFormat}}" />
                    </ControlTemplate>
                </Setter.Value>
            </Setter>
        </Style>
    </DatePicker.Resources>
</DatePicker>

存在DateFormat变量，值可为"yyyy"、"MM-yyyy"或"dd-MM-yyyy"，需要根据该变量动态调整DatePicker的行为：

• 当DateFormat为"yyyy"时，仅允许选择年份，文本仅显示年份
• 当DateFormat为"MM-yyyy"时，仅允许选择年月，文本显示年月
• 当DateFormat为"dd-MM-yyyy"时，允许选择完整日期，文本显示完整日期

实现方案 #

1. 让DateFormat支持UI自动更新 #

普通静态变量修改后无法触发UI刷新，需将DateFormat改为依赖属性，确保值变化时自动通知UI并触发行为更新：

public static readonly DependencyProperty DateFormatProperty =
    DependencyProperty.Register("DateFormat", typeof(string), typeof(MyView), 
        new PropertyMetadata("dd-MM-yyyy", OnDateFormatChanged));

public string DateFormat
{
    get => (string)GetValue(DateFormatProperty);
    set => SetValue(DateFormatProperty, value);
}

private static void OnDateFormatChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    var view = (MyView)d;
    view.UpdateDatePickerBehavior();
}

2. 动态修改日历选择模式 #

在DatePicker_Opened事件中，找到弹出的Calendar控件，根据DateFormat切换显示模式，并限制选择范围：

private void DatePicker_Opened(object sender, RoutedEventArgs e)
{
    var datePicker = (DatePicker)sender;
    var calendar = FindVisualChild<Calendar>(datePicker);
    if (calendar == null) return;

    // 先移除之前绑定的事件，避免重复触发
    calendar.DisplayModeChanged -= Calendar_DisplayModeChanged;
    calendar.SelectedDatesChanged -= Calendar_SelectedDatesChanged;

    switch (DateFormat)
    {
        case "yyyy":
            calendar.DisplayMode = CalendarMode.Year;
            // 选择年份后自动关闭日历
            calendar.DisplayModeChanged += Calendar_DisplayModeChanged;
            break;
        case "MM-yyyy":
            calendar.DisplayMode = CalendarMode.Year;
            // 停留在月份选择模式，禁止进入日期选择
            calendar.DisplayModeChanged += Calendar_DisplayModeChanged;
            // 选择月份后自动关闭日历
            calendar.SelectedDatesChanged += Calendar_SelectedDatesChanged;
            break;
        case "dd-MM-yyyy":
            // 恢复默认的完整日期选择模式
            calendar.DisplayMode = CalendarMode.Month;
            break;
    }
}

private void Calendar_DisplayModeChanged(object sender, CalendarModeChangedEventArgs e)
{
    var calendar = (Calendar)sender;
    var datePicker = FindVisualParent<DatePicker>(calendar);
    if (datePicker == null) return;

    if (DateFormat == "yyyy" && calendar.DisplayMode == CalendarMode.Month)
    {
        calendar.SelectedDate = calendar.DisplayDate;
        datePicker.IsDropDownOpen = false;
    }
    else if (DateFormat == "MM-yyyy")
    {
        if (calendar.DisplayMode == CalendarMode.Decade)
            calendar.DisplayMode = CalendarMode.Year;
        else if (calendar.DisplayMode == CalendarMode.Day)
            calendar.DisplayMode = CalendarMode.Month;
    }
}

private void Calendar_SelectedDatesChanged(object sender, SelectionChangedEventArgs e)
{
    var calendar = (Calendar)sender;
    var datePicker = FindVisualParent<DatePicker>(calendar);
    if (datePicker != null && calendar.SelectedDate.HasValue)
    {
        datePicker.IsDropDownOpen = false;
    }
}

// 辅助方法：查找VisualTree中的子控件
private T FindVisualChild<T>(DependencyObject parent) where T : DependencyObject
{
    for (int i = 0; i < VisualTreeHelper.GetChildrenCount(parent); i++)
    {
        var child = VisualTreeHelper.GetChild(parent, i);
        if (child is T tChild)
            return tChild;
        var result = FindVisualChild<T>(child);
        if (result != null)
            return result;
    }
    return null;
}

// 辅助方法：查找VisualTree中的父控件
private T FindVisualParent<T>(DependencyObject child) where T : DependencyObject
{
    var parent = VisualTreeHelper.GetParent(child);
    if (parent is T tParent)
        return tParent;
    return parent != null ? FindVisualParent<T>(parent) : null;
}

3. 修正日期精度 #

当切换格式时，确保SelectedDate的精度符合当前格式要求：

private void UpdateDatePickerBehavior()
{
    if (!DataSelected.SelectedDate.HasValue) return;

    DateTime selectedDate = DataSelected.SelectedDate.Value;
    switch (DateFormat)
    {
        case "yyyy":
            DataSelected.SelectedDate = new DateTime(selectedDate.Year, 1, 1);
            break;
        case "MM-yyyy":
            DataSelected.SelectedDate = new DateTime(selectedDate.Year, selectedDate.Month, 1);
            break;
    }
}

内容的提问来源于stack exchange，提问作者Kristina Tamaro