怎么在c#項(xiàng)目中自定義MarkupExtension

這篇文章給大家介紹怎么在c#項(xiàng)目中自定義MarkupExtension，內(nèi)容非常詳細(xì)，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

Markup Extension，顧名思義，就是對xaml的擴(kuò)展，在XAML中，規(guī)定如果屬性以{}開始及結(jié)束，就是Markup Extension，Markup Extension指的是繼承于MarkupExtension的類，首先我們通過一張圖來看看WPF中有哪些已知的Markup Extension。

　　看了這張圖片之后是不是對這個(gè)MarkupExtension有一個(gè)常規(guī)的認(rèn)識，你會發(fā)現(xiàn)這個(gè)在WPF中實(shí)在是太重要了，通過這個(gè)MarkupExtension我們能夠?qū)崿F(xiàn)綁定、資源等等一系列的操作，在介紹完這個(gè)之后，我們來看看，這個(gè)抽象的MarkupExtension基類到底是什么？里面包含些什么？怎么去使用它？

#region 程序集 WindowsBase.dll, v3.0.0.0
// C:\Program Files\Reference Assemblies\Microsoft\Framework\v3.0\WindowsBase.dll
#endregion

using System;

namespace System.Windows.Markup
{
 // 摘要:
 //  為所有 XAML 標(biāo)記擴(kuò)展提供基類。
 public abstract class MarkupExtension
 {
  // 摘要:
  //  初始化從 System.Windows.Markup.MarkupExtension 派生的類的新實(shí)例。
  protected MarkupExtension();

  // 摘要:
  //  在派生類中實(shí)現(xiàn)時(shí)，返回一個(gè)對象，此對象被設(shè)置為此標(biāo)記擴(kuò)展的目標(biāo)屬性的值。
  //
  // 參數(shù):
  // serviceProvider:
  //  可以為標(biāo)記擴(kuò)展提供服務(wù)的對象。
  //
  // 返回結(jié)果:
  //  將在擴(kuò)展應(yīng)用到的屬性上設(shè)置的對象值。
  public abstract object ProvideValue(IServiceProvider serviceProvider);
 }
}

 　　其實(shí)看看里面的內(nèi)容，僅僅提供了一個(gè)抽象的方法ProvideValue，我們在繼承這個(gè)抽象類后需要去重載這個(gè)抽象方法，然后來實(shí)現(xiàn)自己的邏輯。

　　在對整個(gè)MarkupExtension介紹之后，我們可以對它進(jìn)行一個(gè)總結(jié)，那就是：

　　XAML標(biāo)記擴(kuò)展語法格式：

　　<元素對象 對象屬性=”{擴(kuò)展標(biāo)記 擴(kuò)展標(biāo)記屬性 = 擴(kuò)展屬性值}” />
      這個(gè)是不是很熟悉，如果還是不夠直觀的話，我們可以通過代碼來進(jìn)行說明：      

<TextBox Text=”{Binding Path=ProductName}”/>

　　再來一個(gè)復(fù)雜一些的例子吧

<Popup IsOpen="{Binding Path=IsSubmenuOpen, RelativeSource={RelativeSource TemplatedParent}}" Placement="Right" x:Name="SubMenuPopup" Focusable="false" AllowsTransparency="true" PopupAnimation="{DynamicResource {x:Static SystemParameters.MenuPopupAnimationKey}}"/>

　　類似的這種我們在WPF中見到的是在是太多了，那么既然基類是一個(gè)抽象方法那么我們是不是可以通過重載這種方式來寫自己的MarkupExtension呢？這個(gè)當(dāng)然是可以的，我們可以通過下面的幾個(gè)例子來進(jìn)行相應(yīng)的說明。

　　示例1：通過MarkupExtension綁定MenuItem的Icon屬性。

　　我們知道，MenuItem的Icon屬性可以通過下面的方式進(jìn)行設(shè)置：

<MenuItem Header="New">
  <MenuItem.Icon>
    <Image Source="data/cat.png"/>
  </MenuItem.Icon>
</MenuItem>

　　這個(gè)是MSDN介紹的常規(guī)方式，在這里我們可以通過三種不同的方式來達(dá)到這個(gè)目的，具體來看看是怎么實(shí)現(xiàn)的吧？

<Menu Grid.Column="0">
           <MenuItem Header="文本">
               <MenuItem Header="重做">
                   <MenuItem.Icon>
                       <Image Stretch="Uniform" Source="{extension:ImageBinding Redo}"></Image>
                   </MenuItem.Icon>
               </MenuItem>
               <MenuItem Header="撤銷">
                   <MenuItem.Icon>
                       <Image Stretch="Uniform" Source="{extension:ImageBinding Undo}"></Image>
                   </MenuItem.Icon>
               </MenuItem>
               <MenuItem Header="保存所有">
                   <MenuItem.Icon>
                       <Image Stretch="Uniform" Source="{Binding SaveAll,Converter={StaticResource SourceConverter}}"></Image>
                   </MenuItem.Icon>
               </MenuItem>
               <MenuItem Header="測試">
                   <MenuItem.Icon>
                       <Image Stretch="Uniform" Source="Resources/Images/Redo.png"></Image>
                   </MenuItem.Icon>
               </MenuItem>
           </MenuItem>
           <MenuItem Header="編輯"></MenuItem>
           <MenuItem Header="視圖"></MenuItem>
           <MenuItem Header="插件"></MenuItem>
       </Menu>

　　第一種方式就是我們今天重點(diǎn)介紹的通過繼承MarkupExtension來實(shí)現(xiàn)同樣的效果，我們來具體分析一下這個(gè)ImageBinding

public class ImageBindingExtension : System.Windows.Markup.MarkupExtension
   {
       public ImageBindingExtension(string path)
           : this()
       {
           Path = path;
       }
 
       public ImageBindingExtension()
       {
       }
 
       [ConstructorArgument("path")]
       public string Path
       {
           get;
           set;
       }
 
 
       public override object ProvideValue(IServiceProvider serviceProvider)
       {
           IProvideValueTarget target = serviceProvider.GetService(typeof(IProvideValueTarget)) as IProvideValueTarget;
 
           if (target.TargetObject is Setter)
           {
               return new Binding(Path) { Converter = ImgaeSourceConverter.Default };
           }
           else
           {
               Binding binding = new Binding(Path) { Converter = ImgaeSourceConverter.Default };
               return binding.ProvideValue(serviceProvider);
           }
           
       }
   }

　　這里面我們定義的Path屬性就是綁定到ViewModel中的一個(gè)特定的屬性，這里我們通過重寫ProvideValue方法，最終調(diào)用BindingBase的ProvideValue返回ImageSource對象，這里是通過一個(gè)轉(zhuǎn)換器來實(shí)現(xiàn)源屬性(字符串)到目標(biāo)屬性ImageSource的轉(zhuǎn)換的，我們會發(fā)現(xiàn)，其實(shí)這種方法和直接綁定并設(shè)置轉(zhuǎn)換器其實(shí)效果是一樣的，只不過第一種方式更為直觀，將所有的轉(zhuǎn)換過程都放在了重寫ProvideValue函數(shù)的過程中了，這個(gè)讀者在后面可以對照demo去認(rèn)真思考然后加以總結(jié)。

　　示例2：通過MarkupExtension綁定到ListBox的ItemsSource屬性

　　這個(gè)稍微復(fù)雜一些，我們在Reflection這個(gè)MarkupExtension中加入了一些自定義的屬性，這些屬性能夠控制后面返回的數(shù)據(jù)源的最終內(nèi)容，其實(shí)這個(gè)也是非常好理解的，我們在定義RelativeSource這個(gè)MarkupExtension的時(shí)候，也是通過定義Mode、AncestorType、AncestorLevel等屬性組合起來最終實(shí)現(xiàn)在視覺樹上找到最終的元素。在代碼里面也不復(fù)雜主要是通過反射來獲取Button的屬性、方法、事件、字段等等，這個(gè)具體的實(shí)現(xiàn)過程可以參考后面的代碼。

public class ReflectionExtension : System.Windows.Markup.MarkupExtension
    {
        public Type CurrentType { get; set; }
        public bool IncludeMethods { get; set; }
        public bool IncludeFields { get; set; }
        public bool IncludeEvents { get; set; }
 
        public ReflectionExtension(Type currentType)
        {
            this.CurrentType = currentType;
        }
 
        public override object ProvideValue(IServiceProvider serviceProvider)
        {
            if (this.CurrentType == null)
            {
                throw new ArgumentException("Type argument is not specified");
            }
 
            ObservableCollection<string> collection = new ObservableCollection<string>();
            foreach (PropertyInfo p in this.CurrentType.GetProperties())
            {
                collection.Add(string.Format("屬性 : {0}", p.Name));
            }
 
            if (this.IncludeMethods)
            {
                foreach (MethodInfo m in this.CurrentType.GetMethods())
                {
                    collection.Add(string.Format("方法 : {0} with {1} argument(s)", m.Name, m.GetParameters().Count()));
                }
            }
            if (this.IncludeFields)
            {
                foreach (FieldInfo f in this.CurrentType.GetFields())
                {
                    collection.Add(string.Format("字段 : {0}", f.Name));
                }
            }
            if (this.IncludeEvents)
            {
                foreach (EventInfo e in this.CurrentType.GetEvents())
                {
                    collection.Add(string.Format("事件 : {0}", e.Name));
                }
            }
            return collection;
        }
 
    }

關(guān)于怎么在c#項(xiàng)目中自定義MarkupExtension就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，可以學(xué)到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。