CMSSiteMap Class

Site map control that displays the whole menu structure or it part.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.DocumentEngine.Web.UI.CMSAbstractBaseProperties
          CMS.DocumentEngine.Web.UI.CMSAbstractControlProperties
            CMS.DocumentEngine.Web.UI.CMSAbstractMenuProperties
              CMS.DocumentEngine.Web.UI.CMSSiteMap

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class CMSSiteMap : CMSAbstractMenuProperties

The CMSSiteMap type exposes the following members.

Constructors

	Name	Description
Public method	CMSSiteMap

Fields

	Name	Description
Protected field	mControlContext	Control context. (Inherited from CMSAbstractBaseProperties.)
Protected field	mCSSPrefixes	CSS Prefixes. (Inherited from CMSAbstractMenuProperties.)
Protected field	mDataSource	Data source variable. (Inherited from CMSAbstractControlProperties.)
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mParent	Parent control. (Inherited from CMSAbstractBaseProperties.)
Protected field	mStopProcessing	Stop processing this control. (Inherited from CMSAbstractBaseProperties.)
Protected field	mTreeProvider	Tree provider variable. (Inherited from CMSAbstractControlProperties.)

Properties

	Name	Description
Public property	ApplyMenuDesign	Indicates if apply document menu item properties. (Inherited from CMSAbstractMenuProperties.)
Public property	ApplyMenuInactivation	Indicates whether the sitemap should apply menu inactivation flag.
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from CMSAbstractBaseProperties.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from CMSAbstractBaseProperties.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from CMSAbstractBaseProperties.)
Public property	CheckPermissions	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 property	ClassNames	Property to set and get the class names list (separated by the semicolon). (Inherited from CMSAbstractControlProperties.)
Public property	Columns	Gets or sets the columns to be retrieved from database. (Inherited from CMSAbstractMenuProperties.)
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag. (Inherited from CMSAbstractControlProperties.)
Public property	ContextResolver	Gets current macro resolver. (Inherited from CMSAbstractMenuProperties.)
Public property	ControlContext	Control context. (Inherited from CMSAbstractBaseProperties.)
Public property	ControlTagKey	Overrides the generation of the SPAN tag with custom tag. (Inherited from CMSAbstractBaseProperties.)
Public property	CSSPrefix	Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels. (Inherited from CMSAbstractMenuProperties.)
Public property	CultureCode	Property to set and get the CultureCode. (Inherited from CMSAbstractControlProperties.)
Public property	DataSource	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 property	DefaultColumns	Gets the default columns which are used to retrieve data if Columns property not set to '*'. (Inherited from CMSAbstractMenuProperties.)
Public property	EncodeMenuCaption	Indicates if menu caption should be HTML encoded.
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data. (Inherited from CMSAbstractControlProperties.)
Public property	GroupedDS	Grouped data source. (Inherited from CMSAbstractMenuProperties.)
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False. (Inherited from CMSAbstractMenuProperties.)
Public property	HighlightAllItemsInPath	Indicates if all items in the unfolded path should be displayed as highlighted. (Inherited from CMSAbstractMenuProperties.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	LoadDataAutomaticaly	Indicates if data will be loaded automatically.
Public property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel. (Inherited from CMSAbstractControlProperties.)
Public property	OrderBy	ORDER BY part of the SQL statement. (Inherited from CMSAbstractBaseProperties.)
Public property	ParentControl	Parent control. (Inherited from CMSAbstractBaseProperties.)
Public property	Path	Property to set and get the Path. (Inherited from CMSAbstractMenuProperties.)
Public property	RenderedHTML	Gets or set rendered HTML code.
Public property	RenderLinkTitle	Render the link title attribute?
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database. (Inherited from CMSAbstractBaseProperties.)
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag. (Inherited from CMSAbstractControlProperties.)
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	SiteName	Site code name. (Inherited from CMSAbstractBaseProperties.)
Public property	StopProcessing	Indicates if processing of the control should be stopped and the control should not retrieve or display any data. (Inherited from CMSAbstractBaseProperties.)
Public property	SubmenuIndicator	Contains a path to image that will be used on the right of every item that contains sub items. (Inherited from CMSAbstractMenuProperties.)
Public property	TopN	Select top N rows. (Inherited from CMSAbstractBaseProperties.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created. (Inherited from CMSAbstractControlProperties.)
Public property	UrlTarget	Specifies target frame for all URLs.
Public property	UseAlternatingStyles	Indicates if alternating styles should be used for even and odd items in the same level of the menu. (Inherited from CMSAbstractMenuProperties.)
Public property	UseItemImagesForHighlightedItem	Indicates if highlighted images is not specified, use item image if exist. (Inherited from CMSAbstractMenuProperties.)
Public property	WhereCondition	WHERE part of the SQL statement. (Inherited from CMSAbstractBaseProperties.)
Public property	WordWrap	Indicates if text can be wrapped or space is replaced with 'nbsp' entity. (Inherited from CMSAbstractMenuProperties.)
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows. (Inherited from CMSAbstractMenuProperties.)

Methods

	Name	Description
Public method	GetCacheDependency	Gets the cache dependency for the control. (Inherited from CMSAbstractBaseProperties.)
Public method	GetColumns	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 method	GetCSSPrefix	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 method	GetDataSource()	Returns data - either from database or from cache. (Inherited from CMSAbstractMenuProperties.)
Public method	GetDataSource(Boolean)	Returns data - either from database or from cache. (Inherited from CMSAbstractMenuProperties.)
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source. (Inherited from CMSAbstractMenuProperties.)
Protected method	GetItems	Returns source code of items under specified parent node.
Protected method	GetMenuItems	Reads sitemap items or menu items from the database and returns them as a DataSet. (Inherited from CMSAbstractMenuProperties.)
Protected method	GetSiteMap	Returns string representation of site map source code.
Protected method	HandleCulture	Appends culture parameter to query. Handles "##ALL##" macro (Inherited from CMSAbstractControlProperties.)
Protected method	InitControl	Ensures default data binding (Inherited from CMSAbstractMenuProperties.)
Protected method	OnInit	Init event (Inherited from CMSAbstractMenuProperties.)
Protected method	OnLoad	OnLoad. (Overrides CMSAbstractMenuProperties.OnLoad(EventArgs).)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSAbstractBaseProperties.)
Public method	ReloadData	Reload data. (Overrides CMSAbstractControlProperties.ReloadData(Boolean).)
Protected method	Render	Renders the control. (Overrides WebControl.Render(HtmlTextWriter).)
Public method	SetContext	Sets the control context. (Inherited from CMSAbstractBaseProperties.)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	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 Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)