Virtualizing an ItemsControl?

by

There’s actually much more to it than just making the ItemsPanelTemplate use VirtualizingStackPanel. The default ControlTemplate for ItemsControl does not have a ScrollViewer, which is the key to virtualization. Adding to the the default control template for ItemsControl (using the control template for ListBox as a template) gives us the following:

<ItemsControl ItemsSource="{Binding AccountViews.Tables[0]}">
  <ItemsControl.ItemTemplate>
    <DataTemplate>
      <TextBlock Initialized="TextBlock_Initialized"
                 Text="{Binding Name}" />
    </DataTemplate>
  </ItemsControl.ItemTemplate>

  <ItemsControl.ItemsPanel>
    <ItemsPanelTemplate>
      <VirtualizingStackPanel IsVirtualizing="True"
                              VirtualizationMode="Recycling" />
    </ItemsPanelTemplate>
  </ItemsControl.ItemsPanel>

  <ItemsControl.Template>
    <ControlTemplate TargetType="ItemsControl">
      <Border BorderThickness="{TemplateBinding BorderThickness}"
              BorderBrush="{TemplateBinding BorderBrush}"
              Background="{TemplateBinding Background}">
        <ScrollViewer CanContentScroll="True" 
                      Padding="{TemplateBinding Padding}"
                      Focusable="False">
          <ItemsPresenter />
        </ScrollViewer>
      </Border>
    </ControlTemplate>
  </ItemsControl.Template>
</ItemsControl>

(BTW, a great tool for looking at default control templates is Show Me The Template)

Things to notice:

You have to set ScrollViewer.CanContentScroll="True", see here for why.

Also notice that I put VirtualizingStackPanel.VirtualizationMode="Recycling". This will reduce the numbers of times TextBlock_Initialized is called to however many TextBlocks are visible on the screen. You can read more on UI virtualization here
.

EDIT: Forgot to state the obvious: as an alternate solution, you can just replace ItemsControl with ListBox 🙂
Also, check out this Optimizing Performance on MSDN page and notice that ItemsControl isn’t in the “Controls That Implement Performance Features” table, which is why we need to edit the control template.

More Related Contents:

  1. How to dynamically add RowDefinition or ColumnDefinition to a Grid with binding?
  2. why setting ScrollViewer.CanContentScroll to false disable virtualization
  3. VirtualizingStackPanel + MVVM + multiple selection
  4. WPF VirtualizingStackPanel for increased performance
  5. WPF – Bind to Item Index from within ItemTemplate of ItemsControl?
  6. WPF ListBox with a ListBox – UI Virtualization and Scrolling
  7. Finding control within WPF itemscontrol
  8. WPF: ItemsControl with scrollbar (ScrollViewer)
  9. WPF Dynamic Layout with ItemsControl and Grid
  10. ItemsControl ItemTemplate Binding
  11. How to display search results in a WPF items control with highlighted query terms
  12. WrapPanel as ItemPanel for ItemsControl
  13. WPF ItemsControl the current ListItem Index in the ItemsSource
  14. How can I get ScrollViewer to work inside a StackPanel?
  15. Why are ActualWidth and ActualHeight 0.0 in this case?
  16. Looking for a WPF ComboBox with checkboxes
  17. Changing WPF title bar background color
  18. CommandManager.InvalidateRequerySuggested() isn’t fast enough. What can I do?
  19. Customizing the TreeView to allow multi select
  20. How to give the condition for EventTrigger?
  21. WPF MvvM DataGrid Dynamic Columns
  22. Why does WPF require a STAThread attribute to be applied to the Main method?
  23. WPF DataGrid : CanContentScroll property causing odd behavior
  24. WPF modeless dialog from MS Excel add-in
  25. Can you use a Binding ValidationRule within 1 line in xaml?
  26. MenuItem style with icon creates only one icon
  27. How do I group items in a WPF ListView
  28. How to automatically scale font size for a group of controls?
  29. WPF Editable ComboBox
  30. How to bind DataTemplate datatype to interface?

Leave a Comment