ListBoxItem Class

Definition

Represents a selectable item in a ListBox.

public ref class ListBoxItem : System::Windows::Controls::ContentControl
public class ListBoxItem : System.Windows.Controls.ContentControl
type ListBoxItem = class
    inherit ContentControl
Public Class ListBoxItem
Inherits ContentControl
Inheritance
Derived

Examples

The following example shows how to create a ListBox that contains ListBoxItem elements.

<TextBox Name="tb" Width="140" Height="30"></TextBox>
<ListBox Name="lb" Width="100" Height="55" SelectionChanged="PrintText" SelectionMode="Single">
  <ListBoxItem>Item 1</ListBoxItem>
  <ListBoxItem>Item 2</ListBoxItem>
  <ListBoxItem>Item 3</ListBoxItem>
  <ListBoxItem>Item 4</ListBoxItem>
  <ListBoxItem>Item 5</ListBoxItem>
  <ListBoxItem>Item 6</ListBoxItem>
  <ListBoxItem>Item 7</ListBoxItem>
  <ListBoxItem>Item 8</ListBoxItem>
  <ListBoxItem>Item 9</ListBoxItem>
  <ListBoxItem>Item 10</ListBoxItem>
</ListBox>

Remarks

A ListBox contains a collection of ListBoxItem objects. To select a ListBoxItem in a ListBox, set the IsSelected property to true.

Bind a ListBoxItem to data by binding the ItemsSource property of a ListBox to a data source. For more information, see How to: Bind a ListBox to Data. You can customize the appearance of a ListBoxItem by setting the ItemTemplate property of a ListBox to a DataTemplate. For more information, see Data Templating Overview.

By default, the HorizontalAlignment of a ListBoxItem is set to Stretch. The default horizontal position of a StackPanel is Center. If you set the Width property of a ListBoxItem through a StackPanel, the panel's default is applied and the item is centered.

A ListBoxItem is a ContentControl, which means that it can contain a single object of any type (such as a string, an image, or a panel). For more information, see the ContentControl class.

Customizing the ListBoxItem Control

To apply the same property settings to multiple ListBoxItem controls, use the Style property. You can modify the default ControlTemplate to give the control a unique appearance. For more information about creating a ControlTemplate, see How to create a template for a control. To see the parts and states that are specific to the ListBoxItem, see ListBox Styles and Templates.

Dependency properties for this control might be set by the control's default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running.

Note

Setting a visual property only has an effect if that property is both present in the control's default template and set by using a TemplateBinding.

Constructors

Name Description
ListBoxItem()

Initializes a new instance of the ListBoxItem class.

Fields

Name Description
IsSelectedProperty

Identifies the IsSelected dependency property.

SelectedEvent

Identifies the Selected routed event.

UnselectedEvent

Identifies the Unselected routed event.

Properties

Name Description
ActualHeight

Gets the rendered height of this element.

(Inherited from FrameworkElement)
ActualWidth

Gets the rendered width of this element.

(Inherited from FrameworkElement)
AllowDrop

Gets or sets a value indicating whether this element can be used as the target of a drag-and-drop operation. This is a dependency property.

(Inherited from UIElement)
AreAnyTouchesCaptured

Gets a value that indicates whether at least one touch is captured to this element.

(Inherited from UIElement)
AreAnyTouchesCapturedWithin

Gets a value that indicates whether at least one touch is captured to this element or to any child elements in its visual tree.

(Inherited from UIElement)
AreAnyTouchesDirectlyOver

Gets a value that indicates whether at least one touch is pressed over this element.

(Inherited from UIElement)
AreAnyTouchesOver

Gets a value that indicates whether at least one touch is pressed over this element or any child elements in its visual tree.

(Inherited from UIElement)
Background

Gets or sets a brush that describes the background of a control.

(Inherited from Control)
BindingGroup

Gets or sets the BindingGroup that is used for the element.

(Inherited from FrameworkElement)
BitmapEffect
Obsolete.
Obsolete.

Gets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property.

(Inherited from UIElement)
BitmapEffectInput
Obsolete.
Obsolete.

Gets or sets an input source for the bitmap effect that applies directly to the rendered content for this element. This is a dependency property.

(Inherited from UIElement)
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 cached representation of the UIElement.

(Inherited from UIElement)
Clip

Gets or sets the geometry used to define the outline of the contents of an element. This is a dependency property.

(Inherited from UIElement)
ClipToBounds

Gets or sets a value indicating whether to clip the content of this element (or content coming from the child elements of this element) to fit into the size of the containing element. This is a dependency property.

(Inherited from UIElement)
CommandBindings

Gets a collection of CommandBinding objects associated with this element. A CommandBinding enables command handling for this element, and declares the linkage between a command, its events, and the handlers attached by this element.

(Inherited from UIElement)
Content

Gets or sets the content of a ContentControl.

(Inherited from ContentControl)
ContentStringFormat

Gets or sets a composite string that specifies how to format the Content property if it is displayed as a string.

(Inherited from ContentControl)
ContentTemplate

Gets or sets the data template used to display the content of the ContentControl.

(Inherited from ContentControl)
ContentTemplateSelector

Gets or sets a template selector that enables an application writer to provide custom template-selection logic.

(Inherited from ContentControl)
ContextMenu

Gets or sets the context menu element that should appear whenever the context menu is requested through user interface (UI) from within this element.

(Inherited from FrameworkElement)
Cursor

Gets or sets the cursor that displays when the mouse pointer is over this element.

(Inherited from FrameworkElement)
DataContext

Gets or sets the data context for an element when it participates in data binding.

(Inherited from FrameworkElement)
DefaultStyleKey

Gets or sets the key to use to reference the style for this control, when theme styles are used or defined.

(Inherited from FrameworkElement)
DependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance.

(Inherited from DependencyObject)
DesiredSize

Gets the size that this element computed during the measure pass of the layout process.

(Inherited from UIElement)
Dispatcher

Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
Effect

Gets or sets the bitmap effect to apply to the UIElement. This is a dependency property.

(Inherited from UIElement)
FlowDirection

Gets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout.

(Inherited from FrameworkElement)
Focusable

Gets or sets a value that indicates whether the element can receive focus. This is a dependency property.

(Inherited from UIElement)
FocusVisualStyle

Gets or sets a property that enables customization of appearance, effects, or other style characteristics that will apply to this element when it captures keyboard focus.

(Inherited from FrameworkElement)
FontFamily

Gets or sets the font family of the control.

(Inherited from Control)
FontSize

Gets or sets the font size.

(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 font style.

(Inherited from Control)
FontWeight

Gets or sets the weight or thickness of the specified font.

(Inherited from Control)
ForceCursor

Gets or sets a value that indicates whether this FrameworkElement should force the user interface (UI) to render the cursor as declared by the Cursor property.

(Inherited from FrameworkElement)
Foreground

Gets or sets a brush that describes the foreground color.

(Inherited from Control)
HandlesScrolling

Gets a value that indicates whether a control supports scrolling.

(Inherited from Control)
HasAnimatedProperties

Gets a value indicating whether this element has any animated properties.

(Inherited from UIElement)
HasContent

Gets a value that indicates whether the ContentControl contains content.

(Inherited from ContentControl)
HasEffectiveKeyboardFocus

Gets a value that indicates whether the UIElement has focus.

(Inherited from UIElement)
Height

Gets or sets the suggested height of the element.

(Inherited from FrameworkElement)
HorizontalAlignment

Gets or sets the horizontal alignment characteristics applied to this element when it is composed within a parent element, 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)
InheritanceBehavior

Gets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup.

(Inherited from FrameworkElement)
InputBindings

Gets the collection of input bindings associated with this element.

(Inherited from UIElement)
InputScope

Gets or sets the context for input used by this FrameworkElement.

(Inherited from FrameworkElement)
IsArrangeValid

Gets a value indicating whether the computed size and position of child elements in this element's layout are valid.

(Inherited from UIElement)
IsEnabled

Gets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property.

(Inherited from UIElement)
IsEnabledCore

Gets a value that becomes the return value of IsEnabled in derived classes.

(Inherited from UIElement)
IsFocused

Gets a value that determines whether this element has logical focus. This is a dependency property.

(Inherited from UIElement)
IsHitTestVisible

Gets or sets a value that declares whether this element can possibly be returned as a hit test result from some portion of its rendered content. This is a dependency property.

(Inherited from UIElement)
IsInitialized

Gets a value that indicates whether this element has been initialized, either during processing by a XAML processor, or by explicitly having its EndInit() method called.

(Inherited from FrameworkElement)
IsInputMethodEnabled

Gets a value indicating whether an input method system, such as an Input Method Editor (IME), is enabled for processing the input to this element.

(Inherited from UIElement)
IsKeyboardFocused

Gets a value indicating whether this element has keyboard focus. This is a dependency property.

(Inherited from UIElement)
IsKeyboardFocusWithin

Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. This is a dependency property.

(Inherited from UIElement)
IsLoaded

Gets a value that indicates whether this element has been loaded for presentation.

(Inherited from FrameworkElement)
IsManipulationEnabled

Gets or sets a value that indicates whether manipulation events are enabled on this UIElement.

(Inherited from UIElement)
IsMeasureValid

Gets a value indicating whether the current size returned by layout measure is valid.

(Inherited from UIElement)
IsMouseCaptured

Gets a value indicating whether the mouse is captured to this element. This is a dependency property.

(Inherited from UIElement)
IsMouseCaptureWithin

Gets a value that determines whether mouse capture is held by this element or by child elements in its visual tree. This is a dependency property.

(Inherited from UIElement)
IsMouseDirectlyOver

Gets a value that indicates whether the position of the mouse pointer corresponds to hit test results, which take element compositing into account. This is a dependency property.

(Inherited from UIElement)
IsMouseOver

Gets a value indicating whether the mouse pointer is located over this element (including child elements in the visual tree). This is a dependency property.

(Inherited from UIElement)
IsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).

(Inherited from DependencyObject)
IsSelected

Gets or sets a value that indicates whether a ListBoxItem is selected.

IsStylusCaptured

Gets a value indicating whether the stylus is captured by this element. This is a dependency property.

(Inherited from UIElement)
IsStylusCaptureWithin

Gets a value that determines whether stylus capture is held by this element, or an element within the element bounds and its visual tree. This is a dependency property.

(Inherited from UIElement)
IsStylusDirectlyOver

Gets a value that indicates whether the stylus position corresponds to hit test results, which take element compositing into account. This is a dependency property.

(Inherited from UIElement)
IsStylusOver

Gets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property.

(Inherited from UIElement)
IsTabStop

Gets or sets a value that indicates whether a control is included in tab navigation.

(Inherited from Control)
IsVisible

Gets a value indicating whether this element is visible in the user interface (UI). This is a dependency property.

(Inherited from UIElement)
Language

Gets or sets localization/globalization language information that applies to an element.

(Inherited from FrameworkElement)
LayoutTransform

Gets or sets a graphics transformation that should apply to this element when layout is performed.

(Inherited from FrameworkElement)
LogicalChildren

Gets an enumerator to the content control's logical child elements.

(Inherited from ContentControl)
Margin

Gets or sets the outer margin of an element.

(Inherited from FrameworkElement)
MaxHeight

Gets or sets the maximum height constraint of the element.

(Inherited from FrameworkElement)
MaxWidth

Gets or sets the maximum width constraint of the element.

(Inherited from FrameworkElement)
MinHeight

Gets or sets the minimum height constraint of the element.

(Inherited from FrameworkElement)
MinWidth

Gets or sets the minimum width constraint of the element.

(Inherited from FrameworkElement)
Name

Gets or sets the identifying name of the element. The name provides a reference so that code-behind, such as event handler code, can refer to a markup element after it is constructed during processing by a XAML processor.

(Inherited from FrameworkElement)
Opacity

Gets or sets the opacity factor applied to the entire UIElement when it is rendered in the user interface (UI). This is a dependency property.

(Inherited from UIElement)
OpacityMask

Gets or sets an opacity mask, as a Brush implementation that is applied to any alpha-channel masking for the rendered content of this element. This is a dependency property.

(Inherited from UIElement)
OverridesDefaultStyle

Gets or sets a value that indicates whether this element incorporates style properties from theme styles.

(Inherited from FrameworkElement)
Padding

Gets or sets the padding inside a control.

(Inherited from Control)
Parent

Gets the logical parent element of this element.

(Inherited from FrameworkElement)
PersistId
Obsolete.

Gets a value that uniquely identifies this element.

(Inherited from UIElement)
RenderSize

Gets (or sets) the final render size of this element.

(Inherited from UIElement)
RenderTransform

Gets or sets transform information that affects the rendering position of this element. This is a dependency property.

(Inherited from UIElement)
RenderTransformOrigin

Gets or sets the center point of any possible render transform declared by RenderTransform, relative to the bounds of the element. This is a dependency property.

(Inherited from UIElement)
Resources

Gets or sets the locally-defined resource dictionary.

(Inherited from FrameworkElement)
SnapsToDevicePixels

Gets or sets a value that determines whether rendering for this element should use device-specific pixel settings during rendering. This is a dependency property.

(Inherited from UIElement)
Style

Gets or sets the style used by this element when it is rendered.

(Inherited from FrameworkElement)
StylusPlugIns

Gets a collection of all stylus plug-in (customization) objects associated with this element.

(Inherited from UIElement)
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)
Tag

Gets or sets an arbitrary object value that can be used to store custom information about this element.

(Inherited from FrameworkElement)
Template

Gets or sets a control template.

(Inherited from Control)
TemplatedParent

Gets a reference to the template parent of this element. This property is not relevant if the element was not created through a template.

(Inherited from FrameworkElement)
ToolTip

Gets or sets the tool-tip object that is displayed for this element in the user interface (UI).

(Inherited from FrameworkElement)
TouchesCaptured

Gets all touch devices that are captured to this element.

(Inherited from UIElement)
TouchesCapturedWithin

Gets all touch devices that are captured to this element or any child elements in its visual tree.

(Inherited from UIElement)
TouchesDirectlyOver

Gets all touch devices that are over this element.

(Inherited from UIElement)
TouchesOver

Gets all touch devices that are over this element or any child elements in its visual tree.

(Inherited from UIElement)
Triggers

Gets the collection of triggers established directly on this element, or in child elements.

(Inherited from FrameworkElement)
Uid

Gets or sets the unique identifier (for localization) for this element. This is a dependency property.

(Inherited from UIElement)
UseLayoutRounding

Gets or sets a value that indicates whether layout rounding should be applied to this element's size and position during layout.

(Inherited from FrameworkElement)
VerticalAlignment

Gets or sets the vertical alignment characteristics applied to this element when it is composed within a parent element 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 user interface (UI) visibility of this element. This is a dependency property.

(Inherited from UIElement)
VisualBitmapEffect
Obsolete.
Obsolete.

Gets or sets the BitmapEffect value for the Visual.

(Inherited from Visual)
VisualBitmapEffectInput
Obsolete.
Obsolete.

Gets or sets the BitmapEffectInput value for the Visual.

(Inherited from Visual)
VisualBitmapScalingMode

Gets or sets the BitmapScalingMode for the Visual.

(Inherited from Visual)
VisualCacheMode

Gets or sets a cached representation of the Visual.

(Inherited from Visual)
VisualChildrenCount

Gets the number of visual child elements within this element.

(Inherited from FrameworkElement)
VisualClearTypeHint

Gets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual.

(Inherited from Visual)
VisualClip

Gets or sets the clip region of the Visual as a Geometry value.

(Inherited from Visual)
VisualEdgeMode

Gets or sets the edge mode of the Visual as an EdgeMode value.

(Inherited from Visual)
VisualEffect

Gets or sets the bitmap effect to apply to the Visual.

(Inherited from Visual)
VisualOffset

Gets or sets the offset value of the visual object.

(Inherited from Visual)
VisualOpacity

Gets or sets the opacity of the Visual.

(Inherited from Visual)
VisualOpacityMask

Gets or sets the Brush value that represents the opacity mask of the Visual.

(Inherited from Visual)
VisualParent

Gets the visual tree parent of the visual object.

(Inherited from Visual)
VisualScrollableAreaClip

Gets or sets a clipped scrollable area for the Visual.

(Inherited from Visual)
VisualTextHintingMode

Gets or sets the TextHintingMode of the Visual.

(Inherited from Visual)
VisualTextRenderingMode

Gets or sets the TextRenderingMode of the Visual.

(Inherited from Visual)
VisualTransform

Gets or sets the Transform value for the Visual.

(Inherited from Visual)
VisualXSnappingGuidelines

Gets or sets the x-coordinate (vertical) guideline collection.

(Inherited from Visual)
VisualYSnappingGuidelines

Gets or sets the y-coordinate (horizontal) guideline collection.

(Inherited from Visual)
Width

Gets or sets the width of the element.

(Inherited from FrameworkElement)

Methods

Name Description
AddChild(Object)

Adds a specified object as the child of a ContentControl.

(Inherited from ContentControl)
AddHandler(RoutedEvent, Delegate, Boolean)

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)
AddHandler(RoutedEvent, Delegate)

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element.

(Inherited from UIElement)
AddLogicalChild(Object)

Adds the provided object to the logical tree of this element.

(Inherited from FrameworkElement)
AddText(String)

Adds a specified text string to a ContentControl.

(Inherited from ContentControl)
AddToEventRoute(EventRoute, RoutedEventArgs)

Adds handlers to the specified EventRoute for the current UIElement event handler collection.

(Inherited from UIElement)
AddVisualChild(Visual)

Defines the parent-child relationship between two visuals.

(Inherited from Visual)
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

Applies an animation to a specified dependency property on this element, with the ability to specify what happens if the property already has a running animation.

(Inherited from UIElement)
ApplyAnimationClock(DependencyProperty, AnimationClock)

Applies an animation to a specified dependency property on this element. Any existing animations are stopped and replaced with the new animation.

(Inherited from UIElement)
ApplyTemplate()

Builds the current template's visual tree if necessary, and returns a value that indicates whether the visual tree was rebuilt by this call.

(Inherited from FrameworkElement)
Arrange(Rect)

Positions child elements and determines a size for a UIElement. Parent elements call this method from their ArrangeCore(Rect) implementation (or a WPF framework-level equivalent) to form a recursive layout update. This method constitutes the second pass of a layout update.

(Inherited from UIElement)
ArrangeCore(Rect)

Implements ArrangeCore(Rect) (defined as virtual in UIElement) and seals the implementation.

(Inherited from FrameworkElement)
ArrangeOverride(Size)

Called to arrange and size the content of a Control object.

(Inherited from Control)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

Starts a specific animation for a specified animated property on this element, with the option of specifying what happens if the property already has a running animation.

(Inherited from UIElement)
BeginAnimation(DependencyProperty, AnimationTimeline)

Starts an animation for a specified animated property on this element.

(Inherited from UIElement)
BeginInit()

Starts the initialization process for this element.

(Inherited from FrameworkElement)
BeginStoryboard(Storyboard, HandoffBehavior, Boolean)

Begins the sequence of actions contained in the provided storyboard, with specified state for control of the animation after it is started.

(Inherited from FrameworkElement)
BeginStoryboard(Storyboard, HandoffBehavior)

Begins the sequence of actions contained in the provided storyboard, with options specified for what should happen if the property is already animated.

(Inherited from FrameworkElement)
BeginStoryboard(Storyboard)

Begins the sequence of actions that are contained in the provided storyboard.

(Inherited from FrameworkElement)
BringIntoView()

Attempts to bring this element into view, within any scrollable regions it is contained within.

(Inherited from FrameworkElement)
BringIntoView(Rect)

Attempts to bring the provided region size of this element into view, within any scrollable regions it is contained within.

(Inherited from FrameworkElement)
CaptureMouse()

Attempts to force capture of the mouse to this element.

(Inherited from UIElement)
CaptureStylus()

Attempts to force capture of the stylus to this element.

(Inherited from UIElement)
CaptureTouch(TouchDevice)

Attempts to force capture of a touch to this element.

(Inherited from UIElement)
CheckAccess()

Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
ClearValue(DependencyProperty)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.

(Inherited from DependencyObject)
ClearValue(DependencyPropertyKey)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.

(Inherited from DependencyObject)
CoerceValue(DependencyProperty)

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.

(Inherited from DependencyObject)
EndInit()

Indicates that the initialization process for the element is complete.

(Inherited from FrameworkElement)
Equals(Object)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.

(Inherited from DependencyObject)
FindCommonVisualAncestor(DependencyObject)

Returns the common ancestor of two visual objects.

(Inherited from Visual)
FindName(String)

Finds an element that has the provided identifier name.

(Inherited from FrameworkElement)
FindResource(Object)

Searches for a resource with the specified key, and throws an exception if the requested resource is not found.

(Inherited from FrameworkElement)
Focus()

Attempts to set focus to this element.

(Inherited from UIElement)
GetAnimationBaseValue(DependencyProperty)

Returns the base property value for the specified property on this element, disregarding any possible animated value from a running or stopped animation.

(Inherited from UIElement)
GetBindingExpression(DependencyProperty)

Returns the BindingExpression that represents the binding on the specified property.

(Inherited from FrameworkElement)
GetHashCode()

Gets a hash code for this DependencyObject.

(Inherited from DependencyObject)
GetLayoutClip(Size)

Returns a geometry for a clipping mask. The mask applies if the layout system attempts to arrange an element that is larger than the available display space.

(Inherited from FrameworkElement)
GetLocalValueEnumerator()

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

(Inherited from DependencyObject)
GetTemplateChild(String)

Returns the named element in the visual tree of an instantiated ControlTemplate.

(Inherited from FrameworkElement)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUIParentCore()

Returns an alternative logical parent for this element if there is no visual parent.

(Inherited from FrameworkElement)