web-dev-qa-db-ja.com

TabControlが子を再作成しないようにする

IListにバインドされているビューモデルのTabControlがあります。このIListはTabControlの存続期間を通じて変更されません。

<TabControl ItemsSource="{Binding Tabs}" SelectedIndex="0" >
    <TabControl.ItemContainerStyle>
        <Style TargetType="TabItem">
            <Setter Property="Content" Value="{Binding}" />
        </Style>
    </TabControl.ItemContainerStyle>
</TabControl>

各ビューモデルには、DataTemplateで指定されるResourceDictionaryがあります。

<DataTemplate TargetType={x:Type vm:MyViewModel}>
    <v:MyView/>
</DataTemplate>

DataTemplateで指定された各ビューはリソースを集中的に使用して作成するので、各ビューを1回だけ作成しますが、タブを切り替えると、関連するビューのコンストラクターが呼び出されます。私が読んだことから、これはTabControlの予想される動作ですが、コンストラクタを呼び出すメカニズムが何であるかは明確ではありません。

私は UserControlsを使用する同様の質問 を調べましたが、そこで提供されているソリューションでは、ビューにバインドする必要があり、これは望ましくありません。

c#wpfmvvmdatatemplatetabcontrol
35
Mike

デフォルトでは、TabControlはコンテンツをレンダリングするためのパネルを共有します。必要なこと（および他の多くのWPF開発者）を実行するには、TabControlを次のように拡張する必要があります。

TabControlEx.cs

[TemplatePart(Name = "PART_ItemsHolder", Type = typeof(Panel))]
public class TabControlEx : TabControl
{
    private Panel ItemsHolderPanel = null;

    public TabControlEx()
        : base()
    {
        // This is necessary so that we get the initial databound selected item
        ItemContainerGenerator.StatusChanged += ItemContainerGenerator_StatusChanged;
    }

    /// <summary>
    /// If containers are done, generate the selected item
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    private void ItemContainerGenerator_StatusChanged(object sender, EventArgs e)
    {
        if (this.ItemContainerGenerator.Status == GeneratorStatus.ContainersGenerated)
        {
            this.ItemContainerGenerator.StatusChanged -= ItemContainerGenerator_StatusChanged;
            UpdateSelectedItem();
        }
    }

    /// <summary>
    /// Get the ItemsHolder and generate any children
    /// </summary>
    public override void OnApplyTemplate()
    {
        base.OnApplyTemplate();
        ItemsHolderPanel = GetTemplateChild("PART_ItemsHolder") as Panel;
        UpdateSelectedItem();
    }

    /// <summary>
    /// When the items change we remove any generated panel children and add any new ones as necessary
    /// </summary>
    /// <param name="e"></param>
    protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
    {
        base.OnItemsChanged(e);

        if (ItemsHolderPanel == null)
            return;

        switch (e.Action)
        {
            case NotifyCollectionChangedAction.Reset:
                ItemsHolderPanel.Children.Clear();
                break;

            case NotifyCollectionChangedAction.Add:
            case NotifyCollectionChangedAction.Remove:
                if (e.OldItems != null)
                {
                    foreach (var item in e.OldItems)
                    {
                        ContentPresenter cp = FindChildContentPresenter(item);
                        if (cp != null)
                            ItemsHolderPanel.Children.Remove(cp);
                    }
                }

                // Don't do anything with new items because we don't want to
                // create visuals that aren't being shown

                UpdateSelectedItem();
                break;

            case NotifyCollectionChangedAction.Replace:
                throw new NotImplementedException("Replace not implemented yet");
        }
    }

    protected override void OnSelectionChanged(SelectionChangedEventArgs e)
    {
        base.OnSelectionChanged(e);
        UpdateSelectedItem();
    }

    private void UpdateSelectedItem()
    {
        if (ItemsHolderPanel == null)
            return;

        // Generate a ContentPresenter if necessary
        TabItem item = GetSelectedTabItem();
        if (item != null)
            CreateChildContentPresenter(item);

        // show the right child
        foreach (ContentPresenter child in ItemsHolderPanel.Children)
            child.Visibility = ((child.Tag as TabItem).IsSelected) ? Visibility.Visible : Visibility.Collapsed;
    }

    private ContentPresenter CreateChildContentPresenter(object item)
    {
        if (item == null)
            return null;

        ContentPresenter cp = FindChildContentPresenter(item);

        if (cp != null)
            return cp;

        // the actual child to be added.  cp.Tag is a reference to the TabItem
        cp = new ContentPresenter();
        cp.Content = (item is TabItem) ? (item as TabItem).Content : item;
        cp.ContentTemplate = this.SelectedContentTemplate;
        cp.ContentTemplateSelector = this.SelectedContentTemplateSelector;
        cp.ContentStringFormat = this.SelectedContentStringFormat;
        cp.Visibility = Visibility.Collapsed;
        cp.Tag = (item is TabItem) ? item : (this.ItemContainerGenerator.ContainerFromItem(item));
        ItemsHolderPanel.Children.Add(cp);
        return cp;
    }

    private ContentPresenter FindChildContentPresenter(object data)
    {
        if (data is TabItem)
            data = (data as TabItem).Content;

        if (data == null)
            return null;

        if (ItemsHolderPanel == null)
            return null;

        foreach (ContentPresenter cp in ItemsHolderPanel.Children)
        {
            if (cp.Content == data)
                return cp;
        }

        return null;
    }

    protected TabItem GetSelectedTabItem()
    {
        object selectedItem = base.SelectedItem;
        if (selectedItem == null)
            return null;

        TabItem item = selectedItem as TabItem;
        if (item == null)
            item = base.ItemContainerGenerator.ContainerFromIndex(base.SelectedIndex) as TabItem;

        return item;
    }
}

[〜＃〜] xaml [〜＃〜]

<Style TargetType="{x:Type controls:TabControlEx}">
    <Setter Property="Template">
        <Setter.Value>
            <ControlTemplate TargetType="{x:Type TabControl}">
                <Grid Background="{TemplateBinding Background}" ClipToBounds="True" KeyboardNavigation.TabNavigation="Local" SnapsToDevicePixels="True">
                    <Grid.ColumnDefinitions>
                        <ColumnDefinition x:Name="ColumnDefinition0" />
                        <ColumnDefinition x:Name="ColumnDefinition1" Width="0" />
                    </Grid.ColumnDefinitions>
                    <Grid.RowDefinitions>
                        <RowDefinition x:Name="RowDefinition0" Height="Auto" />
                        <RowDefinition x:Name="RowDefinition1" Height="*" />
                    </Grid.RowDefinitions>
                    <DockPanel Margin="2,2,0,0" LastChildFill="False">
                        <TabPanel x:Name="HeaderPanel" Margin="0,0,0,-1" VerticalAlignment="Bottom" Panel.ZIndex="1" DockPanel.Dock="Right"
                                  IsItemsHost="True" KeyboardNavigation.TabIndex="1" />
                    </DockPanel>
                    <Border x:Name="ContentPanel" Grid.Row="1" Grid.Column="0"
                            Background="{TemplateBinding Background}"
                            BorderBrush="{TemplateBinding BorderBrush}"
                            BorderThickness="{TemplateBinding BorderThickness}"
                            KeyboardNavigation.DirectionalNavigation="Contained" KeyboardNavigation.TabIndex="2" KeyboardNavigation.TabNavigation="Local">
                        <Grid x:Name="PART_ItemsHolder" Margin="{TemplateBinding Padding}" SnapsToDevicePixels="{TemplateBinding SnapsToDevicePixels}" />
                    </Border>
                </Grid>
            </ControlTemplate>
        </Setter.Value>
    </Setter>
</Style>

注：私はこの解決策を思いつきませんでした。これは数年前からプログラミングフォーラムで共有されており、現在はWPFレシピ本の1つに含まれていると考えています。私が信じる最も古いまたは元のソースは PluralSight .NETブログの投稿 で、これは StackOverflowの回答 でした。

HTH、

46
Dennis

Dennisの答えは素晴らしく、私にとってはとてもうまくいきました。しかし、彼の投稿で言及された元の記事は現在欠落しているため、彼の答えは、箱から出してすぐに使用できるようにもう少し情報が必要です。

この回答はMVVMの観点から与えられ、VS 2013でテストされました。

まず、背景について少し説明します。 Dennisからの最初の答えは、ユーザーがタブを切り替えるたびに、タブのコンテンツを破棄して再作成するのではなく、タブのコンテンツを非表示にして表示することです。

これには次の利点があります。

  • タブを切り替えても編集ボックスの内容は消えません。
  • タブでツリービューを使用している場合、タブの変更間で折りたたまれません。
  • グリッドの現在の選択は、タブスイッチ間で保持されます。
  • このコードは、MVVMスタイルのプログラミングにより適合します。
  • タブの変更の間にタブの設定を保存およびロードするためのコードを記述する必要はありません。
  • サードパーティのコントロール（TelerikやDevExpressなど）を使用している場合、グリッドレイアウトなどの設定はタブスイッチ間で保持されます。
  • 大幅なパフォーマンスの向上-タブが変更されるたびにすべてを再描画するわけではないため、タブの切り替えは事実上瞬時です。

TabControlEx.cs

// Copy C# code from @Dennis's answer, and add the following property after the 
// opening "<Style" tag (this sets the key for the style):
// x:Key="TabControlExStyle"
// Ensure that the namespace for this class is the same as your DataContext.

これは、DataContextが指すのと同じクラスに入ります。

[〜＃〜] xaml [〜＃〜]

// Copy XAML from @Dennis's answer.

これはスタイルです。 XAMLファイルのヘッダーに入ります。このスタイルは変更されず、すべてのタブコントロールによって参照されます。

元のタブ

元のタブは次のようになります。タブを切り替えると、タブのコンテンツがドロップされて再作成されるため、編集ボックスのコンテンツが消えることに気づくでしょう。

<TabControl
  behaviours:TabControlBehaviour.DoSetSelectedTab="True"
  IsSynchronizedWithCurrentItem="True">
<TabItem Header="Tab 1">
  <TextBox>Hello</TextBox>
</TabItem>
<TabItem Header="Tab 2" >
  <TextBox>Hello 2</TextBox>
</TabItem>

カスタムタブ

新しいカスタムC＃クラスを使用するようにタブを変更し、Styleタグを使用して新しいカスタムスタイルを指すようにします。

<sdm:TabControlEx
  behaviours:TabControlBehaviour.DoSetSelectedTab="True"
  IsSynchronizedWithCurrentItem="True"
  Style="{StaticResource TabControlExStyle}">
<TabItem Header="Tab 1">
  <TextBox>Hello</TextBox>
</TabItem>
<TabItem Header="Tab 2" >
  <TextBox>Hello 2</TextBox>
</TabItem>

これで、タブを切り替えると、編集ボックスの内容が保持されていることがわかります。これは、すべてが適切に機能していることを証明しています。

更新

このソリューションは非常にうまく機能します。ただし、これを行うにはよりモジュール化されたMVVMフレンドリな方法があり、アタッチされた動作を使用して同じ結果を達成します。 コードプロジェクト：WPFタブコントロール：タブの仮想化をオフにする を参照してください。これを追加の回答として追加しました。

更新

DevExpressを使用している場合は、CacheAllTabsオプションを使用して同じ効果を得ることができます（これにより、タブの仮想化がオフになります）。

<dx:DXTabControl TabContentCacheMode="CacheAllTabs">
    <dx:DXTabItem Header="Tab 1" >
        <TextBox>Hello</TextBox>
    </dx:DXTabItem>
    <dx:DXTabItem Header="Tab 2">
        <TextBox>Hello 2</TextBox>
    </dx:DXTabItem>
</dx:DXTabControl>

ちなみに、私はDevExpressとは関係ありません。Telerikにも同等のものがあると確信しています。

更新

Telerikには同等のIsContentPreservedがあります。以下のコメントで@Luishgに感謝します。

10
Contango

@Dennisによるこの既存のソリューション（@Gravitasによる追加のメモ付き）は非常にうまく機能します。

ただし、アタッチされた動作を使用して同じ結果を達成するため、よりモジュール化されたMVVMフレンドリーな別のソリューションがあります。

コードプロジェクト：WPFタブコントロール：タブの仮想化をオフにする を参照してください。著者はロイターのテクニカルリーダーであるため、コードはおそらくしっかりしています。

デモコードは本当にうまくまとめられており、通常のTabControlと、動作が関連付けられたものを示しています。

enter image description here

4
Contango

SOのこの投稿から私の回答を確認してください。問題が解決することを願っていますが、MVVMの道から少し離れています。 リンク

1
Rahul W

あまり明確ではありませんが、エレガントな解決策があります。主なアイデアは、カスタムコンバーターを介してTabItemのContentプロパティのVisualTreeを手動で生成することです。

いくつかのリソースを定義する

<Window.Resources>
    <converters:ContentGeneratorConverter x:Key="ContentGeneratorConverter"/>

    <DataTemplate x:Key="ItemDataTemplate">
        <StackPanel>
            <TextBox Text="Try to change this text and choose another tab"/>
            <TextBlock Text="{Binding}"/>
        </StackPanel>
    </DataTemplate>

    <markup:Set x:Key="Items">
        <system:String>Red</system:String>
        <system:String>Green</system:String>
        <system:String>Blue</system:String>
    </markup:Set>
</Window.Resources>

どこ

public class ContentGeneratorConverter : IValueConverter
{
    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
    {
        var control = new ContentControl {ContentTemplate = (DataTemplate) parameter};
        control.SetBinding(ContentControl.ContentProperty, new Binding());
        return control;
    }

    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture) =>
        throw new NotImplementedException();
}

そしてセットはこのようなものです

public class Set : List<object> { }

次に、代わりにContentTemplateプロパティの従来の使用

    <TabControl
        ItemsSource="{StaticResource Items}"
        ContentTemplate="{StaticResource ItemDataTemplate}">
    </TabControl>

次の方法でItemContainerStyleを指定する必要があります

    <TabControl
        ItemsSource="{StaticResource Items}">
        <TabControl.ItemContainerStyle>
            <Style TargetType="TabItem" BasedOn="{StaticResource {x:Type TabItem}}">
                <Setter Property="Content" Value="{Binding Converter={StaticResource ContentGeneratorConverter}, ConverterParameter={StaticResource ItemDataTemplate}}"/>
            </Style>
        </TabControl.ItemContainerStyle>
    </TabControl>

次に、両方のバリエーションを比較して、タブ切り替え時のItemDataTemplateでのTextBoxの動作の違いを確認します。

0
Makeman