Is this really the version you are looking for? Kentico Xperience 8 Documentation is no longer updated. Use the switcher in the header to choose your product version.
The CMSBreadCrumbs control shows users their current position within Kentico websites in format:
Item 1 > Item 2 > Item 3
Where Item X are the names of parent documents in the current path.
Web part equivalent (portal engine): Breadcrumbs
The following is a step-by-step tutorial that shows how to display a user's current location within the structure of a website using the CMSBreadCrumbs control:
The control displays the current position on the website.
You can set the following properties for the CMSBreadCrumbs control:
CMSBreadCrumbs properties | Description | Sample value |
|---|---|---|
BreadCrumbSeparator | Characters that separate the breadcrumbs. You can use HTML code here. | ">>" |
BreadCrumbSeparatorRTL | Characters that separate the bread crumbs in RTL (right-to-left) mode. You can use HTML code here. | "<<" |
DefaultPath | Sets a default path displayed in the breadcrumbs if no path is provided from the current page context. | "/home" |
EncodeName | Indicates whether the control HTML encodes the items in the breadcrumbs. | |
IgnoreShowInNavigation | The control ignores the ShowInNavigation property of documents if this property is true. | |
LoadDataAutomaticaly | Indicates whether the control automatically loads document data. True by default. |
If you set this property to false, you need to assign a custom DataSet into the DataSource property and then call the control's ReloadData method.
RenderedHTML | Allows you to get or set the HTML code rendered by the control. You need to set this property before the Render event - e.g. in the OnLoad event. |
RenderLinkTitle | Indicates if the control renders TITLE tags for links containing the corresponding document names (for better website accessibility). |
ShowCurrentItem | Indicates if the breadcrumbs display the current (last) item. True by default. |
ShowCurrentItemAsLink | Indicates if the breadcrumbs display the current (last) item as a link. False by default. |
StartingPath | Selects a document from which the path in the breadcrumbs starts. Enter / (root document) to have the breadcrumbs display the full website path. For example, if you set this value to /News and go to /News/Events/2013, the breadcrumbs only display Events -> 2013. | "/products" |
UrlTarget | Specifies the target frame for all links generated by the breadcrumbs. | "_blank" |
UseRtlBehaviour | Indicates whether the control renders the breadcrumbs from right to left for RTL cultures. |
Common navigation properties | Description | Sample value |
|---|---|---|
ApplyMenuDesign | Indicates whether the control applies document menu design settings. True by default. | |
Columns | Contains the names of columns that the control loads for documents (menu items) in addition to the default columns. If you need data from other columns, type their names separated by commas. Note: To find a full list of the default navigation columns, use the SQL queries debuggingtool and inspect the query performed by your navigation control. | "DocumentPageTitle, |
HideControlForZeroRows | Indicates whether the control should be hidden when no data is loaded. Default value is False. | |
HighlightAllItemsInPath | Indicates whether the control highlights all items on the visitor's current path. | |
SubmenuIndicator | Path to an image displayed next to every menu item that contains sub-items. | |
UseAlternatingStyles | Indicates whether the control uses alternating styles for even and odd items on the same menu level. | |
UseItemImagesForHiglightedItem | Indicates whether the control uses the item image if the highlighted image is not specified. | |
WordWrap | Indicates whether text displayed by the control uses word wrapping. If disabled, text that is too long is replaced by 'nbsp'. | |
ZeroRowsText | Text shown when the control is hidden by the HideControlForZeroRows property. | "No records found." |
Document filtering properties | Description | Sample value |
|---|---|---|
CheckPermissions | Indicates if the control checks the permissions of the user viewing the page. If the value is false (default value) no permissions are checked. If true, the control only loads documents for which the user viewing the page has read permissions. | |
ClassNames | Specifies which document types the control loads and displays. Identify document types through their code names, separated by semicolons (;). You can use the * wildcard as a substitute for any number of characters. For example Product.* includes the document types Product.Camera, Product.CellPhone, Product.Computer etc. If the property is left empty, the control retrieves all document types by default. In the case of menu and navigation controls, only page (CMS.MenuItem) documents are loaded by default. Note: If the control loads all document types (empty value), only the common data columns from the View_CMS_Tree_Joined view are available in the retrieved data. The specific fields of individual document types are not included. You need to keep this in mind when writing the code of transformations, WHERE conditions, ORDER BY expressions etc. | "cms.news" |
CombineWithDefaultCulture | Indicates whether the control loads documents from the website's default culture version if the required documents are not available in the user's selected culture. Only applies if you do not set the TreeProvider property manually. | |
CultureCode | Specifies the culture code of the documents that the control loads. If not specified, the control automatically uses the preferred culture of the user viewing the page. | "en-us" |
DataSource | Allows you to manually assign a DataSet or DataTable containing the documents that the control displays. You do not need to set this property for standard scenarios. | |
FilterOutDuplicates | Indicates if the control filters out duplicated (linked) documents from the data. | |
MaxRelativeLevel | Specifies the maximum number of content tree sub-levels from which the control displays documents. This number is relative, i.e. counted from the location of the page where the control is placed, not from the root of the website. Enter -1 to load all child documents. | |
Path | Path of the documents that the control loads. | |
SelectOnlyPublished | If enabled, the control only loads published documents. | |
TreeProvider | Gets or sets the TreeProvider object used by the control to access document data. If you do not assign a TreeProvider object, the control automatically creates a new instance. |
CMS Base control properties | Description | Sample value |
|---|---|---|
CacheDependencies | List of the cache keys on which the control's cached data depends. When the specified cache items change, the control clears its cache. Each item (dependency) must be on one line. If you leave this property empty, the control uses default dependencies. See also: Setting cache dependencies, Configuring caching | cms.user|all |
CacheItemName | Sets the name of the cache key used to store the control's content. If you leave the value empty, the system generates a default name containing variables, such as the control ID, the selected culture and the name of the user who loaded the page. The system cache is shared by all pages in your application, so cache item names representing different data must be unique globally. If you have multiple controls that load the same data, you can share the cache keys between the controls (optimizes loading of content and avoids redundant data in the cache). If the content displayed by the control depends on variables, such as URL parameters, you can set a custom name dynamically in the page's code behind. See also: Caching the data of page components, Configuring caching | "CMSRepeaterNews" + |
CacheMinutes | Sets the number of minutes for which the control caches content retrieved from the database.
Allows you to set up caching of content so that the control doesn't have to retrieve content from the database on each request. The caching mechanism uses absolute expiration time. This means that cache items expire after a specified time period even if the page containing the control wasn't requested. See also: Caching the data of page components, Configuring caching | |
FilterControl | Gets or sets the filter control used to limit the data read by the control. | |
FilterName | Gets or sets the code name of the filter control used to limit the data read by this control. | |
OrderBy | Gets or sets the ORDER BY clause of the SQL query that the control uses to load data. | "NewsReleaseDate DESC" |
SelectedColumns | Database table columns that the control loads for documents, separated by commas ( , ). If null or empty, the control loads all available columns. | |
SiteName | Specifies the code name of the Kentico website for which the control loads data. | |
StopProcessing | If true, the control stops all processing — does not load or display any data or other HTML output. | |
TopN | Specifies the maximum number of database records that the control loads. | |
WhereCondition | Gets or sets the WHERE clause of the SQL query that the control uses to loads data. | "ProductPrice > 100" |
The appearance of the CMSBreadCrumbs control is determined by its properties and CSS classes. You can use the following CSS classes to modify the design of the control:
CSS class name | Applies to |
|---|---|
CMSBreadCrumbsLink | Links (A elements) in the breadcrumbs path. |
CMSBreadCrumbsCurrentItem | The last item in the breadcrumbs, representing the user's current location. |
The recommended place to define these classes is in a Kentico stylesheet using the CSS stylesheets application.
You can apply stylesheets to: