ListBox Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Contains a list of selectable items.
Inheritance Hierarchy
System.Object
System.Windows.DependencyObject
System.Windows.UIElement
System.Windows.FrameworkElement
System.Windows.Controls.Control
System.Windows.Controls.ItemsControl
System.Windows.Controls.Primitives.Selector
System.Windows.Controls.ListBox
Microsoft.Internal.Pivot.Controls.SuggestionListBox
Namespace: System.Windows.Controls
Assembly: System.Windows (in System.Windows.dll)
Syntax
'Declaration
<TemplateVisualStateAttribute(Name := "InvalidFocused", GroupName := "ValidationStates")> _
<TemplatePartAttribute(Name := "ScrollViewer", Type := GetType(ScrollViewer))> _
<TemplateVisualStateAttribute(Name := "InvalidUnfocused", GroupName := "ValidationStates")> _
<TemplateVisualStateAttribute(Name := "Valid", GroupName := "ValidationStates")> _
Public Class ListBox _
Inherits Selector
[TemplateVisualStateAttribute(Name = "InvalidFocused", GroupName = "ValidationStates")]
[TemplatePartAttribute(Name = "ScrollViewer", Type = typeof(ScrollViewer))]
[TemplateVisualStateAttribute(Name = "InvalidUnfocused", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "Valid", GroupName = "ValidationStates")]
public class ListBox : Selector
<ListBox .../>
The ListBox type exposes the following members.
Properties
Name | Description | |
---|---|---|
ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) | |
ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) | |
AllowDrop | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.) | |
Background | Gets or sets a brush that provides the background of the control. (Inherited from Control.) | |
BorderBrush | Gets or sets a brush that describes the border background of a control. (Inherited from Control.) | |
BorderThickness | Gets or sets the border thickness of a control. (Inherited from Control.) | |
CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) | |
CharacterSpacing | Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.) | |
Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) | |
Cursor | Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.) | |
DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) | |
DefaultStyleKey | Gets or sets the key that references the default style for the control. (Inherited from Control.) | |
DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) | |
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) | |
DisplayMemberPath | Gets or sets the name or path of the property that is displayed for each data item. (Inherited from ItemsControl.) | |
Effect | Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.) | |
FlowDirection | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.) | |
FontFamily | Gets or sets the font used to display text in the control. (Inherited from Control.) | |
FontSize | Gets or sets the size of the text in this control. (Inherited from Control.) | |
FontStretch | Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.) | |
FontStyle | Gets or sets the style in which the text is rendered. (Inherited from Control.) | |
FontWeight | Gets or sets the thickness of the specified font. (Inherited from Control.) | |
Foreground | Gets or sets a brush that describes the foreground color. (Inherited from Control.) | |
HasItems | Gets whether the Selector contains items. (Inherited from Selector.) | |
Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) | |
HorizontalAlignment | Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.) | |
HorizontalContentAlignment | Gets or sets the horizontal alignment of the control's content. (Inherited from Control.) | |
IsEnabled | Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control.) | |
IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) | |
IsSynchronizedWithCurrentItem | Gets or sets a value that indicates whether the Selector should keep the SelectedItem synchronized with the current item in the Items property. (Inherited from Selector.) | |
IsTabStop | Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.) | |
ItemContainerGenerator | Gets the ItemContainerGenerator associated with this ItemsControl. (Inherited from ItemsControl.) | |
ItemContainerStyle | Gets or sets the style that is used when rendering the item containers. | |
Items | Gets the collection used to generate the content of the control. (Inherited from ItemsControl.) | |
ItemsPanel | Gets or sets the template that defines the panel that controls the layout of items. (Inherited from ItemsControl.) | |
ItemsSource | Gets or sets a collection used to generate the content of the ItemsControl. (Inherited from ItemsControl.) | |
ItemTemplate | Gets or sets the DataTemplate used to display each item. (Inherited from ItemsControl.) | |
Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) | |
Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) | |
MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
MaxWidth | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
MinHeight | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
MinWidth | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) | |
Name | Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.) | |
Opacity | Gets or sets the degree of the object's opacity. (Inherited from UIElement.) | |
OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.) | |
Padding | Gets or sets the padding inside a control. (Inherited from Control.) | |
Parent | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.) | |
Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) | |
RenderSize | Gets the final render size of a UIElement. (Inherited from UIElement.) | |
RenderTransform | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.) | |
RenderTransformOrigin | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.) | |
Resources | Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.) | |
SelectedIndex | Gets or sets the index of the selected item. (Inherited from Selector.) | |
SelectedItem | Gets or sets the selected item. (Inherited from Selector.) | |
SelectedItems | Gets the list of currently selected items for the ListBox control. | |
SelectedValue | Gets or sets the value of the selected item, obtained by using the SelectedValuePath. (Inherited from Selector.) | |
SelectedValuePath | Gets or sets the property path that is used to get the SelectedValue property of the SelectedItem property. (Inherited from Selector.) | |
SelectionMode | Gets or sets the selection behavior for the ListBox control. | |
Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) | |
TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.) | |
TabNavigation | Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.) | |
Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) | |
Template | Gets or sets a control template. (Inherited from Control.) | |
Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) | |
UseLayoutRounding | Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.) | |
VerticalAlignment | Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.) | |
VerticalContentAlignment | Gets or sets the vertical alignment of the control's content. (Inherited from Control.) | |
Visibility | Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.) | |
Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
Top
Methods
Name | Description | |
---|---|---|
AddHandler | Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.) | |
ApplyTemplate | Loads the relevant control template so that its parts can be referenced. (Inherited from Control.) | |
Arrange | Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.) | |
ArrangeOverride | Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.) | |
CaptureMouse | Sets mouse capture to a UIElement. (Inherited from UIElement.) | |
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) | |
ClearContainerForItemOverride | Removes any bindings and templates applied to the item container for the specified content. (Inherited from Selector.) | |
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) | |
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) | |
Focus | Attempts to set the focus on the control. (Inherited from Control.) | |
GetAnimationBaseValue | Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) | |
GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) | |
GetContainerForItemOverride | Creates or identifies the element used to display a specified item. (Overrides ItemsControl.GetContainerForItemOverride().) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetTemplateChild | Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) | |
InvalidateArrange | Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.) | |
InvalidateMeasure | Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.) | |
IsItemItsOwnContainerOverride | Determines if the specified item is (or is eligible to be) its own item container. (Overrides ItemsControl.IsItemItsOwnContainerOverride(Object).) | |
Measure | Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.) | |
MeasureOverride | Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnApplyTemplate | Builds the visual tree for the ListBox control when a new template is applied. (Overrides Selector.OnApplyTemplate().) | |
OnCreateAutomationPeer | Returns a ListBoxAutomationPeer for the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().) | |
OnDoubleTap | Called before the DoubleTap event occurs. (Inherited from Control.) | |
OnDragEnter | Called before the DragEnter event occurs. (Inherited from Control.) | |
OnDragLeave | Called before the DragLeave event occurs. (Inherited from Control.) | |
OnDragOver | Called before the DragOver event occurs. (Inherited from Control.) | |
OnDrop | Called before the Drop event occurs. (Inherited from Control.) | |
OnGotFocus | Provides handling for the GotFocus event. (Overrides Control.OnGotFocus(RoutedEventArgs).) | |
OnHold | Called before the Hold event occurs. (Inherited from Control.) | |
OnItemsChanged | Provides handling for the ItemsChanged event. (Overrides Selector.OnItemsChanged(NotifyCollectionChangedEventArgs).) | |
OnKeyDown | Provides handling for the KeyDown event that occurs when a key is pressed while the control has focus. (Overrides Control.OnKeyDown(KeyEventArgs).) | |
OnKeyUp | Called before the KeyUp event occurs. (Inherited from Control.) | |
OnLostFocus | Provides handling for the LostFocus event. (Overrides Control.OnLostFocus(RoutedEventArgs).) | |
OnLostMouseCapture | Called before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.) | |
OnManipulationCompleted | Called before the ManipulationCompleted event occurs. (Inherited from Control.) | |
OnManipulationDelta | Called before the ManipulationDelta event occurs. (Inherited from Control.) | |
OnManipulationStarted | Called before the ManipulationStarted event occurs. (Inherited from Control.) | |
OnMouseEnter | Called before the MouseEnter event occurs. (Inherited from Control.) | |
OnMouseLeave | Called before the MouseLeave event occurs. (Inherited from Control.) | |
OnMouseLeftButtonDown | Called before the MouseLeftButtonDown event occurs. (Inherited from Control.) | |
OnMouseLeftButtonUp | Called before the MouseLeftButtonUp event occurs. (Inherited from Control.) | |
OnMouseMove | Called before the MouseMove event occurs. (Inherited from Control.) | |
OnMouseRightButtonDown | Called before the MouseRightButtonDown event occurs. (Inherited from Control.) | |
OnMouseRightButtonUp | Called before the MouseRightButtonUp event occurs. (Inherited from Control.) | |
OnMouseWheel | Called before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.) | |
OnTap | Called before the Tap event occurs. (Inherited from Control.) | |
OnTextInput | Called before the TextInput event occurs. (Inherited from ItemsControl.) In Silverlight for Windows Phone Windows Phone OS 7.1, this member is inherited from Control.OnTextInput(TextCompositionEventArgs). |
|
OnTextInputStart | Called before the TextInputStart event occurs. (Inherited from Control.) | |
OnTextInputUpdate | Called before the TextInputUpdate event occurs. (Inherited from Control.) | |
PrepareContainerForItemOverride | Prepares the specified element to display the specified item. (Inherited from Selector.) | |
ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) | |
ReleaseMouseCapture | Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.) | |
RemoveHandler | Removes the specified routed event handler from this UIElement. (Inherited from UIElement.) | |
ScrollIntoView | Causes the object to scroll into view. | |
SelectAll | Selects all the items in the ListBox. | |
SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) | |
SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.) | |
UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.) |
Top
Events
Name | Description | |
---|---|---|
BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) | |
DataContextChanged | Occurs when the data context for this element changes. (Inherited from FrameworkElement.) | |
DoubleTap | Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.) | |
DragEnter | Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.) | |
DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.) | |
DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.) | |
Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.) | |
GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement.) | |
Hold | Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.) | |
IsEnabledChanged | Occurs when the IsEnabled property changes. (Inherited from Control.) | |
KeyDown | Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.) | |
KeyUp | Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.) | |
LayoutUpdated | Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.) | |
Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) | |
LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) | |
LostMouseCapture | Occurs when the UIElement loses mouse capture. (Inherited from UIElement.) | |
ManipulationCompleted | Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.) | |
ManipulationDelta | Occurs when the input device changes position during a manipulation. (Inherited from UIElement.) | |
ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.) | |
MediaCommand | Occurs when a button is pressed on a remote control. (Inherited from UIElement.) | |
MouseEnter | Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.) | |
MouseLeave | Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.) | |
MouseLeftButtonDown | Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.) | |
MouseLeftButtonUp | Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) | |
MouseMove | Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) | |
MouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.) | |
MouseRightButtonUp | Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.) | |
MouseWheel | Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.) | |
SelectionChanged | Occurs when the currently selected item changes. (Inherited from Selector.) | |
SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) | |
Tap | Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.) | |
TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) | |
TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) | |
TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) | |
Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
Top
Fields
Name | Description | |
---|---|---|
IsSelectionActiveProperty | Identifies the IsSelectionActive dependency property. | |
ItemContainerStyleProperty | Identifies the ItemContainerStyle dependency property. | |
SelectionModeProperty | Identifies the SelectionMode dependency property. |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
ISupportInitialize.BeginInit | Signals the object that initialization is starting. (Inherited from Selector.) | |
ISupportInitialize.EndInit | Signals the object that initialization is complete. (Inherited from Selector.) |
Top
Remarks
ListBox is a control that displays a collection of items. More than one item in a ListBox is visible at a time. You specify whether the ListBox allows multiple selections by using the SelectionMode property.
ListBox is an ItemsControl. You set its content by using the Items or ItemsSource properties. For more information about content models, see Control Content Models. You can either populate the ListBox control directly, or bind it to a collection of items. For more information about populating a ListBox, see How to: Display Data in a ListBox.
The following illustration shows a ListBox control that contains some unbound text items.
Customizing the ListBox Control
To apply the same property settings to multiple ListBox controls, use the Style property. You can apply a style to each item displayed in the ListBox by setting the ItemContainerStyle property. To change the visual structure and visual behavior of a ListBox, copy and modify its default style and template. For more information, see Control Customization.
Dependency properties for this control might be set by the default style of the control. If a dependency property for a ListBox is set by its default style, the property might change from its default value when the ListBox appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for ListBox from ListBox Styles and Templates.
Note: |
---|
Setting a visual property will only have an effect if that property is both present in ListBox control's default template and is set by using a TemplateBinding. You can find a list of visual properties in the "Changing the Visual Structure of a Control" section of Customizing the Appearance of an Existing Control by Using a ControlTemplate. |
Version Notes
Silverlight for Windows Phone
Scrolling performance improvements have been made for the ListBox control in Windows Phone OS 7.1, which affect how some ScrollViewer properties are updated and when events occur. The following table describes the differences in behavior for Windows Phone OS 7.0 and Windows Phone OS 7.1.
Behavior |
Windows Phone OS 7.0 app/Windows Phone OS 7.0 device |
Windows Phone OS 7.0 or Windows Phone OS 7.1 app/Windows Phone OS 7.1 device |
---|---|---|
ScrollViewer properties are updated on the UI thread during scrolling. |
Properties updated as soon as values change. |
Properties updated when the user lifts their finger or when the user drags, pans or flicks ¼ of the screen, in any direction. |
ManipulationDelta events raised on UI thread when dragging inside of a ScrollViewer. |
Events are available for handling by elements in the ScrollViewer. |
Events are not raised since they are on the input thread. |
If your application depends on the Windows Phone OS 7.0 behavior, you can opt out of the performance improvements by setting the ManipulationMode property on the ScrollViewer associated with the ListBox to Control. The following code example shows how to do this.
<ListBox ItemsSource="{Binding Items}" ScrollViewer.ManipulationMode ="Control" Height="652" Canvas.Top="80">
Examples
The following code example creates a page with several ListBox controls configured in a variety of ways.
<UserControl x:Class="ListBoxSnippetEx.Page"
xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
xmlns:src="clr-namespace:ListBoxSnippetEx"
>
<StackPanel x:Name="LayoutRoot" Background="White" Margin="10,10,10,10">
<StackPanel Orientation="Horizontal" >
<TextBlock Margin="5" Text="ListBox with unbound data:" />
<ListBox Width="150" Margin="0,5,0,10">
<TextBlock Text="TextBlock" />
<TextBox Text="TextBox" />
<Button Content="Button" />
<Rectangle Fill="LightBlue" Height="20" Width="100" Margin="2,2,2,2"/>
<Ellipse Fill="Coral" Height="20" Width="150" Margin="2,2,2,2"/>
</ListBox>
<TextBlock Margin="5" Text="ListBox with bound data:" />
<Grid>
<Grid.Resources>
<src:Customers x:Key="customers"/>
</Grid.Resources>
<ListBox ItemsSource="{StaticResource customers}" Width="250" Margin="0,5,0,10"
DisplayMemberPath="LastName"/>
</Grid>
</StackPanel>
<StackPanel Orientation="Horizontal" >
<TextBlock Margin="5" Text="ListBox with ItemTemplate:" Width="160" />
<Grid>
<Grid.Resources>
<src:Customers x:Key="customers"/>
</Grid.Resources>
<ListBox ItemsSource="{StaticResource customers}" Width="350" Margin="0,5,0,10">
<ListBox.ItemTemplate>
<DataTemplate>
<StackPanel Orientation="Horizontal">
<TextBlock Padding="5,0,5,0"
Text="{Binding FirstName}" />
<TextBlock Text="{Binding LastName}" />
<TextBlock Text=", " />
<TextBlock Text="{Binding Address}" />
</StackPanel>
</DataTemplate>
</ListBox.ItemTemplate>
</ListBox>
</Grid>
<Grid>
<Grid.Resources>
<Style x:Key="horizontalListBoxStyle" TargetType="ListBox">
<Setter Property="ItemsPanel">
<Setter.Value>
<ItemsPanelTemplate>
<StackPanel Orientation="Horizontal"
VerticalAlignment="Center"
HorizontalAlignment="Center"/>
</ItemsPanelTemplate>
</Setter.Value>
</Setter>
<Setter Property="ItemTemplate">
<Setter.Value>
<DataTemplate>
<StackPanel Orientation="Horizontal">
<TextBlock Padding="5,0,5,0"
Text="{Binding FirstName}" />
<TextBlock Text="{Binding LastName}" />
</StackPanel>
</DataTemplate>
</Setter.Value>
</Setter>
</Style>
<src:Customers x:Key="items"/>
</Grid.Resources>
<ListBox Height="25" Width="420" ItemsSource="{StaticResource items}" Style="{StaticResource horizontalListBoxStyle}"/>
</Grid>
</StackPanel>
<TextBlock Margin="5" Text="ListBox with SelectionChanged event handler:" Width="270" HorizontalAlignment="Left" />
<ListBox Width="150" Margin="0,5,0,5" SelectionChanged="PrintText" HorizontalAlignment="Left">
<ListBoxItem Content="Item 1" />
<ListBoxItem Content="Item 2" />
<ListBoxItem Content="Item 3" />
<ListBoxItem Content="Item 4" />
<ListBoxItem Content="Item 5" />
</ListBox>
<TextBlock Name="textBlock1" />
</StackPanel>
</UserControl>
Imports System
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Documents
Imports System.Windows.Ink
Imports System.Windows.Input
Imports System.Windows.Media
Imports System.Windows.Media.Animation
Imports System.Windows.Shapes
Imports System.Collections.ObjectModel
Partial Public Class Page
Inherits UserControl
Public Sub New()
' Required to initialize variables
InitializeComponent()
End Sub
Private Sub PrintText(ByVal sender As Object, ByVal args As SelectionChangedEventArgs)
Dim lbi As ListBoxItem = TryCast(TryCast(sender, ListBox).SelectedItem, ListBoxItem)
textBlock1.Text = " You selected " + lbi.Content.ToString() + "."
End Sub
End Class
Public Class Customer
Private _firstName As String
Private _lastName As String
Private _address As String
Public Property FirstName() As String
Get
Return _firstName
End Get
Set(ByVal value As String)
_firstName = value
End Set
End Property
Public Property LastName() As String
Get
Return _lastName
End Get
Set(ByVal value As String)
_lastName = value
End Set
End Property
Public Property Address() As String
Get
Return _address
End Get
Set(ByVal value As String)
_address = value
End Set
End Property
Public Sub New(ByVal firstName As String, ByVal lastName As String, ByVal address As String)
Me.FirstName = firstName
Me.LastName = lastName
Me.Address = address
End Sub
End Class
Public Class Customers
Inherits ObservableCollection(Of Customer)
Public Sub New()
Add(New Customer("Michael", "Anderberg", "12 North Third Street, Apartment 45"))
Add(New Customer("Chris", "Ashton", "34 West Fifth Street, Apartment 67"))
Add(New Customer("Cassie", "Hicks", "56 East Seventh Street, Apartment 89"))
Add(New Customer("Guido", "Pica", "78 South Ninth Street, Apartment 10"))
End Sub
End Class
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Ink;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using System.Collections.ObjectModel;
namespace ListBoxSnippetEx
{
public partial class Page : UserControl
{
public Page()
{
// Required to initialize variables
InitializeComponent();
}
void PrintText(object sender, SelectionChangedEventArgs args)
{
ListBoxItem lbi = ((sender as ListBox).SelectedItem as ListBoxItem);
textBlock1.Text = " You selected " + lbi.Content.ToString() + ".";
}
}
public class Customer
{
public String FirstName { get; set; }
public String LastName { get; set; }
public String Address { get; set; }
public Customer(String firstName, String lastName, String address)
{
this.FirstName = firstName;
this.LastName = lastName;
this.Address = address;
}
}
public class Customers : ObservableCollection<Customer>
{
public Customers()
{
Add(new Customer("Michael", "Anderberg",
"12 North Third Street, Apartment 45"));
Add(new Customer("Chris", "Ashton",
"34 West Fifth Street, Apartment 67"));
Add(new Customer("Cassie", "Hicks",
"56 East Seventh Street, Apartment 89"));
Add(new Customer("Guido", "Pica",
"78 South Ninth Street, Apartment 10"));
}
}
}
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also