WPF 構建無外觀（Lookless）控件

構建一個用戶可以使用Template屬性設置外觀的WPF控件需要以下幾步

1. 1、繼承自System.Windows.Controls.Control
   2、設置DefaultStyleKeyProperty
   3、實現控件功能
2. 4、定義默認Sytle
3. 5、添加ThemeInfo
   我借用一個時鍾的控件例子，講解以下每一個步驟

5. 第1步 繼承自System.Windows.Controls.Control

 

我們的自定義控件繼承自System.Windows.Controls.Control，如果有更特別的控件，也可以繼承自更復雜的控件。

類聲明

public class Clock : Control
{
}

 

第2步 設置DefaultStyleKeyProperty

 

無外觀的控件需要在靜態構造函數中設置DefaultStyleKeyProperty,這樣它會去在themes/generic.xaml的文件獲取默認的樣式。

static Clock()
{
    DefaultStyleKeyProperty.OverrideMetadata(typeof(Clock), new FrameworkPropertyMetadata(typeof(Clock)));
}

第3步 實現控件功能

這一步沒什么特別的，就是內部有個DateTime類型和一個DispatcherTimer，完成一個時鍾的功能

public class Clock : Control
{
    private DispatcherTimer timer;

    static Clock()
    {
        DefaultStyleKeyProperty.OverrideMetadata(typeof(Clock), new FrameworkPropertyMetadata(typeof(Clock)));
    }

    protected override void OnInitialized(EventArgs e)
    {
        base.OnInitialized(e);

        UpdateDateTime();

        timer = new DispatcherTimer();
        timer.Interval = TimeSpan.FromMilliseconds(1000 - DateTime.Now.Millisecond);
        timer.Tick += new EventHandler(Timer_Tick);
        timer.Start();
    }

    private void Timer_Tick(object sender, EventArgs e)
    {
        UpdateDateTime();

        timer.Interval = TimeSpan.FromMilliseconds(1000 - DateTime.Now.Millisecond);
        timer.Start();
    }

    private void UpdateDateTime()
    {
        this.DateTime = System.DateTime.Now;
    }

    public DateTime DateTime
    {
        get
        {
            return (DateTime)GetValue(DateTimeProperty);
        }
        private set
        {
            SetValue(DateTimeProperty, value);
        }
    }

    public static DependencyProperty DateTimeProperty = DependencyProperty.Register(
            "DateTime",
            typeof(DateTime),
            typeof(Clock),
            new PropertyMetadata(DateTime.Now, new PropertyChangedCallback(OnDateTimeInvalidated)));

    public static readonly RoutedEvent DateTimeChangedEvent =
        EventManager.RegisterRoutedEvent("DateTimeChanged", RoutingStrategy.Bubble, typeof(RoutedPropertyChangedEventHandler<DateTime>), typeof(Clock));

    protected virtual void OnDateTimeChanged(DateTime oldValue, DateTime newValue)
    {
        RoutedPropertyChangedEventArgs<DateTime> args = new RoutedPropertyChangedEventArgs<DateTime>(oldValue, newValue);
        args.RoutedEvent = Clock.DateTimeChangedEvent;
        RaiseEvent(args);
    }

    private static void OnDateTimeInvalidated(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        Clock clock = (Clock)d;

        DateTime oldValue = (DateTime)e.OldValue;
        DateTime newValue = (DateTime)e.NewValue;

        clock.OnDateTimeChanged(oldValue, newValue);
    }
}

 

第4步 定義默認Sytle

 

如上所述，我們還需要一個默認的Template，它寫在themes/generic.xaml文件中，這個文件可能需要自己創建

<ResourceDictionary
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="clr-namespace:CustomControlLibrary"
    >

    <Style TargetType="{x:Type local:Clock}">
        <Setter Property="Template">
            <Setter.Value>
                <ControlTemplate TargetType="{x:Type local:Clock}">
                    <TextBlock Text="{Binding Path=DateTime, RelativeSource={RelativeSource TemplatedParent}}" />
                </ControlTemplate>
            </Setter.Value>
        </Setter>
    </Style>
</ResourceDictionary>

這里要注意TargetType的使用。到這里控件還是不能找到默認的模板，還需要下面的最后一步

 

1. 第5步 添加ThemeInfo

 

最后還需要在AssemblyInfo.cs文件中加入ThemeInfo信息，在文件中加入以下特性

[assembly: ThemeInfo(
    ResourceDictionaryLocation.None,
    ResourceDictionaryLocation.SourceAssembly
)]

 

1. 附注

 

如果需要在模板中使用特定的元素名，來或許模板中的某個特定控件，還有幾個地方需要注意。

1、模板內的Name最好以PART開頭，好的名稱類似於PART_TextBox

2、獲取Template中控件的代碼，需要重載OnApplyTemplate（）方法，可以使用GetTemplateChild方法獲取，如下

public override void OnApplyTemplate()
{
    base.OnApplyTemplate();

    //從模板中獲取名稱為PART_PresentationTextBox的TextBox
    _presentationTextBox = GetTemplateChild("PART_PresentationTextBox") as TextBox;
    if(_presentationTextBox != null)
    {
        //對_presentationTextBox進行操作
    }
}

3、在控件類添加TemplatePart

[TemplatePart(Name = "PART_PresentationTextBox", Type = typeof(TextBox))]
public class TimeSpanPicker:Control

這個內容可以參考https://gitcafe.com/atskyline/WPFTimeSpanPickerControl

1. 參考資料

 

http://www.codeproject.com/Articles/14340/Creating-a-look-less-custom-control-in-WPF

http://www.codeproject.com/Articles/35444/Defining-the-Default-Style-for-a-Lookless-Control