Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

ItemsControl.DisplayMemberPath Property

.NET Framework 4.5

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Gets or sets a path to a value on the source object to serve as the visual representation of the object.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
C#
C++
F#
VB
Copy 

[BindableAttribute(true)]
public string DisplayMemberPath { get; set; }
XAML Attribute Usage
Copy 
<object DisplayMemberPath="string" .../>

Property Value

Type: System.String
The path to a value on the source object. This can be any path, or an XPath such as "@Name". The default is an empty string ("").

Identifier field

DisplayMemberPathProperty

Metadata properties set to true

None

This property is a simple way to define a default template that describes how to display the data objects.

In the following example, the static resource named places is defined as a collection of Place objects, in which each Place object has a CityName property and a State property. The prefix src is mapped to the namespace where the data source Places is defined. The prefixes scm and dat are mapped to the System.ComponentModel and System.Windows.Data namespaces, respectively.

The following example creates a view of the data collection that is sorted by the city name and grouped by the state.

XAML
Copy 

  <Window.Resources>

    <src:Places x:Key="places"/>

    <CollectionViewSource Source="{StaticResource places}" x:Key="cvs">
      <CollectionViewSource.SortDescriptions>
        <scm:SortDescription PropertyName="CityName"/>
      </CollectionViewSource.SortDescriptions>
      <CollectionViewSource.GroupDescriptions>
        <dat:PropertyGroupDescription PropertyName="State"/>
      </CollectionViewSource.GroupDescriptions>
    </CollectionViewSource>

The view can be a binding source, as in the following example. Because of the specified DisplayMemberPath, eachPlace object is shown with its CityName value. If DisplayMemberPath is not specified and there is no DataTemplate, then the ListBox displays a string representation of each object in the underlying collection (in this case, "SDKSample.Place").

XAML
Copy 

<ListBox ItemsSource="{Binding Source={StaticResource cvs}}"
         DisplayMemberPath="CityName" Name="lb">
  <ListBox.GroupStyle>
    <x:Static Member="GroupStyle.Default"/>
  </ListBox.GroupStyle>
</ListBox>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)