LongListSelector Class

July 28, 2014

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

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.

'Declaration
<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
<LongListSelector .../>

The LongListSelector type exposes the following members.

  NameDescription
Public methodLongListSelectorInitializes a new instance of the LongListSelector class.
Top

  NameDescription
Public propertyActualHeightGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyActualWidthGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyAllowDropGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement.)
Public propertyBackground (Inherited from Control.)
Public propertyBorderBrush (Inherited from Control.)
Public propertyBorderThickness (Inherited from Control.)
Public propertyCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertyCharacterSpacing (Inherited from Control.)
Public propertyClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertyCursorInfrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyDataContextGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Protected propertyDefaultStyleKey (Inherited from Control.)
Public propertyDesiredSizeGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyFlowDirectionGets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public propertyFontFamily (Inherited from Control.)
Public propertyFontSize (Inherited from Control.)
Public propertyFontStretch (Inherited from Control.)
Public propertyFontStyle (Inherited from Control.)
Public propertyFontWeight (Inherited from Control.)
Public propertyForeground (Inherited from Control.)
Public propertyGridCellSizeGets or sets the size used when displaying an item in the LongListSelector.
Public propertyGroupFooterTemplateGets or sets the template for the group footer in the LongListSelector.
Public propertyGroupHeaderTemplateGets or sets the template for the group header in the LongListSelector.
Public propertyHeightGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyHideEmptyGroupsGets or sets a value that indicates whether to hide empty groups in the LongListSelector.
Public propertyHorizontalAlignmentGets 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.)
Public propertyHorizontalContentAlignment (Inherited from Control.)
Public propertyIsEnabled (Inherited from Control.)
Public propertyIsGroupingEnabledGets or sets a value that indicates whether grouping is enabled in the LongListSelector.
Public propertyIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertyIsTabStop (Inherited from Control.)
Public propertyItemsSourceGets or sets a collection used to generate the content of the LongListSelector.
Public propertyItemTemplateGets or sets the template for the items in the items view
Public propertyJumpListStyleGets or sets the Style for jump list in the LongListSelector.
Public propertyLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyLayoutModeGets or sets a value that specifies if the LongListSelector is in a list mode or grid mode from the LongListSelectorLayoutMode enum.
Public propertyListFooterGets or sets the object that is displayed at the foot of the LongListSelector.
Public propertyListFooterTemplateGets or sets the DataTemplatefor an item to display at the foot of the LongListSelector.
Public propertyListHeaderGets or sets the object to display at the head of the LongListSelector.
Public propertyListHeaderTemplateGets or sets the DataTemplatefor an item to display at the head of the LongListSelector.
Public propertyManipulationStateGets the state of manipulation handling on the LongListSelector control.
Public propertyMarginGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxHeightGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMaxWidthGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinHeightGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyMinWidthGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyNameGets 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.)
Public propertyOpacityGets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertyOpacityMaskGets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertyPadding (Inherited from Control.)
Public propertyParentGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public propertyProjectionGets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertyRenderSizeGets the final render size of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertyRenderTransformOriginGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Public propertyResourcesGets 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.)
Public propertySelectedItemGets the currently selected item in the LongListSelector.
Public propertyStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertyTabIndex (Inherited from Control.)
Public propertyTabNavigation (Inherited from Control.)
Public propertyTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertyTemplate (Inherited from Control.)
Public propertyTriggersGets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyUseLayoutRoundingGets 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.)
Public propertyUseOptimizedManipulationRoutingGets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.)
Public propertyVerticalAlignmentGets 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.)
Public propertyVerticalContentAlignment (Inherited from Control.)
Public propertyVisibilityGets 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.)
Public propertyWidthGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)
Top

  NameDescription
Public methodAddHandlerAdds 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.)
Public methodApplyTemplate (Inherited from Control.)
Public methodArrangePositions 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.)
Protected methodArrangeOverrideProvides 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.)
Public methodCaptureMouseSets touch capture to a UIElement. (Inherited from UIElement.)
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindNameRetrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public methodFocus (Inherited from Control.)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetBindingExpressionRetrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetTemplateChild (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidateArrangeInvalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
Public methodInvalidateMeasureInvalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodMeasureUpdates 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.)
Protected methodMeasureOverrideProvides the behavior for the Measure pass of layout. (Overrides FrameworkElement.MeasureOverride(Size).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnApplyTemplateBuilds the visual tree for the LongListSelector control when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate.)
Protected methodOnCreateAutomationPeerCreates the automation peer for this LongListSelector. (Overrides UIElement.OnCreateAutomationPeer.)
Protected methodOnDoubleTap (Inherited from Control.)
Protected methodOnDragEnter (Inherited from Control.)
Protected methodOnDragLeave (Inherited from Control.)
Protected methodOnDragOver (Inherited from Control.)
Protected methodOnDrop (Inherited from Control.)
Protected methodOnGotFocus (Inherited from Control.)
Protected methodOnHold (Inherited from Control.)
Protected methodOnKeyDown (Inherited from Control.)
Protected methodOnKeyUp (Inherited from Control.)
Protected methodOnLostFocus (Inherited from Control.)
Protected methodOnLostMouseCapture (Inherited from Control.)
Protected methodOnManipulationCompleted (Inherited from Control.)
Protected methodOnManipulationDelta (Inherited from Control.)
Protected methodOnManipulationStarted (Inherited from Control.)
Protected methodOnMouseEnter (Inherited from Control.)
Protected methodOnMouseLeave (Inherited from Control.)
Protected methodOnMouseLeftButtonDown (Inherited from Control.)
Protected methodOnMouseLeftButtonUp (Inherited from Control.)
Protected methodOnMouseMove (Inherited from Control.)
Protected methodOnMouseRightButtonDown (Inherited from Control.)
Protected methodOnMouseRightButtonUp (Inherited from Control.)
Protected methodOnMouseWheel (Inherited from Control.)
Protected methodOnTap (Inherited from Control.)
Protected methodOnTextInput (Inherited from Control.)
Protected methodOnTextInputStart (Inherited from Control.)
Protected methodOnTextInputUpdate (Inherited from Control.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodReleaseMouseCaptureRemoves touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
Public methodRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodScrollToScrolls to a specified item in the LongListSelector.
Public methodSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransformToVisualReturns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public methodUpdateLayoutEnsures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
Top

  NameDescription
Public eventBindingValidationErrorOccurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public eventDoubleTapOccurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventHoldOccurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventIsEnabledChanged (Inherited from Control.)
Public eventItemRealizedOccurs when a new item is assigned a UI container (realized).
Public eventItemUnrealizedOccurs when an item in the LongListSelector is unrealized.
Public eventJumpListClosedOccurs when the jump list is closed.
Public eventJumpListOpeningOccurs when a jump list is opened.
Public eventKeyDownOccurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventKeyUpOccurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventLayoutUpdatedOccurs when the layout of the Windows Phone visual tree changes. (Inherited from FrameworkElement.)
Public eventLoadedOccurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public eventLostFocusOccurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventLostMouseCaptureOccurs when the UIElement loses touch capture. (Inherited from UIElement.)
Public eventManipulationCompletedOccurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventManipulationDeltaOccurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventManipulationStartedOccurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public eventManipulationStateChangedOccurs when the manipulation state changes.
Public eventMouseEnterOccurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeaveOccurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeftButtonDownOccurs when a UIElement is tapped. (Inherited from UIElement.)
Public eventMouseLeftButtonUpOccurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
Public eventMouseMoveOccurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
Public eventMouseWheelInfrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public eventPropertyChangedOccurs when a property value changes.
Public eventSelectionChangedOccurs when the currently selected item changes.
Public eventSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public eventTapOccurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventTextInputOccurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputStartOccurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventTextInputUpdateOccurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventUnloadedOccurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)
Top

  NameDescription
Public fieldStatic memberGridCellSizePropertyIdentifies the GridCellSize dependency property.
Public fieldStatic memberGroupFooterTemplatePropertyIdentifies the GroupFooterTemplate dependency property.
Public fieldStatic memberGroupHeaderTemplatePropertyIdentifies the GroupHeaderTemplate dependency property.
Public fieldStatic memberHideEmptyGroupsPropertyIdentifies the HideEmptyGroups dependency property.
Public fieldStatic memberIsGroupingEnabledPropertyIdentifies the IsGroupingEnabled dependency property.
Public fieldStatic memberItemsSourcePropertyIdentifies the ItemsSource dependency property.
Public fieldStatic memberItemTemplatePropertyIdentifies the ItemTemplate dependency property.
Public fieldStatic memberJumpListStylePropertyIdentifies the JumpListStyle dependency property.
Public fieldStatic memberListFooterPropertyIdentifies the ListFooter dependency property.
Public fieldStatic memberListFooterTemplatePropertyIdentifies the ListFooterTemplate dependency property.
Public fieldStatic memberListHeaderPropertyIdentifies the ListHeader dependency property.
Public fieldStatic memberListHeaderTemplatePropertyIdentifies the ListHeaderTemplate dependency property.
Top

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.

LongListSelector flat list

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.

LongListSelector

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.

Windows Phone OS

Supported in: 8.1, 8.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft