片鱗懐古のブログ: wpf : ListViewItemのDataTemplateで作った子コントロールを探す

検索してもそのものズバリが出てこなかったので一応書いてみました。特定の行のListViewItemを探すには次のコードを使います。

var listViewItem = listView.ItemContainerGenerator.ContainerFromIndex(i) as ListViewItem;

でもこれだけじゃダメです。 ListViewはデフォルトでVirtualizingStackPanelを使っています。 VirtualizingStackPanel上では画面に必要なListViewItemしか作られません。そのおかげで大量に行を登録しても軽快に動くのですが、当然作られていないListViewItemにはアクセスできません。 ContainerFromIndexを呼んでもnullが返ってきます。

「どうすりゃいいの?」と少し試したところ、ListView.ScrollIntoViewメソッドを使えば、副作用として作られていないListViewItemがすぐに用意されることが分かりました。しかし、そのListViewItemはそのまま使える状態ではありません。デバッガでそれをよく見るとIsLoadedがfalseになってました。ってことでLoadedイベントで使える状態になるのを待つことに。こんなコードで目的のListViewItemにアクセスすることができました。

int i = ?; ←処理対象の行番号を入れる

var listViewItem = listView.ItemContainerGenerator.ContainerFromIndex(i) as ListViewItem;
if (listViewItem == null)
{
    var items = listView.ItemsSource as ObservableCollection<Data>;
    listView.ScrollIntoView(items[i]);
    listViewItem = listView.ItemContainerGenerator.ContainerFromIndex(i) as ListViewItem;

    RoutedEventHandler handler = null;
    handler = (object hs, RoutedEventArgs he) =>
             {
                 <<listViewItemに対する処理を実行>>
                 
                 listViewItem.Loaded -= handler;
             };
    listViewItem.Loaded += handler;
}
else
{
    <<listViewItemに対する処理を実行>>
}

ListViewItemから子コントロールを探すのはmsdnに載ってるとおり...

msdn ... 方法 : DataTemplate によって生成された要素を検索する

ではダメでした。これはListBox用のコードで、ListViewに対して使うとDataTemplate.FindNameが上手くいきません。デバッグ画面からWPFツリービジュアライザーを見てみると、

どうやらデフォルトテンプレートだとGridViewRowPresenterの子として列の数だけContentPresenterが作られるようですね。 msdnの通りにやると1つ目のContentPresenterしか得られません。それで別の列のGridViewColumn.CellTemplateから1列目のContentPresenterに対してFindNameしてしまい失敗したのでしょう。これは対象の列のContentPresenterを探せばすぐに解決できます。ということで、ListViewItemの子から目的のコントロールを探すコードはこんな感じ(デフォルトテンプレートの場合)。

int columnNumber = ?; ←対象の列番号を入れる
var rowPresenter = FindVisualChild<GridViewRowPresenter>(listViewItem);
var cellPresenter = VisualTreeHelper.GetChild(rowPresenter, columnNumber) as ContentPresenter;
var template = rowPresenter.Columns[columnNumber].CellTemplate;
var ctrl = template.FindName("コントロール名", cellPresenter) as コントロールの型;
<<コントロールに対する処理を実行>>

これで目的のコードが実行できます。

ちなみに、FindVisualChildメソッドの中身は参考にしたmsdnのページの通りです。

動作確認用の簡単なサンプルプログラムを作りました。サンプルの動作は、行指定のTextBoxに行数を入れてその右のスクロールボタンをクリックするとListViewのその行までスクロールして「文章」列のTextBoxにフォーカスを当てます。

以下、コードです。まずはMainWindow.xamlから。

<Window x:Class="ListViewItemFocusSample.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525">
    <DockPanel>
        <StackPanel DockPanel.Dock="Top" Orientation="Horizontal">
            <Label>行指定</Label>
            <TextBox Name="textBox" Width="60" MaxLength="4"></TextBox>
            <Button Click="ButtonClickHandler">スクロール</Button>
        </StackPanel>
        <ListView
                Name="listView"
                VirtualizingStackPanel.VirtualizationMode="Recycling"
        >
            <ListView.ItemContainerStyle>
                <Style TargetType="ListViewItem">
                    <Setter Property="HorizontalContentAlignment" Value="Stretch" />
                    <Style.Triggers>
                        <Trigger Property="IsKeyboardFocusWithin" Value="true">
                            <Setter Property="IsSelected" Value="true" />
                        </Trigger>
                    </Style.Triggers>
                </Style>
            </ListView.ItemContainerStyle>
            <ListView.View>
                <GridView>
                    <GridViewColumn Width="40">
                        <GridViewColumnHeader Content="No"/>
                        <GridViewColumn.CellTemplate>
                            <DataTemplate>
                                <TextBlock Text="{Binding Path=Number, Mode=OneWay}" HorizontalAlignment="Stretch" TextAlignment="Center"/>
                            </DataTemplate>
                        </GridViewColumn.CellTemplate>
                    </GridViewColumn>
                    <GridViewColumn Width="400">
                        <GridViewColumnHeader Content="文章"/>
                        <GridViewColumn.CellTemplate>
                            <DataTemplate>
                                <TextBox Name="listViewItemTextBox" Text="{Binding Path=Text, UpdateSourceTrigger=PropertyChanged}"/>
                            </DataTemplate>
                        </GridViewColumn.CellTemplate>
                    </GridViewColumn>
                </GridView>
            </ListView.View>
        </ListView>
    </DockPanel>
</Window>

MainWindow.xaml.csです。

using System.Collections.ObjectModel;
using System.Linq;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;

namespace ListViewItemFocusSample
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();

            var query = from i in Enumerable.Range(0, 2000)
                        select new Data(i, "text" + i.ToString("D04"));

            listView.ItemsSource = new ObservableCollection<Data>(query);
        }

        private void ButtonClickHandler(object sender, RoutedEventArgs e)
        {
            int i = 0;
            int.TryParse(textBox.Text, out i);
            if (i < 0)
                i = 0;
            if (listView.Items.Count <= i)
                i = listView.Items.Count - 1;

            var listViewItem = listView.ItemContainerGenerator.ContainerFromIndex(i) as ListViewItem;
            if (listViewItem == null)
            {
                var items = listView.ItemsSource as ObservableCollection<Data>;
                listView.ScrollIntoView(items[i]);
                listViewItem = listView.ItemContainerGenerator.ContainerFromIndex(i) as ListViewItem;

                RoutedEventHandler handler = null;
                handler = (object hs, RoutedEventArgs he) =>
                         {
                             FocusListViewItemsTextBox(listViewItem);
                             listViewItem.Loaded -= handler;
                         };
                listViewItem.Loaded += handler;
            }
            else
            {
                FocusListViewItemsTextBox(listViewItem);
            }
        }

        private void FocusListViewItemsTextBox(ListViewItem item)
        {
            int columnNumber = 1;
            var rowPresenter = FindVisualChild<GridViewRowPresenter>(item);
            var cellPresenter = VisualTreeHelper.GetChild(rowPresenter, columnNumber) as ContentPresenter;
            var template = rowPresenter.Columns[columnNumber].CellTemplate;
            var lviTextBox = template.FindName("listViewItemTextBox", cellPresenter) as TextBox;
            lviTextBox.Focus();
        }

        private T FindVisualChild<T>(DependencyObject obj)
            where T : DependencyObject
        {
            for (int i = VisualTreeHelper.GetChildrenCount(obj) - 1; 0 <= i ; i--)
            {
                var child = VisualTreeHelper.GetChild(obj, i);
                if (child != null && child is T)
                {
                    return child as T;
                }
                else
                {
                    var c = FindVisualChild<T>(child);
                    if (c != null)
                    {
                        return c;
                    }
                }
            }
            return null;
        }
    }
}

データ用のクラスは簡単なものです。

namespace ListViewItemFocusSample
{
    public class Data
    {
        public Data(int number, string text)
        {
            Number = number;
            Text = text;
        }

        public int Number { get; set; }
        public string Text { get; set; }
    }
}

一応、ツリービジュアライザーの説明へのリンクも貼っておきます。

msdn ... 方法 : WPFツリービジュアライザーを使用する

片鱗懐古のブログ

2014年5月22日木曜日

wpf : ListViewItemのDataTemplateで作った子コントロールを探す

閲覧数が多い投稿

ラベル

広告

投稿した動画

ブログアーカイブ