Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ListDetailsView Two-pane view documentation update #559

Merged
merged 3 commits into from
Sep 17, 2021
Merged

ListDetailsView Two-pane view documentation update #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6caed3
ListDetailsView documentation update
COM8 Aug 23, 2021
99aa708
Fixed additional <Members> Tag
COM8 Aug 23, 2021
bc134c8
Relative link for Two-Pane view
COM8 Aug 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/controls/MasterDetailsView.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,18 @@ The [ListDetailsView](/dotnet/api/microsoft.toolkit.uwp.ui.controls.listdetailsv
ItemTemplate="{StaticResource ListTemplate}"
DetailsTemplate="{StaticResource DetailsTemplate}"
NoSelectionContentTemplate="{StaticResource NoSelectionContentTemplate}"
CompactModeThresholdWidth="720" />
CompactModeThresholdWidth="640" />
```

## Sample Output

![ListDetailsView animation](../resources/images/Controls/ListDetailsView.gif)

## Multi Screen Devices

This control is spanning-aware and adapts it self for multi screen devices.
For this internally the [Two-pane view](/windows/uwp/design/controls-and-patterns/two-pane-view) is used.

## BackButtonBehavior

When in compact mode, the `ListDetailsView` will either show the List or the Details view, not both. If an item is selected, the control will *navigate* forward to the Details view. If the CurrentItem is set to `null`, the control will navigate *back* to the List view.
Expand Down
10 changes: 10 additions & 0 deletions dotnet/xml/FrameworksIndex/win-comm-toolkit-dotnet-7.0.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6296,6 +6296,11 @@
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.SelectedIndexProperty" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.SelectedItemProperty" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ViewStateProperty" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackgroundProperty" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelectorProperty" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentProperty" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplateProperty" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelectorProperty" />
<Member Id="M:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.#ctor" />
<Member Id="M:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.OnApplyTemplate" />
<Member Id="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.BackButtonBehavior" />
Expand All @@ -6315,6 +6320,11 @@
<Member Id="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.SelectedIndex" />
<Member Id="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.SelectedItem" />
<Member Id="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ViewState" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate" />
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector" />
</Type>
<Type Name="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsViewState" Id="T:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsViewState">
<Member Id="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsViewState.Both" />
Expand Down
227 changes: 227 additions & 0 deletions dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/ListDetailsView.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -876,5 +876,232 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DetailsPaneBackground">
<MemberSignature Language="C#" Value="public Windows.UI.Xaml.Media.Brush DetailsPaneBackground { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Windows.UI.Xaml.Media.Brush DetailsPaneBackground" />
<MemberSignature Language="DocId" Value="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground" />
<MemberSignature Language="VB.NET" Value="Public Property DetailsPaneBackground As Brush" />
<MemberSignature Language="F#" Value="member this.DetailsPaneBackground : Windows.UI.Xaml.Media.Brush with get, set" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.Media.Brush</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Brush to apply to the background of the list area of the control.
</summary>
<value>The Brush to apply to the background of the list area of the control.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DetailsPaneBackgroundProperty">
<MemberSignature Language="C#" Value="public static readonly Windows.UI.Xaml.DependencyProperty DetailsPaneBackgroundProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class Windows.UI.Xaml.DependencyProperty DetailsPaneBackgroundProperty" />
<MemberSignature Language="DocId" Value="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackgroundProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly DetailsPaneBackgroundProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable DetailsPaneBackgroundProperty : Windows.UI.Xaml.DependencyProperty" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackgroundProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>
Identifies the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground" /> dependency property.
</summary>
<returns>The identifier for the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground" /> dependency property.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListPaneNoItemsContent">
<MemberSignature Language="C#" Value="public object ListPaneNoItemsContent { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object ListPaneNoItemsContent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent" />
<MemberSignature Language="VB.NET" Value="Public Property ListPaneNoItemsContent As Object" />
<MemberSignature Language="F#" Value="member this.ListPaneNoItemsContent : obj with get, set" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the content to dsiplay when there is no item selected in the list list.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListPaneNoItemsContentProperty">
<MemberSignature Language="C#" Value="public static readonly Windows.UI.Xaml.DependencyProperty ListPaneNoItemsContentProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class Windows.UI.Xaml.DependencyProperty ListPaneNoItemsContentProperty" />
<MemberSignature Language="DocId" Value="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ListPaneNoItemsContentProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable ListPaneNoItemsContentProperty : Windows.UI.Xaml.DependencyProperty" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>
Identifies the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent" /> dependency property.
</summary>
<returns>The identifier for the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent" /> dependency property.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListPaneNoItemsContentTemplate">
<MemberSignature Language="C#" Value="public Windows.UI.Xaml.DataTemplate ListPaneNoItemsContentTemplate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Windows.UI.Xaml.DataTemplate ListPaneNoItemsContentTemplate" />
<MemberSignature Language="DocId" Value="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate" />
<MemberSignature Language="VB.NET" Value="Public Property ListPaneNoItemsContentTemplate As DataTemplate" />
<MemberSignature Language="F#" Value="member this.ListPaneNoItemsContentTemplate : Windows.UI.Xaml.DataTemplate with get, set" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.DataTemplate</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the DataTemplate used to display the content when there is no selection.
</summary>
<value>
The template that specifies the visualization of the content when there is no
selection. The default is null.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListPaneNoItemsContentTemplateProperty">
<MemberSignature Language="C#" Value="public static readonly Windows.UI.Xaml.DependencyProperty ListPaneNoItemsContentTemplateProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class Windows.UI.Xaml.DependencyProperty ListPaneNoItemsContentTemplateProperty" />
<MemberSignature Language="DocId" Value="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplateProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ListPaneNoItemsContentTemplateProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable ListPaneNoItemsContentTemplateProperty : Windows.UI.Xaml.DependencyProperty" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplateProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>
Identifies the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate" /> dependency property.
</summary>
<returns>The identifier for the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate" /> dependency property.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DetailsContentTemplateSelector">
<MemberSignature Language="C#" Value="public Windows.UI.Xaml.Controls.DataTemplateSelector DetailsContentTemplateSelector { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Windows.UI.Xaml.Controls.DataTemplateSelector DetailsContentTemplateSelector" />
<MemberSignature Language="DocId" Value="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector" />
<MemberSignature Language="VB.NET" Value="Public Property DetailsContentTemplateSelector As DataTemplate" />
<MemberSignature Language="F#" Value="member this.DetailsContentTemplateSelector : Windows.UI.Xaml.Controls.DataTemplateSelector with get, set" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.Controls.DataTemplateSelector</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the DataTemplateSelector used to select the DataTemplate for the current details content.
</summary>
<value>
The selector which selects the correct template for the current content. The default is null.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DetailsContentTemplateSelectorProperty">
<MemberSignature Language="C#" Value="public static readonly Windows.UI.Xaml.DependencyProperty DetailsContentTemplateSelectorProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class Windows.UI.Xaml.DependencyProperty DetailsContentTemplateSelectorProperty" />
<MemberSignature Language="DocId" Value="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelectorProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly DetailsContentTemplateSelectorProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable DetailsContentTemplateSelectorProperty : Windows.UI.Xaml.DependencyProperty" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelectorProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>
Identifies the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector" /> dependency property.
</summary>
<returns>The identifier for the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector" /> dependency property.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListPaneItemTemplateSelector">
<MemberSignature Language="C#" Value="public Windows.UI.Xaml.Controls.DataTemplateSelector ListPaneItemTemplateSelector { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Windows.UI.Xaml.Controls.DataTemplateSelector ListPaneItemTemplateSelector" />
<MemberSignature Language="DocId" Value="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector" />
<MemberSignature Language="VB.NET" Value="Public Property ListPaneItemTemplateSelector As DataTemplate" />
<MemberSignature Language="F#" Value="member this.ListPaneItemTemplateSelector : Windows.UI.Xaml.Controls.DataTemplateSelector with get, set" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.Controls.DataTemplateSelector</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the DataTemplateSelector used to select the DataTemplate for the current list entry content.
</summary>
<value>
The selector which selects the correct template for the current content. The default is null.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListPaneItemTemplateSelectorProperty">
<MemberSignature Language="C#" Value="public static readonly Windows.UI.Xaml.DependencyProperty ListPaneItemTemplateSelectorProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class Windows.UI.Xaml.DependencyProperty ListPaneItemTemplateSelectorProperty" />
<MemberSignature Language="DocId" Value="F:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelectorProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ListPaneItemTemplateSelectorProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable ListPaneItemTemplateSelectorProperty : Windows.UI.Xaml.DependencyProperty" Usage="Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelectorProperty" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp.UI.Controls.Layout</AssemblyName>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.UI.Xaml.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>
Identifies the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector" /> dependency property.
</summary>
<returns>The identifier for the <see cref="P:Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector" /> dependency property.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>