Skip to content

Latest commit

 

History

History
277 lines (219 loc) · 14.6 KB

getting-started.md

File metadata and controls

277 lines (219 loc) · 14.6 KB
title page_title description slug tags published position
Getting Started
Getting Started
Check our "Getting Started" documentation article for the RadBreadcrumb {{ site.framework_name }} control.
radbreadcrumb-getting-started
getting,started
true
1

Getting Started with {{ site.framework_name }} Breadcrumb

This tutorial will walk you through the creation of a RadBreadcrumb.

Assembly References

In order to use RadBreadcrumb in your projects, you have to add references to the following assemblies:

  • Telerik.Licensing.Runtime
  • Telerik.Windows.Controls
  • Telerik.Windows.Controls.Navigation {% if site.site_name == 'WPF' %}
  • Telerik.Windows.Data {% endif %}

You can find the required assemblies for each control from the suite in the {% if site.site_name == 'Silverlight' %}[Controls Dependencies]({%slug installation-installing-controls-dependencies%}){% else %}[Controls Dependencies]({%slug installation-installing-controls-dependencies-wpf%}){% endif %} help article.

tip With the 2025 Q1 release, the Telerik UI for WPF has a new licensing mechanism. You can learn more about it [here]({%slug installing-license-key%}).

Adding Telerik Assemblies Using NuGet

To use RadBreadcrumb when working with NuGet packages, install the Telerik.Windows.Controls.Navigation.for.Wpf.Xaml package. The [package name may vary]({%slug nuget-available-packages%}) slightly based on the Telerik dlls set - [Xaml or NoXaml]({%slug xaml-vs-noxaml%})

Read more about NuGet installation in the [Installing UI for WPF from NuGet Package]({%slug nuget-installation%}) article.

Define a Breadcrumb control

Example 1 demonstrates a basic RadBreadcrumb definition.

[XAML] Example 1: Defining a RadBreadcrumb in XAML

{{region xaml-radbreadcrumb-getting-started_0}} <telerik:RadBreadcrumb x:Name="breadcrumb" Header="Breadcrumb Header" HorizontalAlignment="Stretch" VerticalAlignment="Top"/> {{endregion}}

[C#] Example 2: Defining a RadBreadcrumb in code

{{region cs-radbreadcrumb-getting-started_1}} RadBreadcrumb breadcrumb = new RadBreadcrumb(); breadcrumb.Header = "Breadcrumb Header"; breadcrumb.HorizontalAlignment = System.Windows.HorizontalAlignment.Stretch; breadcrumb.VerticalAlignment = System.Windows.VerticalAlignment.Top; {{endregion}}

[VB.NET] Example 2: Defining a RadBreadcrumb in code

{{region vb-radbreadcrumb-getting-started_2}} Dim breadcrumb As New RadBreadcrumb() breadcrumb.Header = "Breadcrumb Header" breadcrumb.HorizontalAlignment = System.Windows.HorizontalAlignment.Stretch breadcrumb.VerticalAlignment = System.Windows.VerticalAlignment.Top {{endregion}}

{{ site.framework_name }} RadBreadcrumb from Code

The RadBreacrumb control is a HeaderedItemsControl and its Header is used as a root element. Therefore the control always has one root element. If you don't set the Breadcrumb.Header property an empty root element will be created.

So far there is an empty RadBreadcrumb containing no items.

Add and remove items (RadBreadcrumbItem controls) and set their Header and DropDownHeader properties

You can add items to the RadBreadcrumb control by defining RadBreadcrumbItem controls inside the RadBreadcrumb definition in XAML:

[XAML] Example 3: Adding RadBreadcrumbItems in XAML

{{region xaml-radbreadcrumb-getting-started_3}} <telerik:RadBreadcrumb Header="Breadcrumb Header" HorizontalAlignment="Stretch" VerticalAlignment="Top"> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1" DropDownHeader="DropDownItem 1"> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1.1" DropDownHeader="DropDownItem 1.1"/> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1.2" DropDownHeader="DropDownItem 1.2" /> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1.3" DropDownHeader="DropDownItem 1.3" /> </telerik:RadBreadcrumbItem> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2" DropDownHeader="DropDownItem 2"> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2.1" DropDownHeader="DropDownItem 2.1" /> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2.2" DropDownHeader="DropDownItem 2.2" /> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2.3" DropDownHeader="DropDownItem 2.3" /> </telerik:RadBreadcrumbItem> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 3" DropDownHeader="DropDownItem 3" /> </telerik:RadBreadcrumb> {{endregion}}

Or you can populate the RadBreadcrumb.Items collection in code-behind:

[C#] Example 4: Adding RadBreadcrumbItems in code

{{region cs-radbreadcrumb-getting-started_4}} RadBreadcrumbItem item1 = new RadBreadcrumbItem() { Header = "BreadcrumbItem 1", DropDownHeader = "DropDownItem 1" }; item1.Items.Add(new RadBreadcrumbItem() { Header = "BreadcrumbItem 1.1", DropDownHeader = "DropDownItem 1.1" }); item1.Items.Add(new RadBreadcrumbItem() { Header = "BreadcrumbItem 1.2", DropDownHeader = "DropDownItem 1.2" }); item1.Items.Add(new RadBreadcrumbItem() { Header = "BreadcrumbItem 1.3", DropDownHeader = "DropDownItem 1.3" }); breadcrumb.Items.Add(item1); RadBreadcrumbItem item2 = new RadBreadcrumbItem() { Header = "BreadcrumbItem 2", DropDownHeader = "DropDownItem 2" }; item2.Items.Add(new RadBreadcrumbItem() { Header = "BreadcrumbItem 2.1", DropDownHeader = "DropDownItem 2.1" }); item2.Items.Add(new RadBreadcrumbItem() { Header = "BreadcrumbItem 2.2", DropDownHeader = "DropDownItem 2.2" }); item2.Items.Add(new RadBreadcrumbItem() { Header = "BreadcrumbItem 2.3", DropDownHeader = "DropDownItem 2.3" }); breadcrumb.Items.Add(item2); RadBreadcrumbItem item3 = new RadBreadcrumbItem() { Header = "BreadcrumbItem 3", DropDownHeader = "DropDownItem 3" }; breadcrumb.Items.Add(item3); {{endregion}}

[VB.NET] Example 4: Adding RadBreadcrumbItems in code

{{region vb-radbreadcrumb-getting-started_5}} Dim item1 As New RadBreadcrumbItem() With { Key .Header = "BreadcrumbItem 1", Key .DropDownHeader = "DropDownItem 1" } item1.Items.Add(New RadBreadcrumbItem() With { Key .Header = "BreadcrumbItem 1.1", Key .DropDownHeader = "DropDownItem 1.1" }) item1.Items.Add(New RadBreadcrumbItem() With { Key .Header = "BreadcrumbItem 1.2", Key .DropDownHeader = "DropDownItem 1.2" }) item1.Items.Add(New RadBreadcrumbItem() With { Key .Header = "BreadcrumbItem 1.3", Key .DropDownHeader = "DropDownItem 1.3" }) breadcrumb.Items.Add(item1)

Dim item2 As New RadBreadcrumbItem() With { 
        Key .Header = "BreadcrumbItem 2", 
        Key .DropDownHeader = "DropDownItem 2" 
}
item2.Items.Add(New RadBreadcrumbItem() With { 
        Key .Header = "BreadcrumbItem 2.1", 
        Key .DropDownHeader = "DropDownItem 2.1" 
})
item2.Items.Add(New RadBreadcrumbItem() With { 
        Key .Header = "BreadcrumbItem 2.2", 
        Key .DropDownHeader = "DropDownItem 2.2" 
})
item2.Items.Add(New RadBreadcrumbItem() With { 
        Key .Header = "BreadcrumbItem 2.3", 
        Key .DropDownHeader = "DropDownItem 2.3" 
})
breadcrumb.Items.Add(item2)

Dim item3 As New RadBreadcrumbItem() With { 
        Key .Header = "BreadcrumbItem 3", 
        Key .DropDownHeader = "DropDownItem 3" 
}
breadcrumb.Items.Add(item3)

{{endregion}}

{{ site.framework_name }} RadBreadcrumb Dropdown Items

In order to remove items from the RadBreadcrumb control, you can remove them from the control's Items collection:

[C#] Example 5: Removing RadBreadcrumbItems

{{region cs-radbreadcrumb-getting-started_6}} breadcrumb.Items.Remove(item2); {{endregion}}

[VB.NET] Example 5: Removing RadBreadcrumbItems

{{region vb-radbreadcrumb-getting-started_7}} breadcrumb.Items.Remove(item2) {{endregion}}

{{ site.framework_name }} RadBreadcrumb with Item Removed

Enable LinearMode

By default the RadBreadcrumb control has two modes - normal and text mode. In the normal mode you can navigate through the Breadcrumb.Items using the BreadcrumbItems and their dropdown content, while in the text mode you can enter the path that you want to navigate to. The control also provides a Linear mode in which the BreadcrumbItem DropDown Items collection is hidden. In Linear mode you can navigate through the Items collection of the control by taking advantage of the text mode of the RadBreadcrumb, using its history, using the key navigation or setting the destination path from code-behind.

In order to enable the Linear mode of the RadBreadcrumb control, you have to set the IsLinearMode property to True :

[XAML] Example 6: Enabling linear mode in XAML

{{region xaml-radbreadcrumb-getting-started_8}} <telerik:RadBreadcrumb Header="Breadcrumb Header" HorizontalAlignment="Stretch" VerticalAlignment="Top" IsLinearMode="True"> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1" DropDownHeader="DropDownItem 1"> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1.1" DropDownHeader="DropDownItem 1.1" /> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1.2" DropDownHeader="DropDownItem 1.2" /> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 1.3" DropDownHeader="DropDownItem 1.3" /> </telerik:RadBreadcrumbItem> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2" DropDownHeader="DropDownItem 2"> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2.1" DropDownHeader="DropDownItem 2.1" /> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2.2" DropDownHeader="DropDownItem 2.2" /> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 2.3" DropDownHeader="DropDownItem 2.3" /> </telerik:RadBreadcrumbItem> <telerik:RadBreadcrumbItem Header="BreadcrumbItem 3" DropDownHeader="DropDownItem 3" /> </telerik:RadBreadcrumb> {{endregion}}

[C#] Example 7: Enabling linear mode in code

{{region cs-radbreadcrumb-getting-started_9}} breadcrumb.IsLinearMode = true; {{endregion}}

[VB.NET] Example 7: Enabling linear mode in code

{{region vb-radbreadcrumb-getting-started_10}} breadcrumb.IsLinearMode = True {{endregion}}

{{ site.framework_name }} RadBreadcrumb Linear Mode

Change the number of paths saved in the Breadcrumb history

By default the RadBreadcrumb control keeps a history of 10 visited paths. If you want to increase or decrease this number, you can set the HistorySize property:

[XAML] Example 8: Setting the history size in XAML

{{region xaml-radbreadcrumb-getting-started_11}} <telerik:RadBreadcrumb Header="Breadcrumb Header" HorizontalAlignment="Stretch" VerticalAlignment="Top" HistorySize="15"> ... </telerik:RadBreadcrumb> {{endregion}}

[C#] Example 9: Setting the history size in code

{{region cs-radbreadcrumb-getting-started_12}} breadcrumb.HistorySize = 15; {{endregion}}

[VB.NET] Example 9: Setting the history size in code

{{region vb-radbreadcrumb-getting-started_13}} breadcrumb.HistorySize = 15 {{endregion}}

Setting a Theme

The controls from our suite support different themes. You can see how to apply a theme different than the default one in the [Setting a Theme]({%slug styling-apperance-implicit-styles-overview%}) help article.

important Changing the theme using implicit styles will affect all controls that have styles defined in the merged resource dictionaries. This is applicable only for the controls in the scope in which the resources are merged.

To change the theme, you can follow the steps below:

  • Choose between the themes and add reference to the corresponding theme assembly (ex: Telerik.Windows.Themes.Fluent.dll). You can see the different themes applied in the Theming examples from our {% if site.site_name == 'WPF' %}WPF Controls Examples{% else %}Silverlight Controls Examples{% endif %} application.

  • Merge the ResourceDictionaries with the namespace required for the controls that you are using from the theme assembly. For the RadBreadcrumb, you will need to merge the following resources:

    • Telerik.Windows.Controls
    • Telerik.Windows.Controls.Navigation

Example 2 demonstrates how to merge the ResourceDictionaries so that they are applied globally for the entire application.

[XAML] Example 2: Merge the ResourceDictionaries

{{region xaml-radbreadcrumb-getting-started_1}} <Application.Resources> <ResourceDictionary.MergedDictionaries> </ResourceDictionary.MergedDictionaries> </Application.Resources> {{endregion}}

Alternatively, you can use the theme of the control via the {% if site.site_name == 'WPF' %}StyleManager{% else %}StyleManager{% endif %}.

Figure 2 shows a RadBreadcrumb with the Fluent theme applied.

Figure 2: RadBreadcrumb with the Fluent theme

RadBreadcrumb with Fluent theme

{% if site.site_name == 'WPF' %}

Telerik UI for WPF Learning Resources

See Also

  • [Overview]({%slug radbreadcrumb-overvew%})
  • [Features Overview]({%slug radbreadcrumb-features-overview%})