如何在 C# 中为自定义 DataTemplateSelector 获取 DataTemplate 的 {x:DataType}
How to get {x:DataType} for a DataTemplate in C# for custom DataTemplateSelector
我正在为 ComboBox
控件编写一个自定义 DataTemplateSelector
,我需要用它来为不同类型的对象显示不同的 DateTemplates
,在关闭的并为 ComboBox
.
打开模式
这是我想出的DataTemplateSelector
:
public class ComboBoxTypedDataTemplateSelector : DataTemplateSelector
{
public IEnumerable<DataTemplate> SelectedTemplates { get; set; }
public IEnumerable<DataTemplate> DropDownTemplates { get; set; }
protected override DataTemplate SelectTemplateCore(object item, DependencyObject container)
{
IEnumerable<DataTemplate> source = container.FindParent<ComboBoxItem>() == null
? SelectedTemplates // Get the template for the closed mode
: DropDownTemplates; // Get the template for the open UI mode
Type type = item.GetType();
return null; // Some LINQ to get the first DataTemplate in source with the {x:DataType} that equals type
}
}
public sealed class DataTemplatesCollection : List<DataTemplate> { }
下面是我在 XAML 中的使用方式:
<ComboBox>
<mvvm:ComboBoxTypedDataTemplateSelector>
<mvvm:ComboBoxTypedDataTemplateSelector.SelectedTemplates>
<mvvm:DataTemplatesCollection>
<DataTemplate x:DataType="models:SomeType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
<DataTemplate x:DataType="models:SomeOtherType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
</mvvm:DataTemplatesCollection>
</mvvm:ComboBoxTypedDataTemplateSelector.SelectedTemplates>
<mvvm:ComboBoxTypedDataTemplateSelector.DropDownTemplates>
<mvvm:DataTemplatesCollection>
<DataTemplate x:DataType="models:SomeType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
<DataTemplate x:DataType="models:SomeOtherType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
</mvvm:DataTemplatesCollection>
</mvvm:ComboBoxTypedDataTemplateSelector.DropDownTemplates>
</mvvm:ComboBoxTypedDataTemplateSelector>
</ComboBox>
现在,我唯一缺少的拼图是,我不知道如何在 C# 中获取 {x:DataType} 属性(我知道它实际上不是真正的 属性,但我希望有一种方法可以通过代码检索它)。
我需要类似的东西才能从正确的模板组中为每个对象获得正确的 DataTemplate
。
有什么办法可以实现吗?
注意:我知道我可以写一个特定的DataTemplateSelector
,其中每个项目类型的模板的硬编码名称为return,并且我可以将该方法用作后备选项。但是,我想知道是否有可能用这种方法编写一个更通用的选择器,以使其更加模块化并能够在将来重用它。
感谢您的帮助!
编辑:根据文森特的建议,我写了一个附加的 属性 来将给定的 Type
存储在 DataTemplate
中:
public class DataTypeHelper
{
public static Type GetAttachedDataType(DataTemplate element)
{
return (Type)element.GetValue(AttachedDataTypeProperty);
}
public static void SetAttachedDataType(DataTemplate element, Type value)
{
element.SetValue(AttachedDataTypeProperty, value);
}
public static readonly DependencyProperty AttachedDataTypeProperty =
DependencyProperty.RegisterAttached("AttachedDataType", typeof(Type), typeof(DataTypeHelper), new PropertyMetadata(default(Type)));
}
我试过这样使用它:
...
<DataTemplate x:DataType="someXlmns:SomeClass"
mvvm:DataTypeHelper.AttachedDataType="someXlmns:SomeClass">
...
</DataTemplate>
但是我在将附加 属性 设置为我的类型的那一行得到了 XamlParseException
。我尝试将 属性 设置为 "Grid"(作为测试)但它没有崩溃,我不明白为什么它不能与我的自定义类型一起使用。
编辑 #2:看起来 x:Type 标记扩展在 UWP 中不可用,我找不到其他方法(我认为这不可能at all) 直接从 XAML 获取 Type 实例,所以我必须只使用 XAML 中的类型名称,然后将其与模板选择器中的 item.GetType().Name
进行比较。
直接从 XAML 分配类型 属性 的能力会更好,因为它在 XAML 设计器中也有 syntax/spell-check,但是至少这种方法工作得很好。
您无法检索此值。这只是编译器允许其为绑定生成适当代码的提示。
您可以创建自定义附件 属性 来存储您需要的内容,或者使用名称 属性。
<local:Selector x:Key="selector" >
<local:Selector.Template1>
<DataTemplate x:DataType="local:Item" x:Name="template1" >
<.../>
</DataTemplate>
</local:Selector.Template1>
</local:Selector>
然后在选择器实现中
Template1.GetValue(FrameworkElement.NameProperty);
这是我发现的一个示例,它根据数据类型使用不同的 DataTemplate。代码:
public class MyDataTemplateSelector : DataTemplateSelector
{
public Dictionary<Type, DataTemplate> TemplateDictionary { get; set; }
protected override DataTemplate SelectTemplateCore(object item)
{
// select datatemplate depending on item type
Type itemType = item.GetType();
if (!TemplateDictionary.Keys.Contains(itemType))
{
return null;
}
return TemplateDictionary[itemType];
}
protected override DataTemplate SelectTemplateCore(object item, DependencyObject container)
{
// select datatemplate depending on item type
Type itemType = item.GetType();
if (!TemplateDictionary.Keys.Contains(itemType))
{
return null;
}
return TemplateDictionary[itemType];
}
}
这是link https://code.msdn.microsoft.com/How-to-bind-data-to-04dcf26d。可以下载源码。
这是我的 2 美分:
[ContentProperty(Name = nameof(Templates))]
public class TypedDataTemplateSelector : DataTemplateSelector
{
public IList<TypedDataTemplate> Templates { get; }
= new ObservableCollection<TypedDataTemplate>();
public TypedDataTemplateSelector()
{
var incc = (INotifyCollectionChanged)Templates;
incc.CollectionChanged += (sender, e) =>
{
if (e?.NewItems.Cast<TypedDataTemplate>()
.Any(tdt => tdt?.DataType == null || tdt?.Template == null) == true)
throw new InvalidOperationException("All items must have all properties set.");
};
}
protected override DataTemplate SelectTemplateCore(object item,
DependencyObject container)
{
if (item == null) return null;
if (!Templates.Any()) throw new InvalidOperationException("No DataTemplates found.");
var result =
Templates.FirstOrDefault(t => t.DataType.IsAssignableFrom(item.GetType()));
if (result == null)
throw new ArgumentOutOfRangeException(
$"Could not find a matching template for type '{item.GetType()}'.");
return result.Template;
}
}
[ContentProperty(Name = nameof(Template))]
public class TypedDataTemplate
{
public Type DataType { get; set; }
public DataTemplate Template { get; set; }
}
用法:
<ContentControl Content="{Binding}">
<ContentControl.ContentTemplateSelector>
<v:TypedDataTemplateSelector>
<v:TypedDataTemplate DataType="data:Person">
<DataTemplate>
<StackPanel>
<TextBox Header="First name" Text="{Binding FirstName}" />
<TextBox Header="Last name" Text="{Binding LastName}" />
</StackPanel>
</DataTemplate>
</v:TypedDataTemplate>
<v:TypedDataTemplate DataType="data:Company">
<DataTemplate>
<StackPanel>
<TextBox Header="Company name" Text="{Binding CompanyName}" />
</StackPanel>
</DataTemplate>
</v:TypedDataTemplate>
</v:TypedDataTemplateSelector>
</ContentControl.ContentTemplateSelector>
</ContentControl>
您实际上可以做的是创建 AttachedProperty 并在 DataTemplate 上使用它,幸运的是,在 UWP DataTemplate 中继承自 DependecyObject 向上树,因此我们可以在其上使用 AP。示例如下:
AP 定义
public class SomeAttachedProperty : DependencyObject
{
public static readonly DependencyProperty TypeProperty =
DependencyProperty.RegisterAttached(
"SomeAttachedProperty",
typeof(string),
typeof(SomeAttachedProperty),
new PropertyMetadata(null)
);
public static void SetType(DependencyObject element, string value)
{
element.SetValue(TypeProperty, value);
}
public static string GetType(DependencyObject element)
{
return (string)element.GetValue(TypeProperty);
}
}
XAML
<DataTemplate x:Key="SomeKey" local:SomeAttachedProperty.Type="SomeValue">
在代码中
DataTemplate dataTemplate = resourceDictionary["SomeKey"] as DataTemplate;
string myValue = dataTemplate.GetValue(SomeAttachedProperty.TypeProperty) as string;
我正在为 ComboBox
控件编写一个自定义 DataTemplateSelector
,我需要用它来为不同类型的对象显示不同的 DateTemplates
,在关闭的并为 ComboBox
.
这是我想出的DataTemplateSelector
:
public class ComboBoxTypedDataTemplateSelector : DataTemplateSelector
{
public IEnumerable<DataTemplate> SelectedTemplates { get; set; }
public IEnumerable<DataTemplate> DropDownTemplates { get; set; }
protected override DataTemplate SelectTemplateCore(object item, DependencyObject container)
{
IEnumerable<DataTemplate> source = container.FindParent<ComboBoxItem>() == null
? SelectedTemplates // Get the template for the closed mode
: DropDownTemplates; // Get the template for the open UI mode
Type type = item.GetType();
return null; // Some LINQ to get the first DataTemplate in source with the {x:DataType} that equals type
}
}
public sealed class DataTemplatesCollection : List<DataTemplate> { }
下面是我在 XAML 中的使用方式:
<ComboBox>
<mvvm:ComboBoxTypedDataTemplateSelector>
<mvvm:ComboBoxTypedDataTemplateSelector.SelectedTemplates>
<mvvm:DataTemplatesCollection>
<DataTemplate x:DataType="models:SomeType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
<DataTemplate x:DataType="models:SomeOtherType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
</mvvm:DataTemplatesCollection>
</mvvm:ComboBoxTypedDataTemplateSelector.SelectedTemplates>
<mvvm:ComboBoxTypedDataTemplateSelector.DropDownTemplates>
<mvvm:DataTemplatesCollection>
<DataTemplate x:DataType="models:SomeType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
<DataTemplate x:DataType="models:SomeOtherType">
<TextBlock Text="{x:Bind ...}"/>
</DataTemplate>
</mvvm:DataTemplatesCollection>
</mvvm:ComboBoxTypedDataTemplateSelector.DropDownTemplates>
</mvvm:ComboBoxTypedDataTemplateSelector>
</ComboBox>
现在,我唯一缺少的拼图是,我不知道如何在 C# 中获取 {x:DataType} 属性(我知道它实际上不是真正的 属性,但我希望有一种方法可以通过代码检索它)。
我需要类似的东西才能从正确的模板组中为每个对象获得正确的 DataTemplate
。
有什么办法可以实现吗?
注意:我知道我可以写一个特定的DataTemplateSelector
,其中每个项目类型的模板的硬编码名称为return,并且我可以将该方法用作后备选项。但是,我想知道是否有可能用这种方法编写一个更通用的选择器,以使其更加模块化并能够在将来重用它。
感谢您的帮助!
编辑:根据文森特的建议,我写了一个附加的 属性 来将给定的 Type
存储在 DataTemplate
中:
public class DataTypeHelper
{
public static Type GetAttachedDataType(DataTemplate element)
{
return (Type)element.GetValue(AttachedDataTypeProperty);
}
public static void SetAttachedDataType(DataTemplate element, Type value)
{
element.SetValue(AttachedDataTypeProperty, value);
}
public static readonly DependencyProperty AttachedDataTypeProperty =
DependencyProperty.RegisterAttached("AttachedDataType", typeof(Type), typeof(DataTypeHelper), new PropertyMetadata(default(Type)));
}
我试过这样使用它:
...
<DataTemplate x:DataType="someXlmns:SomeClass"
mvvm:DataTypeHelper.AttachedDataType="someXlmns:SomeClass">
...
</DataTemplate>
但是我在将附加 属性 设置为我的类型的那一行得到了 XamlParseException
。我尝试将 属性 设置为 "Grid"(作为测试)但它没有崩溃,我不明白为什么它不能与我的自定义类型一起使用。
编辑 #2:看起来 x:Type 标记扩展在 UWP 中不可用,我找不到其他方法(我认为这不可能at all) 直接从 XAML 获取 Type 实例,所以我必须只使用 XAML 中的类型名称,然后将其与模板选择器中的 item.GetType().Name
进行比较。
直接从 XAML 分配类型 属性 的能力会更好,因为它在 XAML 设计器中也有 syntax/spell-check,但是至少这种方法工作得很好。
您无法检索此值。这只是编译器允许其为绑定生成适当代码的提示。
您可以创建自定义附件 属性 来存储您需要的内容,或者使用名称 属性。
<local:Selector x:Key="selector" >
<local:Selector.Template1>
<DataTemplate x:DataType="local:Item" x:Name="template1" >
<.../>
</DataTemplate>
</local:Selector.Template1>
</local:Selector>
然后在选择器实现中
Template1.GetValue(FrameworkElement.NameProperty);
这是我发现的一个示例,它根据数据类型使用不同的 DataTemplate。代码:
public class MyDataTemplateSelector : DataTemplateSelector
{
public Dictionary<Type, DataTemplate> TemplateDictionary { get; set; }
protected override DataTemplate SelectTemplateCore(object item)
{
// select datatemplate depending on item type
Type itemType = item.GetType();
if (!TemplateDictionary.Keys.Contains(itemType))
{
return null;
}
return TemplateDictionary[itemType];
}
protected override DataTemplate SelectTemplateCore(object item, DependencyObject container)
{
// select datatemplate depending on item type
Type itemType = item.GetType();
if (!TemplateDictionary.Keys.Contains(itemType))
{
return null;
}
return TemplateDictionary[itemType];
}
}
这是link https://code.msdn.microsoft.com/How-to-bind-data-to-04dcf26d。可以下载源码。
这是我的 2 美分:
[ContentProperty(Name = nameof(Templates))]
public class TypedDataTemplateSelector : DataTemplateSelector
{
public IList<TypedDataTemplate> Templates { get; }
= new ObservableCollection<TypedDataTemplate>();
public TypedDataTemplateSelector()
{
var incc = (INotifyCollectionChanged)Templates;
incc.CollectionChanged += (sender, e) =>
{
if (e?.NewItems.Cast<TypedDataTemplate>()
.Any(tdt => tdt?.DataType == null || tdt?.Template == null) == true)
throw new InvalidOperationException("All items must have all properties set.");
};
}
protected override DataTemplate SelectTemplateCore(object item,
DependencyObject container)
{
if (item == null) return null;
if (!Templates.Any()) throw new InvalidOperationException("No DataTemplates found.");
var result =
Templates.FirstOrDefault(t => t.DataType.IsAssignableFrom(item.GetType()));
if (result == null)
throw new ArgumentOutOfRangeException(
$"Could not find a matching template for type '{item.GetType()}'.");
return result.Template;
}
}
[ContentProperty(Name = nameof(Template))]
public class TypedDataTemplate
{
public Type DataType { get; set; }
public DataTemplate Template { get; set; }
}
用法:
<ContentControl Content="{Binding}">
<ContentControl.ContentTemplateSelector>
<v:TypedDataTemplateSelector>
<v:TypedDataTemplate DataType="data:Person">
<DataTemplate>
<StackPanel>
<TextBox Header="First name" Text="{Binding FirstName}" />
<TextBox Header="Last name" Text="{Binding LastName}" />
</StackPanel>
</DataTemplate>
</v:TypedDataTemplate>
<v:TypedDataTemplate DataType="data:Company">
<DataTemplate>
<StackPanel>
<TextBox Header="Company name" Text="{Binding CompanyName}" />
</StackPanel>
</DataTemplate>
</v:TypedDataTemplate>
</v:TypedDataTemplateSelector>
</ContentControl.ContentTemplateSelector>
</ContentControl>
您实际上可以做的是创建 AttachedProperty 并在 DataTemplate 上使用它,幸运的是,在 UWP DataTemplate 中继承自 DependecyObject 向上树,因此我们可以在其上使用 AP。示例如下:
AP 定义
public class SomeAttachedProperty : DependencyObject
{
public static readonly DependencyProperty TypeProperty =
DependencyProperty.RegisterAttached(
"SomeAttachedProperty",
typeof(string),
typeof(SomeAttachedProperty),
new PropertyMetadata(null)
);
public static void SetType(DependencyObject element, string value)
{
element.SetValue(TypeProperty, value);
}
public static string GetType(DependencyObject element)
{
return (string)element.GetValue(TypeProperty);
}
}
XAML
<DataTemplate x:Key="SomeKey" local:SomeAttachedProperty.Type="SomeValue">
在代码中
DataTemplate dataTemplate = resourceDictionary["SomeKey"] as DataTemplate;
string myValue = dataTemplate.GetValue(SomeAttachedProperty.TypeProperty) as string;