ICMSMenuProperties Interface

Base CMS Menu controls properties interface definition.

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

Syntax

public interface ICMSMenuProperties : ICMSControlProperties, 
	ICMSBaseProperties

The ICMSMenuProperties type exposes the following members.

Properties

	Name	Description
Public property	ApplyMenuDesign	Indicates if apply document menu item properties.
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from ICMSBaseProperties.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from ICMSBaseProperties.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from ICMSBaseProperties.)
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 ICMSControlProperties.)
Public property	ClassNames	Class name value or several values separated by semicolon. (Inherited from ICMSControlProperties.)
Public property	Columns	Columns to select, null or empty returns all columns.
Public property	CombineWithDefaultCulture	Indicates if the documents from the default culture version should be alternatively used. (Inherited from ICMSControlProperties.)
Public property	CSSPrefix	Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels.
Public property	CultureCode	Culture code, such as en-us. (Inherited from ICMSControlProperties.)
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False.
Public property	HighlightAllItemsInPath	Indicates if all items in the unfolded path should be displayed as highlighted.
Public property	MaxRelativeLevel	Relative level of child documents that should be selected. -1 selects all child documents. (Inherited from ICMSControlProperties.)
Public property	OrderBy	Property to set and get the OrderBy. (Inherited from ICMSBaseProperties.)
Public property	Path	Path of the documents to be displayed. /% selects all documents. (Inherited from ICMSControlProperties.)
Public property	SelectedColumns	Columns to select, null or empty returns all columns. (Inherited from ICMSBaseProperties.)
Public property	SelectOnlyPublished	Indicates if only published documents should be displayed. (Inherited from ICMSControlProperties.)
Public property	SiteName	Property to set and get the SiteName. (Inherited from ICMSBaseProperties.)
Public property	StopProcessing	Stop processing. (Inherited from ICMSBaseProperties.)
Public property	SubmenuIndicator	Contains a path to image that will be used on the right of every item that contains subitems.
Public property	TopN	Select top N rows. (Inherited from ICMSBaseProperties.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created. (Inherited from ICMSControlProperties.)
Public property	UseAlternatingStyles	Indicates if alternating styles should be used for even and odd items in the same level of the menu.
Public property	UseItemImagesForHighlightedItem	Indicates if highlighted images is not specified, use item image if exist.
Public property	WhereCondition	Property to set and get the WhereCondition. (Inherited from ICMSBaseProperties.)
Public property	WordWrap	Indicates if text can be wrapped or space is replaced with 'nbsp' entity.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows.

Methods

	Name	Description
Public method	ReloadData	Reload control data. (Inherited from ICMSControlProperties.)