LongListSelector Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Displays a list of selectable items with a mechanism for users to jump to a specific section of the list.

Inheritance Hierarchy

System..::.Object
System.Windows..::.DependencyObject
System.Windows..::.UIElement
System.Windows..::.FrameworkElement
System.Windows.Controls..::.Control
Microsoft.Phone.Controls..::.LongListSelector

Namespace: Microsoft.Phone.Controls
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

<StyleTypedPropertyAttribute(Property := "JumpListStyle", StyleTargetType := GetType(LongListSelector))> _
<TemplateVisualStateAttribute(Name := "Scrolling", GroupName := "ScrollStates")> _
<TemplatePartAttribute(Name := "VerticalScrollBar", Type := GetType(ScrollBar))> _
<TemplateVisualStateAttribute(Name := "NotScrolling", GroupName := "ScrollStates")> _
<TemplatePartAttribute(Name := "ViewportControl", Type := GetType(ViewportControl))> _
Public Class LongListSelector _
    Inherits Control _
    Implements INotifyPropertyChanged
[StyleTypedPropertyAttribute(Property = "JumpListStyle", StyleTargetType = typeof(LongListSelector))]
[TemplateVisualStateAttribute(Name = "Scrolling", GroupName = "ScrollStates")]
[TemplatePartAttribute(Name = "VerticalScrollBar", Type = typeof(ScrollBar))]
[TemplateVisualStateAttribute(Name = "NotScrolling", GroupName = "ScrollStates")]
[TemplatePartAttribute(Name = "ViewportControl", Type = typeof(ViewportControl))]
public class LongListSelector : Control, 
    INotifyPropertyChanged
<LongListSelector .../>

The LongListSelector type exposes the following members.

Constructors

Name Description
LongListSelector Initializes a new instance of the LongListSelector class.

Top

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 drag-and-drop operations. (Inherited from UIElement.)
Background (Inherited from Control.)
BorderBrush (Inherited from Control.)
BorderThickness (Inherited from Control.)
CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
CharacterSpacing (Inherited from Control.)
Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Cursor Infrastructure. Gets or sets the cursor image that displays while the 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 (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.)
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 (Inherited from Control.)
FontSize (Inherited from Control.)
FontStretch (Inherited from Control.)
FontStyle (Inherited from Control.)
FontWeight (Inherited from Control.)
Foreground (Inherited from Control.)
GridCellSize Gets or sets the size used when displaying an item in the LongListSelector.
GroupFooterTemplate Gets or sets the template for the group footer in the LongListSelector.
GroupHeaderTemplate Gets or sets the template for the group header in the LongListSelector.
Height Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
HideEmptyGroups Gets or sets a value that indicates whether to hide empty groups in the LongListSelector.
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 (Inherited from Control.)
IsEnabled (Inherited from Control.)
IsGroupingEnabled Gets or sets a value that indicates whether grouping is enabled in the LongListSelector.
IsHitTestVisible Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
IsTabStop (Inherited from Control.)
ItemsSource Gets or sets a collection used to generate the content of the LongListSelector.
ItemTemplate Gets or sets the template for the items in the items view
JumpListStyle Gets or sets the Style for jump list in the LongListSelector.
Language Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
LayoutMode Gets or sets a value that specifies if the LongListSelector is in a list mode or grid mode from the LongListSelectorLayoutMode enum.
ListFooter Gets or sets the object that is displayed at the foot of the LongListSelector.
ListFooterTemplate Gets or sets the DataTemplatefor an item to display at the foot of the LongListSelector.
ListHeader Gets or sets the object to display at the head of the LongListSelector.
ListHeaderTemplate Gets or sets the DataTemplatefor an item to display at the head of the LongListSelector.
ManipulationState Gets the state of manipulation handling on the LongListSelector control.
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 (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.)
SelectedItem Gets the currently selected item in the LongListSelector.
Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
TabIndex (Inherited from Control.)
TabNavigation (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 (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.)
UseOptimizedManipulationRouting Gets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.)
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 (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 (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 Windows Phone layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
CaptureMouse Sets touch capture to a UIElement. (Inherited from UIElement.)
CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
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 (Inherited from Control.)
GetAnimationBaseValue Returns any base value established for a Windows Phone 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.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetTemplateChild (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.)
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 layout. (Overrides FrameworkElement..::.MeasureOverride(Size).)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
OnApplyTemplate Builds the visual tree for the LongListSelector control when a new template is applied. (Overrides FrameworkElement..::.OnApplyTemplate()()().)
OnCreateAutomationPeer Creates the automation peer for this LongListSelector. (Overrides UIElement..::.OnCreateAutomationPeer()()().)
OnDoubleTap (Inherited from Control.)
OnDragEnter (Inherited from Control.)
OnDragLeave (Inherited from Control.)
OnDragOver (Inherited from Control.)
OnDrop (Inherited from Control.)
OnGotFocus (Inherited from Control.)
OnHold (Inherited from Control.)
OnKeyDown (Inherited from Control.)
OnKeyUp (Inherited from Control.)
OnLostFocus (Inherited from Control.)
OnLostMouseCapture (Inherited from Control.)
OnManipulationCompleted (Inherited from Control.)
OnManipulationDelta (Inherited from Control.)
OnManipulationStarted (Inherited from Control.)
OnMouseEnter (Inherited from Control.)
OnMouseLeave (Inherited from Control.)
OnMouseLeftButtonDown (Inherited from Control.)
OnMouseLeftButtonUp (Inherited from Control.)
OnMouseMove (Inherited from Control.)
OnMouseRightButtonDown (Inherited from Control.)
OnMouseRightButtonUp (Inherited from Control.)
OnMouseWheel (Inherited from Control.)
OnTap (Inherited from Control.)
OnTextInput (Inherited from Control.)
OnTextInputStart (Inherited from Control.)
OnTextInputUpdate (Inherited from Control.)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
ReleaseMouseCapture Removes touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
ScrollTo Scrolls to a specified item in the LongListSelector.
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.)
DoubleTap Occurs when a DoubleTap gesture is committed while over this UIElement. (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 (Inherited from Control.)
ItemRealized Occurs when a new item is assigned a UI container (realized).
ItemUnrealized Occurs when an item in the LongListSelector is unrealized.
JumpListClosed Occurs when the jump list is closed.
JumpListOpening Occurs when a jump list is opened.
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 Windows Phone 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 touch 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.)
ManipulationStateChanged Occurs when the manipulation state changes.
MouseEnter Occurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeave Occurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeftButtonDown Occurs when a UIElement is tapped. (Inherited from UIElement.)
MouseLeftButtonUp Occurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseMove Occurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseWheel Infrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
PropertyChanged Occurs when a property value changes.
SelectionChanged Occurs when the currently selected item changes.
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
GridCellSizeProperty Identifies the GridCellSize dependency property.
GroupFooterTemplateProperty Identifies the GroupFooterTemplate dependency property.
GroupHeaderTemplateProperty Identifies the GroupHeaderTemplate dependency property.
HideEmptyGroupsProperty Identifies the HideEmptyGroups dependency property.
IsGroupingEnabledProperty Identifies the IsGroupingEnabled dependency property.
ItemsSourceProperty Identifies the ItemsSource dependency property.
ItemTemplateProperty Identifies the ItemTemplate dependency property.
JumpListStyleProperty Identifies the JumpListStyle dependency property.
ListFooterProperty Identifies the ListFooter dependency property.
ListFooterTemplateProperty Identifies the ListFooterTemplate dependency property.
ListHeaderProperty Identifies the ListHeader dependency property.
ListHeaderTemplateProperty Identifies the ListHeaderTemplate dependency property.

Top

Remarks

LongListSelector control provides a flexible way to display a collection of data in the form of a list or a grid. Use the LayoutMode property to display data in the LongListSelector in a list or a grid form. This property takes values from LongListSelectorLayoutMode enumeration. The following illustration displays a LongListSelector in a list and grid view.

To provide items to be displayed in the LongListSelector, use the ItemsSource property.

In its simplest form, you can use LongListSelector control to display flat lists of scrollable data like a ListBox control. Set IsGroupingEnabled property to false to display data as a flat list. When LongListSelector is used to display a flat list, it is similar to a ListBox control with an optional header and footer. It is recommended that you use LongListSelector to display flat lists instead of using a ListBox, as the performance of LongListSelector is better than that of a ListBox and it also supports full data and UI virtualization. The following illustration displays a LongListSelector with flat list of data.

A more common scenario for using a LongListSelector is to display grouped lists of data. You can do this by setting IsGroupingEnabled property to true. In this mode, the data to be displayed is grouped by a key. When the user taps on a specific key displayed in the group header, a jump list with all the group headers is displayed over the list. The user can then tap on a specific cell in the jump list to navigate to an item in a specific group. This helps the user to scroll through long lists of data easily. Use GroupHeaderTemplate property to customize the look and feel of group header and use JumpListStyle to customize the look and feel of jump list. The JumpListStyle is used to define a grid style jump list, like the people hub or a list style jump list, like the date view in the Pictures hub.

The following illustration displays a LongListSelector in the grouped list mode.

Use the ListHeader and the ListFooter property to set the header and the footer of the LongListSelector and ListHeaderTemplate and ListFooterTemplate to customize the look and feel of list header and footer.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

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

Reference

Microsoft.Phone.Controls Namespace

Other Resources

How to display data in a grouped list in LongListSelector for Windows Phone 8

LongListSelector control design guidelines for Windows Phone