ListDetailsView Class

Definition

Namespace:

CommunityToolkit.WinUI.UI.Controls

Assembly:

CommunityToolkit.WinUI.UI.Controls.Layout.dll

Package:

CommunityToolkit.WinUI.UI.Controls.Layout v7.0.3

Panel that allows for a List/Details pattern.

[Microsoft.UI.Xaml.TemplatePart(Name="DetailsPresenter", Type=typeof(Microsoft.UI.Xaml.Controls.ContentPresenter))]
[Microsoft.UI.Xaml.TemplatePart(Name="DetailsPanel", Type=typeof(Microsoft.UI.Xaml.FrameworkElement))]
[Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="NoSelectionNarrow")]
[Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="NoSelectionWide")]
[Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="HasSelectionWide")]
[Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="HasSelectionNarrow")]
[Microsoft.UI.Xaml.TemplateVisualState(GroupName="WidthStates", Name="NarrowState")]
[Microsoft.UI.Xaml.TemplateVisualState(GroupName="WidthStates", Name="WideState")]
public class ListDetailsView : Microsoft.UI.Xaml.Controls.ItemsControl

[<Microsoft.UI.Xaml.TemplatePart(Name="DetailsPresenter", Type=typeof(Microsoft.UI.Xaml.Controls.ContentPresenter))>]
[<Microsoft.UI.Xaml.TemplatePart(Name="DetailsPanel", Type=typeof(Microsoft.UI.Xaml.FrameworkElement))>]
[<Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="NoSelectionNarrow")>]
[<Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="NoSelectionWide")>]
[<Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="HasSelectionWide")>]
[<Microsoft.UI.Xaml.TemplateVisualState(GroupName="SelectionStates", Name="HasSelectionNarrow")>]
[<Microsoft.UI.Xaml.TemplateVisualState(GroupName="WidthStates", Name="NarrowState")>]
[<Microsoft.UI.Xaml.TemplateVisualState(GroupName="WidthStates", Name="WideState")>]
type ListDetailsView = class
    inherit ItemsControl

Public Class ListDetailsView
Inherits ItemsControl

Inheritance

Microsoft.UI.Xaml.Controls.ItemsControl

ListDetailsView

Attributes

Microsoft.UI.Xaml.TemplatePartAttribute Microsoft.UI.Xaml.TemplateVisualStateAttribute

Constructors

ListDetailsView()

Initializes a new instance of the ListDetailsView class.

Fields

BackButtonBehaviorProperty	Identifies the BackButtonBehavior dependency property
CompactModeThresholdWidthProperty	Identifies the CompactModeThresholdWidth dependency property
DetailsCommandBarProperty	Identifies the DetailsCommandBar dependency property
DetailsHeaderProperty	Identifies the DetailsHeader dependency property.
DetailsHeaderTemplateProperty	Identifies the DetailsHeaderTemplate dependency property.
DetailsTemplateProperty	Identifies the DetailsTemplate dependency property.
ListCommandBarProperty	Identifies the ListCommandBar dependency property
ListHeaderProperty	Identifies the ListHeader dependency property.
ListHeaderTemplateProperty	Identifies the ListHeaderTemplate dependency property.
ListPaneBackgroundProperty	Identifies the ListPaneBackground dependency property.
ListPaneWidthProperty	Identifies the ListPaneWidth dependency property.
NoSelectionContentProperty	Identifies the NoSelectionContent dependency property.
NoSelectionContentTemplateProperty	Identifies the NoSelectionContentTemplate dependency property.
SelectedIndexProperty	Identifies the SelectedIndex dependency property.
SelectedItemProperty	Identifies the SelectedItem dependency property.
ViewStateProperty	Identifies the ViewState dependency property

Properties

BackButtonBehavior	Gets or sets the behavior to use for the back button
CompactModeThresholdWidth	Gets or sets the Threshold width that will trigger the control to go into compact mode
DetailsCommandBar	Gets or sets the Microsoft.UI.Xaml.Controls.CommandBar for the details section.
DetailsHeader	Gets or sets the content for the details pane's header
DetailsHeaderTemplate	Gets or sets the DataTemplate used to display the content of the details pane's header.
DetailsTemplate	Gets or sets the DataTemplate used to display the details.
ListCommandBar	Gets or sets the Microsoft.UI.Xaml.Controls.CommandBar for the list section.
ListHeader	Gets or sets the content for the list pane's header
ListHeaderTemplate	Gets or sets the DataTemplate used to display the content of the list pane's header.
ListPaneBackground	Gets or sets the Brush to apply to the background of the list area of the control.
ListPaneWidth	Gets or sets the width of the list pane when the view is expanded.
MapDetails	Gets or sets a function for mapping the selected item to a different model. This new model will be the DataContext of the Details area.
NoSelectionContent	Gets or sets the content to dsiplay when there is no item selected in the list list.
NoSelectionContentTemplate	Gets or sets the DataTemplate used to display the content when there is no selection.
SelectedIndex	Gets or sets the index of the current selection.
SelectedItem	Gets or sets the selected item.
ViewState	Gets the current visual state of the control

Methods

OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.

Events

SelectionChanged	Occurs when the currently selected item changes.
ViewStateChanged	Occurs when the view state changes

See also

• <xref:Microsoft.UI.Xaml.Controls.ItemsControl>