CollectionViewSource Класс

Определение

Предоставляет источник данных, который добавляет поддержку группирования и текущего элемента в классы коллекций.

public ref class CollectionViewSource sealed : DependencyObject
/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CollectionViewSource final : DependencyObject
[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CollectionViewSource : DependencyObject
Public NotInheritable Class CollectionViewSource
Inherits DependencyObject
<CollectionViewSource .../>
Наследование
Object Platform::Object IInspectable DependencyObject CollectionViewSource
Атрибуты

Примеры

Совет

Дополнительные сведения, рекомендации по проектированию и примеры кода см. в разделе Семантический масштаб.

Приложение "Коллекция WinUI 3" содержит интерактивные примеры большинства элементов управления, функций и функций WinUI 3. Получите приложение из Microsoft Store или получите исходный код в GitHub.

В следующем примере кода показано, как привязать элемент управления ListBox к результатам группирования запроса LINQ. В этом примере коллекция команд сгруппирована по городу и отображается с именем города в качестве заголовков группы. Полный список кода см. в примере привязки данных XAML.

<Grid>

  <Grid.Resources>
    <CollectionViewSource x:Name="groupInfoCVS" IsSourceGrouped="true"/>
  </Grid.Resources>

  <ListBox x:Name="lbGroupInfoCVS" 
    ItemsSource="{Binding Source={StaticResource groupInfoCVS}}">

    <ListBox.GroupStyle>
      <GroupStyle>
        <GroupStyle.HeaderTemplate>
          <DataTemplate>

            <TextBlock Text="{Binding Key}"/>

          </DataTemplate>
        </GroupStyle.HeaderTemplate>
      </GroupStyle>
    </ListBox.GroupStyle>

    <ListBox.ItemTemplate>
      <DataTemplate>

        <Border Background="{Binding Color}" 
          Width="200" CornerRadius="10" HorizontalAlignment="Left">

          <TextBlock Text="{Binding Name}" 
            Style="{StaticResource DescriptionTextStyle}" 
            HorizontalAlignment="Center" FontWeight="Bold"/>

        </Border>
      </DataTemplate>
    </ListBox.ItemTemplate>

  </ListBox>

</Grid>
Teams teams = new Teams();
var result = 
    from t in teams 
    group t by t.City into g 
    orderby g.Key 
    select g;
groupInfoCVS.Source = result;

Комментарии

Используйте CollectionViewSource, если требуется привязать элементы управления списками к коллекциям, но вы хотите отобразить эти коллекции в группах и сохранить текущий элемент независимо от элемента управления списком. Это особенно полезно, если требуется привязать несколько элементов управления к одной коллекции и требуется, чтобы текущий элемент в одном элементе управления изменил текущий элемент в других связанных элементах управления. Обычно collectionViewSource определяется как ресурс XAML и выполняется привязка к нему с помощью расширения разметки {StaticResource}. Затем можно задать для свойства Source в коде программной части поддерживаемый тип коллекции.

Все элементы управления, привязанные к одному и тому же объекту CollectionViewSource, всегда будут иметь один и тот же текущий элемент. Доступ к текущему элементу можно получить программным способом с помощью свойства ICollectionView.CurrentItem значения свойства CollectionViewSource.View .

Если элементы в коллекции являются самими коллекциями или объектами, содержащими коллекции, коллекции можно отобразить как группы в более крупной коллекции. Для этого присвойте свойству IsSourceGrouped значение true. Если элементы содержат коллекции, но не являются самими коллекциями, необходимо также задать для свойства ItemsPath имя свойства коллекции.

Примечание

Установка для свойства Source другого экземпляра CollectionViewSource не поддерживается.

Конструкторы

CollectionViewSource()

Инициализирует новый экземпляр класса CollectionViewSource .

Свойства

Dispatcher

Всегда возвращается null в приложении Windows App SDK. Вместо этого используйте DispatcherQueue .

(Унаследовано от DependencyObject)
DispatcherQueue

Возвращает объект , DispatcherQueue с которым связан данный объект. DispatcherQueue представляет объект, который может получить доступ к потоку DependencyObject пользовательского интерфейса, даже если код инициируется потоком, не относящегося к пользовательскому интерфейсу.

(Унаследовано от DependencyObject)
IsSourceGrouped

Возвращает или задает значение, указывающее, группируются ли исходные данные.

IsSourceGroupedProperty

Определяет свойство зависимости IsSourceGrouped .

ItemsPath

Возвращает или задает путь к свойству, который следует от элемента верхнего уровня для поиска групп в CollectionViewSource.

ItemsPathProperty

Определяет свойство зависимости ItemsPath .

Source

Возвращает или задает объект коллекции, из которого создается это представление.

SourceProperty

Идентифицирует свойство зависимостей Source .

View

Возвращает объект представления, связанный в данный момент с этим экземпляром CollectionViewSource.

ViewProperty

Идентифицирует свойство зависимостей View .

Методы

ClearValue(DependencyProperty)

Очищает локальное значение свойства зависимостей.

(Унаследовано от DependencyObject)
GetAnimationBaseValue(DependencyProperty)

Возвращает любое базовое значение, установленное для свойства зависимостей, которое применяется в случаях, когда анимация не активна.

(Унаследовано от DependencyObject)
GetValue(DependencyProperty)

Возвращает текущее действующее значение свойства зависимостей из DependencyObject.

(Унаследовано от DependencyObject)
ReadLocalValue(DependencyProperty)

Возвращает локальное значение свойства зависимостей, если задано локальное значение.

(Унаследовано от DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Регистрирует функцию уведомления для прослушивания изменений определенной DependencyProperty в этом экземпляре DependencyObject .

(Унаследовано от DependencyObject)
SetValue(DependencyProperty, Object)

Задает локальное значение свойства зависимостей для Объекта DependencyObject.

(Унаследовано от DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Отменяет уведомление об изменениях, которое было ранее зарегистрировано путем вызова метода RegisterPropertyChangedCallback.

(Унаследовано от DependencyObject)

Применяется к

См. также раздел