WPF/C# Binding custom object list data to a ListBox?

Question

I've ran into a bit of a wall with being able to bind data of my custom object list to a ListBox in WPF.

This is the custom object:

public class FileItem
{
    public string Name { get; set; }
    public string Path { get; set; }
}

And this is the list:

private List<FileItem> folder = new List<FileItem>();
public List<FileItem> Folder { get { return folder; } }

The list gets populated and maintained by a FileSystemWatcher as files get moved around, deleted, renamed, etc. All the list does is keeps tracks of names and paths.

Here's what I have in the MainWindow code-behind file (it's hard coded for testing purposes for now):

FolderWatcher folder1 = new FolderWatcher();
folder1.Run(@"E:\MyApp\test", "*.txt");

listboxFolder1.ItemsSource = folder1.Folder;

Here's my XAML portion:

<ListBox x:Name="listboxFolder1" Grid.Row="1" BorderThickness="0" 
         ItemsSource="{Binding}"/>

Unfortunately, the only thing that gets displayed is MyApp.FileItem for every entry. How do I display the specific property such as name?

Nitin Purohit · Accepted Answer · 2013-09-09 07:01:42Z

45

You will need to define the ItemTemplate for your ListBox

    <ListBox x:Name="listboxFolder1" Grid.Row="1" BorderThickness="0" 
     ItemsSource="{Binding}">
       <ListBox.ItemTemplate>
         <DataTemplate>
           <TextBlock Text="{Binding Name}"/>
         </DataTemplate>
       </ListBox.ItemTemplate>
     </ListBox>

answered Sep 9, 2013 at 7:01

Nitin Purohit

18.6k2 gold badges39 silver badges53 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Sayse · Accepted Answer · 2013-09-09 07:00:22Z

22

The easiest way is to override ToString on your FileItem, (The listbox uses this to populate each entry)

    public override string ToString()
    {
        return Name;
    }

answered Sep 9, 2013 at 7:00

Sayse

43.4k14 gold badges85 silver badges150 bronze badges

2 Comments

B.K. Over a year ago

Thank you, it works. I liked XAML version better, but this one did the job as well and like you said -- it's simple. I just wanted to keep ToString() open for other things that may require return of path name or a combination of.

Sayse Over a year ago

The difference is this will work when showing multiple list boxes :) no worries

Omri Btian · Accepted Answer · 2013-09-09 07:11:40Z

10

Each item in the list that ListBox shows automatically calls the ToString method to display it, and since you didn't override it, it displays the name of the type.

So, there are two things you can do here.

Override the ToString method like Sayse suggested.
Use DataTemplate and bind each of your properties seperatly

In your resource add the template with a key

        <DataTemplate x:Key="fileItemTemplate">
            <StackPanel>
                <TextBlock Text="{Binding Name}"/>
                <TextBlock Text="{Binding Path}"/>
            </StackPanel>
        </DataTemplate>

and give it as your listbox ItemTemplate

<ListBox x:Name="listboxFolder1" Grid.Row="1" BorderThickness="0"  ItemsSource="{Binding}" ItemTemplate="{StaticResource fileItemTemplate}">

edited Sep 9, 2013 at 7:11

answered Sep 9, 2013 at 7:05

Omri Btian

6,5574 gold badges42 silver badges67 bronze badges

1 Comment

B.K. Over a year ago

Thank you very much for the link, that guy knows how to explain things clearly.

amb9800 · Accepted Answer · 2016-08-16 05:10:39Z

4

In case anyone comes across this now via search, I just encountered pretty much the same issue in a C# UWP app.

While the XAML bits in Nitin's answer above were necessary, they didn't fix the issue alone -- I also had to change my equivalent of Folder to be an ObservableCollection, rather than a List, to get the ListBox to show the property I needed.

answered Aug 16, 2016 at 5:10

amb9800

3852 gold badges5 silver badges14 bronze badges

Collectives™ on Stack Overflow

WPF/C# Binding custom object list data to a ListBox?

4 Answers 4

Comments

2 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

2 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related