[WPF 지정 컨트롤 라이브러리] TextBlockHighlightSource 기능을 강조 강화 사용 단순화 호 TypeConverter를 사용

1. 강조 기능을 강화

이 기사는 TextBlock을 강조 달성하기 위해 추가 속성의 사용을 설명뿐만 아니라, 질문을 왼쪽 : 하이라이트 (또는 낮은 조명) 색상을 정의 할 수 없습니다. 이 문제를 해결하기 위해, 내가 만든 TextBlockHighlightSource이 클래스, 간단한 문자열 저장보다 더 많은 정보를,이 클래스의 정의는 다음과 같다 :

상응하게, 또한 클래스와이 이벤트에 속성 값 변경에 대한 추가 속성의 유형 변경 :

private static void OnHighlightTextChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
{
    var oldValue = (TextBlockHighlightSource)args.OldValue;
    var newValue = (TextBlockHighlightSource)args.NewValue;
    if (oldValue == newValue)
        return;

    void OnPropertyChanged(object sender,EventArgs e)
    {
        if (obj is TextBlock target)
        {
            MarkHighlight(target, newValue);
        }
    };

    if(oldValue!=null)
        newValue.PropertyChanged -= OnPropertyChanged;

    if (newValue != null)
        newValue.PropertyChanged += OnPropertyChanged;

    OnPropertyChanged(null, null);
}

MarkHighlight핵심 코드는 다음에 수정 :

if (highlightSource.LowlightForeground != null)
    run.Foreground = highlightSource.LowlightForeground;

if (highlightSource.HighlightForeground != null)
    run.Foreground = highlightSource.HighlightForeground;

if (highlightSource.HighlightBackground != null)
    run.Background = highlightSource.HighlightBackground;

사용이 있습니다 :

<TextBlock Text="Git hub"
           TextWrapping="Wrap">
    <kino:TextBlockService.HighlightText>
        <kino:TextBlockHighlightSource Text="hub"
                                       LowlightForeground="Black"
                                       HighlightBackground="#FFF37D33" />
    </kino:TextBlockService.HighlightText>
</TextBlock>

2. TypeConverter를 호출을 단순화

TextBlockHighlightSource이 기능을 많이 제공하지만, 문자열 및 사용은 직접 만들려면 비해 TextBlockHighlightSource훨씬 더 복잡합니다. 를 단순화하기 위해 사용자를 호출하는 데 사용할 수 있습니다 TypeConverter.

먼저, 살펴 보자 TypeConverter개념. XAML은 속성 값은 모든 문자열 인 XML 자연입니다. 해당 속성의 유형 인 경우 XAML 내장 타입 (즉 Boolea, 숯불, 문자열, 진수, 싱글, 더블, INT16, INT32, INT64, 시간 범위, 열린 우리당, 바이트, 배열 유형 등), XAML 파서는 직접 대응에 문자열을 변환 속성 값에 할당, 다른 유형, XAML 파서는 더 많은 작업을 할 필요가있다.

<Grid.RowDefinitions>
    <RowDefinition Height="Auto"/>
    <RowDefinition Height="*"/>
</Grid.RowDefinitions>

코드에 대응하는 상기 단락 XAML 다시 신장 할당 "오토"및 "*"는 각각 GridLength.Auto 새로운 GridLength (1 GridUnitType.Star)를 파싱하는 파서 XAML에서와 같이 :

grid.RowDefinitions.Add(new RowDefinition { Height = GridLength.Auto });
grid.RowDefinitions.Add(new RowDefinition { Height = new GridLength(1, GridUnitType.Star) });

为了完成这个工作，XAML解析器需要TypeConverter的协助。XAML解析器通过两个步骤查找TypeConverter：
1. 检查属性声明上的TypeConverterAttribute。
2. 如果属性声明中没有TypeConverterAttribute，检查类型声明中的TypeConverterAttribute。

属性声明上TypeConverterAttribute的优先级高于类型声明。如果以上两步都找不到类型对应的TypeConverterAttribute，XAML解析器将会报错：属性"*"的值无效。找到TypeConverterAttribute指定的TypeConverter后，XAML解析器调用它的object ConvertFromString(string text)函数将字符串转换成属性的值。

WPF内置的TypeConverter十分十分多，但有时还是需要自定义TypeConverter，自定义TypeConverter的基本步骤如下：

创建一个继承自TypeConverter的类；
重写virtual bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType);
重写virtual bool CanConvertTo(ITypeDescriptorContext context, Type destinationType);
重写virtual object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value);
重写virtual object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType);
使用TypeConverterAttribute 指示XAML解析器可用的TypeConverter；

到这里我想TypeConverter的概念已经介绍得够详细了。回到本来话题，要简化TextBlockHighlightSource的调用我创建了TextBlockHighlightSourceConverter这个类，它继承自TypeConverter，里面的关键代码如下：

public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
{
    if (sourceType == typeof(string))
    {
        return true;
    }

    return base.CanConvertFrom(context, sourceType);
}

public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
{
    switch (value)
    {
        case null:
            throw GetConvertFromException(null);
        case string source:
            return new TextBlockHighlightSource { Text = value.ToString() };
    }

    return base.ConvertFrom(context, culture, value);
}

然后在TextBlockHighlightSource上使用TypeConverterAttribute:

[TypeConverter(typeof(TextBlockHighlightSourceConverter))]
public class TextBlockHighlightSource : FrameworkElement

这样在XAML中TextBlockHighlightSource的调用方式就可以和使用字符串一样简单了。

<TextBlock Text="Github"
           kino:TextBlockService.HighlightText="hub" />

3. 使用Style

有没有发现TextBlockHighlightSource继承自FrameworkElement？这种奇特的写法是为了让TextBlockHighlightSource可以使用全局的Style。毕竟要在应用程序里统一Highlight的颜色还是全局样式最好使，但作为附加属性，TextBlockHighlightSource并不是VisualTree的一部分，它拿不到VisualTree上的Resources。最简单的解决方案是让TextBlockHighlightSource继承自FrameworkElement，把它放到VisualTree里，用法如下：

<StackPanel>
    <FrameworkElement.Resources>
        <Style TargetType="kino:TextBlockHighlightSource">
            <Setter Property="LowlightForeground" Value="Blue"/>
        </Style>
    </FrameworkElement.Resources>
    <TextBox x:Name="FilterElement3"/>
    <kino:TextBlockHighlightSource Text="{Binding ElementName=FilterElement3,Path=Text}" 
                                   HighlightForeground="DarkBlue"
                                   HighlightBackground="Yellow"
                                   x:Name="TextBlockHighlightSource2"/>
    <TextBlock Text="A very powerful projector with special features for Internet usability, USB" 
               kino:TextBlockService.HighlightText="{Binding ElementName=TextBlockHighlightSource2}"
               TextWrapping="Wrap"/>
</StackPanel>

也许你会觉得这种写法有些奇怪，毕竟我也觉得在View上放一个隐藏的元素真的很怪。其实在一万二千年前微软就已经有这种写法，在DomainDataSource的文档里就有用到:

<Grid x:Name="LayoutRoot" Background="White">  
    <Grid.RowDefinitions>
        <RowDefinition Height="25" />
        <RowDefinition Height="Auto" />
    </Grid.RowDefinitions>
    <riaControls:DomainDataSource x:Name="source" QueryName="GetProducts" AutoLoad="true">
        <riaControls:DomainDataSource.DomainContext>
            <domain:ProductDomainContext />
        </riaControls:DomainDataSource.DomainContext>   
        <riaControls:DomainDataSource.FilterDescriptors>
            <riaData:FilterDescriptorCollection LogicalOperator="And">
              <riaData:FilterDescriptor PropertyPath="Color" Operator="IsEqualTo" Value="Blue" />
              <riaData:FilterDescriptor PropertyPath="ListPrice" Operator="IsLessThanOrEqualTo">
                  <riaControls:ControlParameter 
                      ControlName="MaxPrice" 
                      PropertyName="SelectedItem.Content" 
                      RefreshEventName="SelectionChanged" />
              </riaData:FilterDescriptor>
            </riaData:FilterDescriptorCollection>
        </riaControls:DomainDataSource.FilterDescriptors>
    </riaControls:DomainDataSource>
    <ComboBox x:Name="MaxPrice" Grid.Row="0" Width="60" SelectedIndex="0">
        <ComboBoxItem Content="100" />
        <ComboBoxItem Content="500" />
        <ComboBoxItem Content="1000" />
    </ComboBox>
    <data:DataGrid Grid.Row="1" ItemsSource="{Binding Data, ElementName=source}" />
</Grid>

把DataSource放到View上这种做法可能是WinForm的祖传家训，结构可耻但有用。

4. 结语

写这篇博客的时候我才发觉这个附加属性还叫HighlightText好像不太好，但也懒得改了。

这篇文章介绍了使用TypeConverter简化调用，以及继承自FrameworkElement以便使用Style。

5. 参考

TypeConverter 类
 TypeConverters 和 XAML
Type Converters for XAML Overview
TypeConverterAttribute Class
如何：实现类型转换器

6. 源码

TextBlock at master · DinoChan_Kino.Toolkit.Wpf