Click or drag to resize
CMSSiteMap Class
Site map control that displays the whole menu structure or it part.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0
Syntax
C#
public class CMSSiteMap : CMSAbstractMenuProperties

The CMSSiteMap type exposes the following members.

Constructors
  NameDescription
Public methodCMSSiteMap
Top
Fields
  NameDescription
Protected fieldmControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmCSSPrefixes
CSS Prefixes.
(Inherited from CMSAbstractMenuProperties.)
Protected fieldmDataSource
Data source variable.
(Inherited from CMSAbstractControlProperties.)
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmParent
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmStopProcessing
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmTreeProvider
Tree provider variable.
(Inherited from CMSAbstractControlProperties.)
Top
Properties
  NameDescription
Public propertyApplyMenuDesign
Indicates if apply document menu item properties.
(Inherited from CMSAbstractMenuProperties.)
Public propertyApplyMenuInactivation
Indicates whether the sitemap should apply menu inactivation flag.
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCheckPermissions
Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
(Inherited from CMSAbstractControlProperties.)
Public propertyClassNames
Property to set and get the class names list (separated by the semicolon).
(Inherited from CMSAbstractControlProperties.)
Public propertyColumns
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractMenuProperties.)
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
(Inherited from CMSAbstractControlProperties.)
Public propertyContextResolver
Gets current macro resolver.
(Inherited from CMSAbstractMenuProperties.)
Public propertyControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Public propertyControlTagKey
Overrides the generation of the SPAN tag with custom tag.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCSSPrefix
Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels.
(Inherited from CMSAbstractMenuProperties.)
Public propertyCultureCode
Property to set and get the CultureCode.
(Inherited from CMSAbstractControlProperties.)
Public propertyDataSource
Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
(Inherited from CMSAbstractControlProperties.)
Public propertyDefaultColumns
Gets the default columns which are used to retrieve data if Columns property not set to '*'.
(Inherited from CMSAbstractMenuProperties.)
Public propertyEncodeMenuCaption
Indicates if menu caption should be HTML encoded.
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSAbstractControlProperties.)
Public propertyGroupedDS
Grouped data source.
(Inherited from CMSAbstractMenuProperties.)
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
(Inherited from CMSAbstractMenuProperties.)
Public propertyHighlightAllItemsInPath
Indicates if all items in the unfolded path should be displayed as highlighted.
(Inherited from CMSAbstractMenuProperties.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyLoadDataAutomaticaly
Indicates if data will be loaded automatically.
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.)
Public propertyOrderBy
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Public propertyParentControl
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Public propertyPath
Property to set and get the Path.
(Inherited from CMSAbstractMenuProperties.)
Public propertyRenderedHTML
Gets or set rendered HTML code.
Public propertyRenderLinkTitle
Render the link title attribute?
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
(Inherited from CMSAbstractControlProperties.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySiteName
Site code name.
(Inherited from CMSAbstractBaseProperties.)
Public propertyStopProcessing
Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
(Inherited from CMSAbstractBaseProperties.)
Public propertySubmenuIndicator
Contains a path to image that will be used on the right of every item that contains sub items.
(Inherited from CMSAbstractMenuProperties.)
Public propertyTopN
Select top N rows.
(Inherited from CMSAbstractBaseProperties.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from CMSAbstractControlProperties.)
Public propertyUrlTarget
Specifies target frame for all URLs.
Public propertyUseAlternatingStyles
Indicates if alternating styles should be used for even and odd items in the same level of the menu.
(Inherited from CMSAbstractMenuProperties.)
Public propertyUseItemImagesForHighlightedItem
Indicates if highlighted images is not specified, use item image if exist.
(Inherited from CMSAbstractMenuProperties.)
Public propertyWhereCondition
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Public propertyWordWrap
Indicates if text can be wrapped or space is replaced with 'nbsp' entity.
(Inherited from CMSAbstractMenuProperties.)
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
(Inherited from CMSAbstractMenuProperties.)
Top
Methods
  NameDescription
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.)
Public methodGetColumns
Returns list of columns which should be retrieved from database. If Columns property is not set, default columns are returned. If Columns property contains "*", "*" for all columns is returned Otherwise columns defined in Columns property are merged with default columns
(Inherited from CMSAbstractMenuProperties.)
Public methodGetCSSPrefix
Returns CSS prefix for the specified menu level. If no particular prefix is specified for the level, it returns CSS class for the last defined level.
(Inherited from CMSAbstractMenuProperties.)
Public methodGetDataSource
Returns data - either from database or from cache.
(Inherited from CMSAbstractMenuProperties.)
Public methodGetDataSource(Boolean)
Returns data - either from database or from cache.
(Inherited from CMSAbstractMenuProperties.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractMenuProperties.)
Protected methodGetItems
Returns source code of items under specified parent node.
Protected methodGetMenuItems
Reads sitemap items or menu items from the database and returns them as a DataSet.
(Inherited from CMSAbstractMenuProperties.)
Protected methodGetSiteMap
Returns string representation of site map source code.
Protected methodHandleCulture
Appends culture parameter to query. Handles "##ALL##" macro
(Inherited from CMSAbstractControlProperties.)
Protected methodInitControl
Ensures default data binding
(Inherited from CMSAbstractMenuProperties.)
Protected methodOnInit
Init event
(Inherited from CMSAbstractMenuProperties.)
Protected methodOnLoad
OnLoad.
(Overrides CMSAbstractMenuPropertiesOnLoad(EventArgs).)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSAbstractBaseProperties.)
Public methodReloadData
Reload data.
(Overrides CMSAbstractControlPropertiesReloadData(Boolean).)
Protected methodRender
Renders the control.
(Overrides WebControlRender(HtmlTextWriter).)
Public methodSetContext
Sets the control context.
(Inherited from CMSAbstractBaseProperties.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
Public Extension MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
See Also