如何在Xamarin.Forms Picker中结合Description使用枚举

1. 定义带Description特性的枚举 #

先举个示例枚举，你可以替换成自己的：

using System.ComponentModel;

public enum PaymentMethod
{
    [Description("支付宝")]
    Alipay,
    [Description("微信支付")]
    WeChatPay,
    [Description("银行卡")]
    BankCard
}

2. 编写枚举与Description的转换工具类 #

这个静态类负责核心的转换逻辑：

using System;
using System.ComponentModel;
using System.Linq;

public static class EnumHelper
{
    // 获取枚举值对应的Description
    public static string GetDescription(Enum enumValue)
    {
        var fieldInfo = enumValue.GetType().GetField(enumValue.ToString());
        var attributes = (DescriptionAttribute[])fieldInfo.GetCustomAttributes(typeof(DescriptionAttribute), false);
        return attributes.Length > 0 ? attributes[0].Description : enumValue.ToString();
    }

    // 根据Description反向获取枚举值
    public static Enum GetEnumFromDescription(string description, Type enumType)
    {
        foreach (var field in enumType.GetFields())
        {
            if (Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute)) is DescriptionAttribute attribute)
            {
                if (attribute.Description == description)
                    return (Enum)field.GetValue(null);
            }
            else
            {
                // 没有Description时，用枚举名称兜底
                if (field.Name == description)
                    return (Enum)field.GetValue(null);
            }
        }
        throw new ArgumentException($"找不到描述为「{description}」的{enumType.Name}枚举值", nameof(description));
    }
}

3. 实现双向绑定转换器 #

这个转换器用于Picker的SelectedItem绑定，完成枚举与Description的双向转换：

using System;
using Xamarin.Forms;

public class EnumDescriptionConverter : IValueConverter
{
    // 枚举 → Description（Picker显示用）
    public object Convert(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
    {
        return value is Enum enumValue ? EnumHelper.GetDescription(enumValue) : string.Empty;
    }

    // Description → 枚举（选中后反向绑定用）
    public object ConvertBack(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
    {
        if (value is string description && !string.IsNullOrEmpty(description))
        {
            return EnumHelper.GetEnumFromDescription(description, targetType);
        }
        // 空值时返回枚举默认值
        return Activator.CreateInstance(targetType);
    }
}

4. ViewModel中准备Picker的数据源 #

在ViewModel里生成枚举对应的Description列表，并定义选中项的绑定属性：

using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Runtime.CompilerServices;

public class MainViewModel : INotifyPropertyChanged
{
    private PaymentMethod _selectedPaymentMethod;

    // Picker的选项列表（所有枚举的Description）
    public List<string> PaymentMethodDescriptions { get; }

    // 选中的枚举值（双向绑定）
    public PaymentMethod SelectedPaymentMethod
    {
        get => _selectedPaymentMethod;
        set
        {
            _selectedPaymentMethod = value;
            OnPropertyChanged();
        }
    }

    public MainViewModel()
    {
        // 生成Description列表
        PaymentMethodDescriptions = Enum.GetValues(typeof(PaymentMethod))
                                        .Cast<PaymentMethod>()
                                        .Select(EnumHelper.GetDescription)
                                        .ToList();
    }

    // INotifyPropertyChanged实现，用于属性通知
    public event PropertyChangedEventHandler PropertyChanged;
    protected void OnPropertyChanged([CallerMemberName] string propertyName = null)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
}

5. XAML中配置Picker #

在页面的资源中声明转换器，然后绑定Picker的ItemsSource和SelectedItem：

<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:local="clr-namespace:你的命名空间"
             x:Class="你的命名空间.MainPage">

    <ContentPage.Resources>
        <!-- 声明转换器 -->
        <local:EnumDescriptionConverter x:Key="EnumDescriptionConverter" />
    </ContentPage.Resources>

    <StackLayout>
        <!-- Picker绑定配置 -->
        <Picker ItemsSource="{Binding PaymentMethodDescriptions}"
                SelectedItem="{Binding SelectedPaymentMethod, Converter={StaticResource EnumDescriptionConverter}}"
                Title="请选择支付方式" />
    </StackLayout>
</ContentPage>

关键说明 #

• 如果枚举没有设置Description特性，工具类会自动返回枚举的名称作为 fallback；
• 转换异常可以根据需求调整，比如把throw改成返回枚举的默认值；
• 确保ViewModel已设置为页面的BindingContext。

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