Export (0) Print
Expand All

TreeView Class

Represents a control that displays hierarchical data in a tree structure that has items that can expand and collapse.

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls (in System.Windows.Controls.dll)

[TemplateVisualStateAttribute(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "Focused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "InvalidUnfocused", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Pressed", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Valid", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "InvalidFocused", GroupName = "ValidationStates")]
[StyleTypedPropertyAttribute(Property = "ItemContainerStyle", StyleTargetType = typeof(TreeViewItem))]
public class TreeView : ItemsControl
<sdk:TreeView .../>

The TreeView type exposes the following members.

  NameDescription
Public methodTreeViewInitializes a new instance of the TreeView 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 Silverlight drag-and-drop operations. (Inherited from UIElement.)
Public propertyBackgroundGets or sets a brush that provides the background of the control. (Inherited from Control.)
Public propertyBorderBrushGets or sets a brush that describes the border background of a control. (Inherited from Control.)
Public propertyBorderThicknessGets or sets the border thickness of a control. (Inherited from Control.)
Public propertyCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertyCharacterSpacingGets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.)
Public propertyClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertyCursorGets or sets the cursor image that displays while the mouse 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 propertyDefaultStyleKeyGets or sets the key that references the default style for the control. (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 propertyDisplayMemberPathGets or sets the name or path of the property that is displayed for each data item. (Inherited from ItemsControl.)
Public propertyEffectGets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
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 propertyFontFamilyGets or sets the font used to display text in the control. (Inherited from Control.)
Public propertyFontSizeGets or sets the size of the text in this control. (Inherited from Control.)
Public propertyFontStretchGets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.)
Public propertyFontStyleGets or sets the style in which the text is rendered. (Inherited from Control.)
Public propertyFontWeightGets or sets the thickness of the specified font. (Inherited from Control.)
Public propertyForegroundGets or sets a brush that describes the foreground color. (Inherited from Control.)
Public propertyHeightGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
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 propertyHorizontalContentAlignmentGets or sets the horizontal alignment of the control's content. (Inherited from Control.)
Public propertyIsEnabledGets or sets a value indicating whether the user can interact with the control. (Inherited from Control.)
Public propertyIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertyIsTabStopGets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.)
Public propertyItemContainerGeneratorGets the ItemContainerGenerator associated with this ItemsControl. (Inherited from ItemsControl.)
Public propertyItemContainerStyleGets or sets the Style that is applied to the container element generated for each item.
Public propertyItemsGets the collection used to generate the content of the control. (Inherited from ItemsControl.)
Public propertyItemsPanelGets or sets the template that defines the panel that controls the layout of items. (Inherited from ItemsControl.)
Public propertyItemsSourceGets or sets a collection used to generate the content of the ItemsControl. (Inherited from ItemsControl.)
Public propertyItemTemplateGets or sets the DataTemplate used to display each item. (Inherited from ItemsControl.)
Public propertyLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
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 propertyPaddingGets or sets the padding inside a control. (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 selected item in a TreeView.
Public propertySelectedValueGets the value of the SelectedItem property that is specified by the SelectedValuePath property.
Public propertySelectedValuePathGets or sets the property path that is used to get the SelectedValue property of the SelectedItem property in a TreeView.
Public propertyStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertyTabIndexGets 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.)
Public propertyTabNavigationGets or sets a value that modifies how tabbing and TabIndex work for this control. (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 propertyTemplateGets or sets a control template. (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 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 propertyVerticalContentAlignmentGets or sets the vertical alignment of the control's content. (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 methodApplyTemplateLoads the relevant control template so that its parts can be referenced. (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 Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
Public methodCaptureMouseSets mouse capture to a UIElement. (Inherited from UIElement.)
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Protected methodClearContainerForItemOverrideRemoves all templates, styles, and bindings for the object displayed as a TreeViewItem. (Overrides ItemsControl.ClearContainerForItemOverride(DependencyObject, Object).)
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 methodFocusAttempts to set the focus on the control. (Inherited from Control.)
Public methodGetAnimationBaseValueReturns any base value established for a Silverlight 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.)
Protected methodGetContainerForItemOverrideCreates a TreeViewItem to display content. (Overrides ItemsControl.GetContainerForItemOverride().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetTemplateChildRetrieves the named element in the instantiated ControlTemplate visual tree. (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.)
Protected methodIsItemItsOwnContainerOverrideDetermines whether the specified item is a TreeViewItem, which is the default container for items in the TreeView control. (Overrides ItemsControl.IsItemItsOwnContainerOverride(Object).)
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 Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnApplyTemplateBuilds the visual tree for the TreeView control when a new control template is applied. (Overrides ItemsControl.OnApplyTemplate().)
Protected methodOnCreateAutomationPeerReturns a TreeViewAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().)
Protected methodOnDragEnterCalled before the DragEnter event occurs. (Inherited from Control.)
Protected methodOnDragLeaveCalled before the DragLeave event occurs. (Inherited from Control.)
Protected methodOnDragOverCalled before the DragOver event occurs. (Inherited from Control.)
Protected methodOnDropCalled before the Drop event occurs. (Inherited from Control.)
Protected methodOnGotFocusProvides handling for the GotFocus event. (Overrides Control.OnGotFocus(RoutedEventArgs).)
Protected methodOnItemsChangedMakes adjustments to the TreeView control when the value of the Items property changes. (Overrides ItemsControl.OnItemsChanged(NotifyCollectionChangedEventArgs).)
Protected methodOnKeyDownProvides handling for the KeyDown event when a key is pressed while the control has focus. (Overrides Control.OnKeyDown(KeyEventArgs).)
Protected methodOnKeyUpProvides handling for the KeyUp event. (Overrides Control.OnKeyUp(KeyEventArgs).)
Protected methodOnLostFocusProvides handling for the LostFocus event. (Overrides Control.OnLostFocus(RoutedEventArgs).)
Protected methodOnLostMouseCaptureCalled before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
Protected methodOnMouseEnterProvides handling for the MouseEnter event. (Overrides Control.OnMouseEnter(MouseEventArgs).)
Protected methodOnMouseLeaveProvides handling for the MouseLeave event. (Overrides Control.OnMouseLeave(MouseEventArgs).)
Protected methodOnMouseLeftButtonDownProvides handling for the MouseLeftButtonDown event. (Overrides Control.OnMouseLeftButtonDown(MouseButtonEventArgs).)
Protected methodOnMouseLeftButtonUpProvides handling for the MouseLeftButtonUp event. (Overrides Control.OnMouseLeftButtonUp(MouseButtonEventArgs).)
Protected methodOnMouseMoveProvided handling for the MouseMove event. (Overrides Control.OnMouseMove(MouseEventArgs).)
Protected methodOnMouseRightButtonDownCalled before the MouseRightButtonDown event occurs. (Inherited from Control.)
Protected methodOnMouseRightButtonUpCalled before the MouseRightButtonUp event occurs. (Inherited from Control.)
Protected methodOnMouseWheelCalled before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
Protected methodOnSelectedItemChangedRaises the SelectedItemChanged event when the SelectedItem property value changes.
Protected methodOnTextInputCalled before the TextInput event occurs. (Inherited from ItemsControl.)
Protected methodOnTextInputStartCalled before the TextInputStart event occurs. (Inherited from Control.)
Protected methodOnTextInputUpdateCalled before the TextInputUpdate event occurs. (Inherited from Control.)
Protected methodPrepareContainerForItemOverridePrepares the container element to display the specified item. (Overrides ItemsControl.PrepareContainerForItemOverride(DependencyObject, Object).)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodReleaseMouseCaptureRemoves mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public methodRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
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 eventDataContextChangedOccurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public eventDragEnterOccurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public eventDragLeaveOccurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public eventDragOverOccurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public eventDropOccurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public eventGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventIsEnabledChangedOccurs when the IsEnabled property changes. (Inherited from Control.)
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 Silverlight 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 mouse capture. (Inherited from UIElement.)
Public eventMediaCommandOccurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public eventMouseEnterOccurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeaveOccurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public eventMouseLeftButtonDownOccurs 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.)
Public eventMouseLeftButtonUpOccurs 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.)
Public eventMouseMoveOccurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public eventMouseRightButtonDownOccurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventMouseRightButtonUpOccurs 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.)
Public eventMouseWheelOccurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public eventSelectedItemChangedOccurs when the value of the SelectedItem property changes.
Public eventSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
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 memberItemContainerStylePropertyIdentifies the ItemContainerStyle dependency property.
Public fieldStatic memberSelectedItemPropertyIdentifies the SelectedItem dependency property.
Public fieldStatic memberSelectedValuePathPropertyIdentifies the SelectedValuePath dependency property.
Public fieldStatic memberSelectedValuePropertyIdentifies the SelectedValue dependency property.
Top

The TreeView control displays data in a hierarchical manner. The TreeView control is an ItemsControl, which means you populate the control with content by setting its Items or ItemsSource properties.

The following illustration shows an example of a TreeView control.

TreeView control

Typically, a TreeView control contains TreeViewItem objects. TreeViewItem objects can contain a header and a content item, such as another TreeViewItem, which can contain a header and another TreeViewItem. These nested TreeViewItem controls provide the hierarchy of the TreeView control. The TreeView control enables the user to expand or contract nodes in the hierarchy by using the mouse or the keyboard.

You can get the selected item using the SelectedItem property. When the selected item changes, the SelectedItemChanged event occurs.

You can bind the TreeView to data and use a HierarchicalDataTemplate to display the data in a hierarchical manner. You use the ItemsSource and ItemTemplate property of the data template to specify the source and format of the next level of data that is contained in the TreeView. For more information about how to use a HierarchicalDataTemplate with a TreeView, see How to: Use a TreeView to Display Hierarchical Data.

When the TreeView is bound to data, you can retrieve items by their index or container by using the ItemContainerGenerator associated with the TreeView. For more information about the different kinds of controls and content they can contain display, see Control Content Models.

NoteNote:

The TreeView control is available as part of the libraries in the Silverlight Software Development Kit (SDK). For more information, see the Silverlight Tools.

Customizing the TreeView Control

You can set a custom style for the TreeViewItem objects contained in the TreeView by setting its ItemContainerStyle property.

To apply the same property settings to multiple TreeView controls, use the Style property. To change the visual structure and visual behavior of a TreeView, 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 TreeView is set by its default style, the property might change from its default value when the TreeView appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for TreeView from TreeView Styles and Templates.

NoteNote:

Setting a visual property will only have an effect if that property is both present in TreeView 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.

The following code example show a simple TreeView control. To use the XAML markup, you will need to change the Source property of the Image objects to an absolute or relative URL of an image on your computer.

Run this sample


<StackPanel x:Name="LayoutRoot" Background="White">
    <Border BorderBrush="Black" BorderThickness="2">
        <StackPanel>
            <TextBlock Text="TreeView Example" />
            <sdk:TreeView>
                <sdk:TreeViewItem Header="TreeViewItem containing other items.">
                    <sdk:TreeViewItem.Items>
                        <sdk:TreeViewItem>
                            <sdk:TreeViewItem.Header>
                                <StackPanel Orientation="Horizontal">
                                    <Image Height="15" Width="15" Source="Resources/leave-site.jpg" />
                                    <TextBlock Text="Item 1" Margin="2"/>
                                </StackPanel>
                            </sdk:TreeViewItem.Header>
                        </sdk:TreeViewItem>
                        <sdk:TreeViewItem>
                            <sdk:TreeViewItem.Header>
                                <StackPanel Orientation="Horizontal">
                                    <Image Height="15" Width="15" Source="Resources/switch.jpg" />
                                    <TextBlock Text="Item 2" Margin="2"/>
                                </StackPanel>
                            </sdk:TreeViewItem.Header>
                        </sdk:TreeViewItem>
                    </sdk:TreeViewItem.Items>
                </sdk:TreeViewItem>
            </sdk:TreeView>
        </StackPanel>
    </Border>
</StackPanel>


Silverlight

Supported in: 5, 4, 3

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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

Community Additions

Show:
© 2014 Microsoft