2. 程式人生 > >[UWP]為附加屬性和依賴屬性自定義程式碼段（相容UWP和WPF）

[UWP]為附加屬性和依賴屬性自定義程式碼段（相容UWP和WPF）

阿新 • • 發佈：2018-11-06

1. 前言

之前介紹過依賴屬性和附加屬性的程式碼段，這兩個程式碼段我用了很多年，一直都幫了我很多。不過這兩個程式碼段我也多年沒修改過，Resharper老是提示我生成的程式碼可以修改，它這麼有誠意，這次就只好從了它，順便簡單介紹下怎麼自定義程式碼段。

2. VisualStudio自帶程式碼段的問題

以依賴屬性為例，一個完整的依賴屬性應該包含以下部分：

  1. 註冊依賴屬性並生成依賴屬性識別符號。依賴屬性識別符號為一個public static readonly DependencyProperty欄位。依賴屬性識別符號的名稱必須為“屬性名+Property”。在PropertyMetadata中指定屬性預設值。

  2. 實現屬性包裝器。為屬性提供 get 和 set 訪問器，在Getter和Setter中分別呼叫GetValue和SetValue。Getter和Setter中不應該有其它任何自定義程式碼。

  3. 如果需要監視屬性值變更，可以在PropertyMetadata中定義一個PropertyChangedCallback方法。因為這個方法是靜態的，可以再實現一個同名的例項方法（可以參考ContentControl的OnContentChanged方法）。

public int MyProperty
{
    get { return (int)GetValue(MyPropertyProperty); }
    set { SetValue(MyPropertyProperty, value); }
}

// Using a DependencyProperty as the backing store for MyProperty.  This enables animation, styling, binding, etc...
public static readonly DependencyProperty MyPropertyProperty =
    DependencyProperty.Register("MyProperty", typeof(int), typeof(ownerclass), new PropertyMetadata(0));

如上面程式碼所示，VisualStudio自帶的依賴屬性的程式碼段propdp只實現了最基本的功能，PropertyChangedCallback等函式還得自己實現，而這部分也挺麻煩的。另外，ownerclass基本都是當前類的名字，沒有理由不使用當前類的名字作為預設值。

/// <summary>
/// 獲取或設定MyProperty的值
/// </summary>  
public int MyProperty
{
    get => (int)GetValue(MyPropertyProperty);
    set => SetValue(MyPropertyProperty, value);
}

/// <summary>
/// 標識 MyProperty 依賴屬性。
/// </summary>
public static readonly DependencyProperty MyPropertyProperty =
    DependencyProperty.Register(nameof(MyProperty), typeof(int), typeof(MainPage), new PropertyMetadata(default(int), OnMyPropertyChanged));

private static void OnMyPropertyChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
{

    var oldValue = (int)args.OldValue;
    var newValue = (int)args.NewValue;
    if (oldValue == newValue)
        return;

    var target = obj as MainPage;
    target?.OnMyPropertyChanged(oldValue, newValue);
}

/// <summary>
/// MyProperty 屬性更改時呼叫此方法。
/// </summary>
/// <param name="oldValue">MyProperty 屬性的舊值。</param>
/// <param name="newValue">MyProperty 屬性的新值。</param>
protected virtual void OnMyPropertyChanged(int oldValue, int newValue)
{
}

上面是我自定義的程式碼段，改進了這些地方：

  • getter和setter使用了表示式主體；
  • DependencyProperty.Register的第一個引數使用了nameof()關鍵字代替了字串；
  • typeof(MainPage)這裡使用了程式碼段函式ClassName()直接獲取當前類的名稱；
  • 依賴屬性的預設值使用了default()關鍵字，因為絕大部分情況下依賴屬性的預設值就是資料型別的預設值，修改預設值的工作交給DefaultStyle的Setter；
  • 添加了相對完成的PropertyChangedCallback函式；

3. 如何自定義程式碼段

基本上，一個程式碼段就是一個XML檔案，

3.1 程式碼段的結構

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Keywords>
                <Keyword>dp</Keyword>
            </Keywords>
            <SnippetTypes>
                <SnippetType>SurroundsWith</SnippetType>
            </SnippetTypes>
            <Title>Dependency Property</Title>
            <Author>dino.c</Author>
            <Description>For Dependency Property</Description>
            <HelpUrl>
            </HelpUrl>
            <Shortcut>dp</Shortcut>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>
                    </Assembly>
                </Reference>
            </References>
            <Declarations>
                <Literal Editable="true">
                    <ID>PropertyType</ID>
                    <ToolTip>屬性型別</ToolTip>
                    <Default>int</Default>
                    <Function>
                    </Function>
                </Literal>
                ...
            </Declarations>
            <Code Language="csharp" Kind="method body">
                <![CDATA[     ...        ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

如上所示，程式碼段定義XML中主要分成以下幾個部分：

  1. Header：包括Keyword、Shortcut等資訊。Author和Description等可有可無；
  2. Declarations：程式碼段中的變數；
  3. Code：程式碼段的程式碼；

3.2 程式碼段中的變數

在我定義的依賴屬性程式碼段中包含了三個變數：

<Literal Editable="true">
    <ID>PropertyType</ID>
    <ToolTip>屬性型別</ToolTip>
    <Default>int</Default>
    <Function>
    </Function>
</Literal>
<Literal Editable="true">
    <ID>MyProperty</ID>
    <ToolTip>屬性名</ToolTip>
    <Default>MyProperty</Default>
    <Function>
    </Function>
</Literal>
<Literal Editable="false">
    <ID>classname</ID>
    <ToolTip>類名</ToolTip>
    <Function>ClassName()</Function>
    <Default>ClassNamePlaceholder</Default>
</Literal>

其中classname不可編輯，它使用了ClassName()這個程式碼段函式，返回包含已插入程式碼段的類的名稱。其它可用的程式碼段函式可以參考這個頁面：程式碼段函式 。

引用變數的語法是$變數名$，如下所示：

public static readonly DependencyProperty $MyProperty$Property =
    DependencyProperty.Register(nameof($MyProperty$), typeof($PropertyType$), typeof($classname$), new PropertyMetadata(default($PropertyType$), On$MyProperty$Changed));

3.3 匯入程式碼段

在選單上選擇“工具->程式碼片段管理器”：

在“程式碼片段管理器”視窗中點選“匯入”，選中需要匯入的檔案後開啟“匯入程式碼片段”，選擇位置後點擊“完成”即可完成程式碼段匯入：

3.4 最終成果

依賴屬性的程式碼段：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Keywords>
                <Keyword>dp</Keyword>
            </Keywords>
            <SnippetTypes>
                <SnippetType>SurroundsWith</SnippetType>
            </SnippetTypes>
            <Title>Dependency Property</Title>
            <Author>dino.c</Author>
            <Description>For Dependency Property</Description>
            <HelpUrl>
            </HelpUrl>
            <Shortcut>dp</Shortcut>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>
                    </Assembly>
                </Reference>
            </References>
            <Declarations>
                <Literal Editable="true">
                    <ID>PropertyType</ID>
                    <ToolTip>屬性型別</ToolTip>
                    <Default>int</Default>
                    <Function>
                    </Function>
                </Literal>
                <Literal Editable="true">
                    <ID>MyProperty</ID>
                    <ToolTip>屬性名</ToolTip>
                    <Default>MyProperty</Default>
                    <Function>
                    </Function>
                </Literal>
                <Literal Editable="false">
                    <ID>classname</ID>
                    <ToolTip>類名</ToolTip>
                    <Function>ClassName()</Function>
                    <Default>ClassNamePlaceholder</Default>
                </Literal>
            </Declarations>
            <Code Language="csharp" Kind="method body">
                <![CDATA[        
        /// <summary>
        /// 獲取或設定$MyProperty$的值
        /// </summary>  
        public $PropertyType$ $MyProperty$
        {
            get => ($PropertyType$)GetValue($MyProperty$Property);
            set => SetValue($MyProperty$Property, value);
        }

        /// <summary>
        /// 標識 $MyProperty$ 依賴屬性。
        /// </summary>
        public static readonly DependencyProperty $MyProperty$Property =
            DependencyProperty.Register(nameof($MyProperty$), typeof($PropertyType$), typeof($classname$), new PropertyMetadata(default($PropertyType$), On$MyProperty$Changed));

        private static void On$MyProperty$Changed(DependencyObject obj,DependencyPropertyChangedEventArgs args)
        {
            var oldValue = ($PropertyType$)args.OldValue;
            var newValue = ($PropertyType$)args.NewValue;
            if (oldValue == newValue)
              return;
            
            var target= obj as $classname$;
            target?.On$MyProperty$Changed(oldValue, newValue);
        }

        /// <summary>
        /// $MyProperty$ 屬性更改時呼叫此方法。
        /// </summary>
        /// <param name="oldValue">$MyProperty$ 屬性的舊值。</param>
        /// <param name="newValue">$MyProperty$ 屬性的新值。</param>
        protected virtual void On$MyProperty$Changed($PropertyType$ oldValue,$PropertyType$ newValue)
        {
        }]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

附加屬性的程式碼段：

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Keywords>
                <Keyword>ap</Keyword>
            </Keywords>
            <SnippetTypes>
                <SnippetType>Expansion</SnippetType>
            </SnippetTypes>
            <Title>Attached Property</Title>
            <Author>dino.c</Author>
            <Description>For Attached Property</Description>
            <HelpUrl>
            </HelpUrl>
            <Shortcut>ap</Shortcut>
        </Header>
        <Snippet>
            <References>
                <Reference>
                    <Assembly>
                    </Assembly>
                </Reference>
            </References>
            <Declarations>
                <Literal Editable="true">
                    <ID>PropertyType</ID>
                    <ToolTip>屬性型別</ToolTip>
                    <Default>int</Default>
                    <Function>
                    </Function>
                </Literal>
                <Literal Editable="true">
                    <ID>MyProperty</ID>
                    <ToolTip>屬性名</ToolTip>
                    <Default>MyProperty</Default>
                    <Function>
                    </Function>
                </Literal>
                <Literal Editable="false">
                    <ID>classname</ID>
                    <ToolTip>類名</ToolTip>
                    <Function>ClassName()</Function>
                    <Default>ClassNamePlaceholder</Default>
                </Literal>
            </Declarations>
            <Code Language="csharp">
                <![CDATA[
        /// <summary>
        /// 從指定元素獲取 $MyProperty$ 依賴項屬性的值。
        /// </summary>
        /// <param name="obj">從中讀取屬性值的元素。</param>
        /// <returns>從屬性儲存獲取的屬性值。</returns>
        public static $PropertyType$ Get$MyProperty$(DependencyObject obj) => ($PropertyType$)obj.GetValue($MyProperty$Property);

        /// <summary>
        /// 將 $MyProperty$ 依賴項屬性的值設定為指定元素。
        /// </summary>
        /// <param name="obj">對其設定屬性值的元素。</param>
        /// <param name="value">要設定的值。</param>
        public static void Set$MyProperty$(DependencyObject obj, $PropertyType$ value) => obj.SetValue($MyProperty$Property, value);

        /// <summary>
        /// 標識 $MyProperty$ 依賴項屬性。
        /// </summary>
        public static readonly DependencyProperty $MyProperty$Property =
            DependencyProperty.RegisterAttached("$MyProperty$", typeof($PropertyType$), typeof($classname$), new PropertyMetadata(default($PropertyType$), On$MyProperty$Changed));


        private static void On$MyProperty$Changed(DependencyObject obj, DependencyPropertyChangedEventArgs args)
        {
            var oldValue = ($PropertyType$)args.OldValue;
            var newValue = ($PropertyType$)args.NewValue;
            if (oldValue == newValue)
              return;
              
            var target = obj as $classname$;
        }

        ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

4. 結語

雖然這兩個程式碼段比較複雜，並不是每次建立依賴屬性都需要這麼完整，但刪除程式碼總比增加程式碼簡單得多，所以我多年來每次建立依賴屬性和附加屬性都是使用這兩個程式碼段。

WPF的依賴屬性可以十分複雜，但平時用不到這麼多功能，所以和UWP使用相同的程式碼段就夠了。

完整的程式碼段已上傳到 Github 。

5. 參考

程式碼段

相關推薦

[UWP]為附加屬性和依賴屬性自定義程式碼段（相容UWP和WPF）

1. 前言 之前介紹過依賴屬性和附加屬性的程式碼段，這兩個程式碼段我用了很多年，一直都幫了我很多。不過這兩個程式碼段我也多年沒修改過，Resharper老是提示我生成的程式碼可以修改，它這麼有誠意，這次就只好從了它，順便簡單介紹下怎麼自定義程式碼段。 2. VisualStudio自帶程式碼段的問題 以

Jupyter NoteBook 自定義程式碼段（snippet）提高程式碼效率

背景 現在喜歡用jupyter，有一些程式碼段需要經常性的重複使用，所以找了設定snippet的方法，留個記號。 以下兩個部件都可以，比較喜歡snippets下拉框。 步驟 方法一（sn

vector 的輸入輸出和結構體自定義排序模板（蒟蒻版）

#include<bits/stdc++.h> using namespace std; struct node { int id; }b[10]; vector<node>a; bool cmp(const node a,const node b) { retu

c++ map自定義比較函式（按key和按value）

按key： //自定義map的key typedef struct UrlKey { uint64_t dwBussID; uint64_t dwVersion; uint64

在iOS11 自定義titleview問題（位置 按鈕點擊）

icc ont init uicolor 控制 gpo avt arc sig 1、在自定義titleview的.h文件 裏重寫 intrinsicContentSize 屬性 @property(nonatomic, assign) CGSize intrinsicCo

HTML自定義選取按鈕（input樣式的按鈕）

自定義檔案上傳按鈕 谷歌瀏覽器下，預設的按鈕是這個樣子的： 火狐瀏覽器下是醬紫的： IE瀏覽器下是這個樣子的： 個人表示真的醜陋，無法接受！ 修改 首先 <!DOCTYPE html> <html&g

VSCode 如何操作使用者自定義程式碼片段（快捷鍵）

如何操作使用者自定義程式碼片段（快捷鍵）? 第一步：檔案==>首選項==>使用者程式碼片段 第二步：選擇程式碼片段檔案 html.json   第三步：輸入要自定義的快捷鍵 和 模板程式碼段 { "vh": { "prefix

微信自定義分享連結（設定標題+簡介+圖片）

$(function() { //對url進行編碼 var localUrl = encodeURIComponent(location.href.split('#')[0]); //url傳到後臺格式 var Url = "URL=" +localUrl; //這幾

sublime Text自定義程式碼段

剛剛看一個視訊，講師用的編輯器是Sublime Text，其中他講到了一個Sublime Text定義程式碼段的方法，覺得挺實用的就記了下來。 比如說，我們想要寫一個for...in的程式碼塊，想直接寫forin+tab鍵來獲得for...in的寫法，就不用自己去一個一個敲

Android自定義View實戰（會波動的View）

今天寫這篇部落格的目的，主要是幫助自己總結一下今天學習到的自定義View的相關知識，如果順便能夠幫助大家一點點，那我也感覺很開心。 首先，自定義的一般步驟是： 1.建立自定義View，繼承系統自帶的View，並重寫其相關構造方法； 2.在Values下面新

.NET開發環境VS中新增簡單自定義程式碼段

程式碼段極大增加了我們的開發效率，使我們可以快速調出固定的程式碼格式。 比如說，我們在程式中輸入cw，並按下兩次tab鍵，開發環境就會自動為我們生成程式碼。 按兩下tab鍵後 再比如我們輸入 prop 自動生成 我們只需要改一下相應的屬性型別和屬性名即可。 我們

vscode自定義程式碼段

用vscode做開發時，平時所用的程式碼段比較簡潔，為了提高開發效率，我們需要自定義我們用著習慣方便的程式碼段，這裡只是以js,vue為例。相信大家一看就明白，至於程式碼段在哪裡編寫，在這我就不多說了，

自定義圓形progressbar（包含進度動畫效果）

效果圖敬上：） attrs檔案： < resources> < declare-styleable name=”CircleProgressBarStyle”> <

微信小程式之自定義抽屜選單（從下拉出）例項 —— 微信小程式實戰系列（7）

微信提供了動畫api，就是下面這個 通過使用這個建立動畫的api，可以做出很多特效出來 下面介紹一個抽屜選單的案例 實現程式碼： wxml： <!--button--> &l

ORACLE中的自定義聚合函式（User-Defined Aggregate Functions）

聚合函式也叫分組函式，是對多行進行計算的一種函式，比如SUM、COUNT、AVG、MAX、MIN等等。Oracle中為了增強擴充套件性，提供了一個自定義聚合函式的介面，ODCIAggregate()，使用者可以用Oracle支援的各類程式語言（PLSQL、C、C++、JAVA

DataTables自定義表格寬度（設定橫向滾動條）

當表格的列比較多時 橫向列太擁擠  這時候需要自定義寬度 設定橫向滾動條 1.html程式碼 <div id="tableArea"> <table id="tabl

WPF 自定義的圖表（適用大量資料繪製）

在WPF中繪製圖表比較簡單，有很多的第三方控制元件，但是在繪製大量資料的時候，就顯得有些吃力，即便是自己用StreamGeometry畫也達不到理想的效果，要達到繪製大量資料而不會頓卡現象，只有一個途徑，就是首先在記憶體中繪製好所有的圖形，再一次性載入（或者說繪製）到介面控

Python高手系列：自定義異常類（帶寫入日誌功能）

class MYException(Exception):    def __init__(self,Message):        Exception.__init__(self)        self.__str__=Message    def WriteLog(s

[AS3.0.1]自定義選項listview（標籤流式佈局）

一個自定義選項listview，超過實際寬度會自動換行。 emmmmmm，查了會百度，才知道這個自定義view叫標籤流式佈局，不過這個是按自己思路寫的。 後續實現了一個viewgroup的[AS3.0.1]自定義ViewGroup的學習，寫一個FlowLay

一句python，一句R︱列表、元組、字典、資料型別、自定義模組匯入（格式、去重）

先學了R，最近剛剛上手python,所以想著將python和R結合起來互相對比來更好理解python。最好就是一句python，對應寫一句R。pandas中有類似R中的read.table的功能，而且很像。———————————————————————————————————