WPF源代碼分析系列一：剖析WPF模板機制的內部實作（五）

(注：本文是《剖析WPF模板機制的內部實作》系列文章的最后一篇文章，查看上一篇文章請點這里)

上一篇文章我們討論了DataTemplate型別的兩個重要變數，ContentControl.ContentTemplate和ContentPresenter.ContentTemplate，這一篇將討論這個型別的另一個重要變數ItemsControl.ItemTemplate，

4.2）ItemsControl.ItemTemplate

我們都知道ItemsControl控制元件在WPF中的重要性，ItemsControl.ItemTemplate用的也非常多，那么其在模板應用中的角色是什么呢？要回答這個問題，我們先看其定義：

    public static readonly DependencyProperty ItemTemplateProperty =
                DependencyProperty.Register(
                        "ItemTemplate",
                        typeof(DataTemplate),
                        typeof(ItemsControl),
                        new FrameworkPropertyMetadata(
                                (DataTemplate) null,
                                OnItemTemplateChanged));

        /// <summary>
        ///     ItemTemplate is the template used to display each item.
        /// </summary>public DataTemplate ItemTemplate
        {
            get { return (DataTemplate) GetValue(ItemTemplateProperty); }
            set { SetValue(ItemTemplateProperty, value); }
        }

        private static void OnItemTemplateChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
        {
            ((ItemsControl) d).OnItemTemplateChanged((DataTemplate) e.OldValue, (DataTemplate) e.NewValue);
        }

        protected virtual void OnItemTemplateChanged(DataTemplate oldItemTemplate, DataTemplate newItemTemplate)
        {
            CheckTemplateSource();
 
            if (_itemContainerGenerator != null)
            {
                _itemContainerGenerator.Refresh();
            }
        }

 可以看到當ItemsControl.ItemTemplate改變時，會呼叫_itemContainerGenerator.Refresh()，這個方法的定義如下：

        // regenerate everything
        internal void Refresh()
        {
            OnRefresh();
        }

        // Called when the items collection is refreshed
        void OnRefresh()
        {
            ((IItemContainerGenerator)this).RemoveAll();

            // tell layout what happened
            if (ItemsChanged != null)
            {
                GeneratorPosition position = new GeneratorPosition(0, 0);
                ItemsChanged(this, new ItemsChangedEventArgs(NotifyCollectionChangedAction.Reset, position, 0, 0));
            }
        }

可見這個方法呼叫OnRefresh()，后者的主要作業清空已經生成的元素，并觸發ItemsChanged事件，告訴所有監聽者串列已經被重置，

查找ItemsControl.ItemTemplate的參考會發現一個值得注意的方法ItemsControl.PrepareContainerForItemOverride：

//*********************ItemsControl*************************

        /// <summary>
        /// Prepare the element to display the item.  This may involve
        /// applying styles, setting bindings, etc.
        /// </summary>
        protected virtual void PrepareContainerForItemOverride(DependencyObject element, object item)
        {
            // Each type of "ItemContainer" element may require its own initialization.
            // We use explicit polymorphism via internal methods for this.
            //
            // Another way would be to define an interface IGeneratedItemContainer with
            // corresponding virtual "core" methods.  Base classes (ContentControl,
            // ItemsControl, ContentPresenter) would implement the interface
            // and forward the work to subclasses via the "core" methods.
            //

            // While this is better from an OO point of view, and extends to
            // 3rd-party elements used as containers, it exposes more public API.
            // Management considers this undesirable, hence the following rather
            // inelegant code.

            HeaderedContentControl hcc;
            ContentControl cc;
            ContentPresenter cp;
            ItemsControl ic;
            HeaderedItemsControl hic;

            if ((hcc = element as HeaderedContentControl) != null)
            {
                hcc.PrepareHeaderedContentControl(item, ItemTemplate, ItemTemplateSelector, ItemStringFormat);
            }
            else if ((cc = element as ContentControl) != null)
            {
                cc.PrepareContentControl(item, ItemTemplate, ItemTemplateSelector, ItemStringFormat);
            }
            else if ((cp = element as ContentPresenter) != null)
            {
                cp.PrepareContentPresenter(item, ItemTemplate, ItemTemplateSelector, ItemStringFormat);
            }
            else if ((hic = element as HeaderedItemsControl) != null)
            {
                hic.PrepareHeaderedItemsControl(item, this);
            }
            else if ((ic = element as ItemsControl) != null)
            {
                if (ic != this)
                {
                    ic.PrepareItemsControl(item, this);
                }
            }
        }

這個方法的主要作業是根據第一個入參element的型別，做一些準備作業，如HeaderedContentControl和HeaderedItemsControl會把ItemTemplate的值賦給HeaderTemplate，而ContentControl和ContentPresenter則會用它更新ContentTemplate，如果是element也是ItemsControl，這意味著一個ItemsControl的ItemTemplate里又嵌套了一個ItemsControl，這時就把父控制元件的ItemTemplate傳遞給子控制元件的ItemTemplate，

那么問題是ItemsControl.PrepareContainerForItemOverride()方法什么時候會被呼叫呢？查看參考發現，這個方法會被ItemsControl.PrepareItemContainer()呼叫，后者又會被ItemContainerGenerator.PrepareItemContainer()方法呼叫，

繼續追蹤發現，Panel類通過Generator屬性呼叫了ItemContainerGenerator.PrepareItemContainer()方法，Panel.Generator屬性是一個ItemContainerGenerator型別的只讀屬性，其支撐欄位是_itemContainerGenerator，那么Panel的Generator屬性又是從哪里得到的呢？秘密就在下面這個方法：

//*************Panel*************


        private void ConnectToGenerator()
        {
            ItemsControl itemsOwner = ItemsControl.GetItemsOwner(this);

            if (itemsOwner == null)
            {
                // This can happen if IsItemsHost=true, but the panel is not nested in an ItemsControl
                throw new InvalidOperationException(SR.Get(SRID.Panel_ItemsControlNotFound));
            }

            IItemContainerGenerator itemsOwnerGenerator = itemsOwner.ItemContainerGenerator;

            if (itemsOwnerGenerator != null)
            {
                _itemContainerGenerator = itemsOwnerGenerator.GetItemContainerGeneratorForPanel(this);

                if (_itemContainerGenerator != null)
                {
                    _itemContainerGenerator.ItemsChanged += new ItemsChangedEventHandler(OnItemsChanged);
                    ((IItemContainerGenerator)_itemContainerGenerator).RemoveAll();
                }
            }
        }

可以看到，這個方法會先呼叫靜態方法ItemsControl.GetItemsOwner()獲得這個Panel所處的ItemsControl，這個方法的定義如下：

//****************ItemsControl******************* 

       /// <summary>
        ///     Returns the ItemsControl for which element is an ItemsHost.
        ///     More precisely, if element is marked by setting IsItemsHost="true"
        ///     in the style for an ItemsControl, or if element is a panel created
        ///     by the ItemsPresenter for an ItemsControl, return that ItemsControl.
        ///     Otherwise, return null.
        /// </summary>
        public static ItemsControl GetItemsOwner(DependencyObject element)
        {
            ItemsControl container = null;
            Panel panel = element as Panel;

            if (panel != null && panel.IsItemsHost)
            {
                // see if element was generated for an ItemsPresenter
                ItemsPresenter ip = ItemsPresenter.FromPanel(panel);

                if (ip != null)
                {
                    // if so use the element whose style begat the ItemsPresenter
                    container = ip.Owner;
                }
                else
                {
                    // otherwise use element's templated parent
                    container = panel.TemplatedParent as ItemsControl;
                }
            }

            return container;
        }

這個方法的注釋已經說的很清楚了：在獲取一個Panel所處的ItemsControl時，如果這個Panel的IsItemsHost屬性非真則回傳空值；不然，那么如果這個Panel的TemplateParent是ItemsPresenter，則回傳其Owner，否則則直接回傳這個Panel的TemplateParent，在知道自己所在的ItemsControl后，這個Panel就能呼叫這個ItemsControl的ItemContainerGenerator屬性的GetItemContainerGeneratorForPanel()方法來獲得一個正確的ItemContainerGenerator給其_itemContainerGenerator欄位（Panel的Generator屬性）賦值，

那么這里說的這個Panel是怎么出現在ItemsControl里的呢？要回答這個問題可以看一下ItemsControl的默認ItemsPanel模板：

        <ItemsPanelTemplate x:Key="ItemsPanelTemplate1">
            <StackPanel IsItemsHost="True"/>
        </ItemsPanelTemplate>

 此外，我們前面在介紹ItemsPanelTemplate時也提到過，ItemsControl.ItemsPanel屬性的默認值就是StackPanel，這里重貼一下代碼：

        public static readonly DependencyProperty ItemsPanelProperty
            = DependencyProperty.Register("ItemsPanel", typeof(ItemsPanelTemplate), typeof(ItemsControl),
                                          new FrameworkPropertyMetadata(GetDefaultItemsPanelTemplate(),
                                                                        OnItemsPanelChanged));

        private static ItemsPanelTemplate GetDefaultItemsPanelTemplate()
        {
            ItemsPanelTemplate template = new ItemsPanelTemplate(new FrameworkElementFactory(typeof(StackPanel)));
            template.Seal();
            return template;
        }

我們知道可以用作ItemsControl的ItemsPanel模板的控制元件基本都是Panel類的子類，而ItemsControl的默認ItemsPanel模板就用了StackPanel（此外，查看源代碼可以看到ListBox和ListView的默認ItemsPanel都是VirtualizingStackPanel，Menu類是WrapPanel，StatusBar類是DockPanel），另外，要作為ItemDataTemplate生成的item container的容器，這個StackPanel的IsItemHost的值也必須為真，

結合第三篇文章的內容，這里我們按照從上至下的順序梳理ItemsControl的模板應用機制：一個ItemsControl在應用模板時，首先會應用Template屬性定義的模板生成自身的visual tree（這也是繼承的Control類的模板機制），然后Template中的ItemsPresenter應用它的TemplateParent（即這個ItemsControl）的ItemsPanel模板生成一個visual tree，并把這個visual tree放置在這個ItemsPresenter的位置，ItemsPresenter只起一個占位符的作用，它不會定義自己的模板，特別的，要正確顯示串列內容，ItemsPanel必須包含一個IsItemHost屬性為真的面板，在ItemsPanel模板被應用時，這個面板會通過ConnectToGenerator()方法獲得這個ItemsControl的ItemContainerGenrator，并呼叫其PrepareItemContainer()方法，并把這個ItemsContro的ItemTemplate模板裝配到container相應的模板屬性上，以供在呈現資料項（item）生成visual tree時使用， 

（本文完結）

（寫的有點亂，待完善）

（感謝閱讀，歡迎批評指正，轉載請注明出處！）

標籤：.NET技术

上一篇：WPF源代碼分析系列一：剖析WPF模板機制的內部實作（四）

下一篇：字串轉換注意編碼