|
||
The following properties of the CMSSiteMap control can be set or used in the API:
All of the common properties from:
•CMS controls - common properties
•CMS navigation - common properties
In addition, the following properties are available:
Property Name |
Description |
Sample Value |
ApplyMenuInactivation |
If checked, documents in the site map that are set as Inactive menu items will not be rendered as links. This setting can be configured for individual documents in CMS Desk -> Content -> Edit -> Properties -> Menu. |
|
EncodeMenuCaption |
Indicates whether HTML encoding should be applied to the captions of site map items. Useful only in special cases where the names of the displayed documents contain HTML code. |
|
LoadDataAutomaticaly |
Indicates whether data for the control should be loaded automatically. This is performed by default.
If you set this property to false, you can enter a custom DataSet into the DataSource property and then call the ReloadData(false) method. |
|
OrderBy |
Gets or sets the ORDER BY clause of the SQL statement.
Please be aware that it is necessary for the root of the displayed tree (or sub-tree) to be first in the resulting order, otherwise all documents may not be displayed correctly. This can be ensured by having the value of this property start with the NodeLevel column, such as in the sample value. |
"NodeLevel, NodeOrder" |
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 |
If enabled, the site map will render document names as Title attributes (tooltips) for all links. This can improve the accessibility of your website. |
|
UrlTarget |
Specifies the target frame for all links in the site map. |
"_blank" |
Mentioned method:
Method Name |
Description |
ReloadData(bool forceLoad) |
Reloads the data.
If the forceLoad parameter is set to false and a value is assigned to the DataSource property, the properties of the CMSSiteMap control are not used and only the data from the DataSource is used. |