Click or drag to resize
ICMSMenuProperties Interface
Base CMS Menu controls properties interface definition.

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0
Syntax
C#
public interface ICMSMenuProperties : ICMSControlProperties, 
	ICMSBaseProperties

The ICMSMenuProperties type exposes the following members.

Properties
  NameDescription
Public propertyApplyMenuDesign
Indicates if apply document menu item properties.
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from ICMSBaseProperties.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from ICMSBaseProperties.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from ICMSBaseProperties.)
Public propertyClassNames
Class name value or several values separated by semicolon.
(Inherited from ICMSControlProperties.)
Public propertyColumns
Columns to select, null or empty returns all columns.
Public propertyCombineWithDefaultCulture
Indicates if the documents from the default culture version should be alternatively used.
(Inherited from ICMSControlProperties.)
Public propertyCSSPrefix
Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels.
Public propertyCultureCode
Culture code, such as en-us.
(Inherited from ICMSControlProperties.)
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
Public propertyHighlightAllItemsInPath
Indicates if all items in the unfolded path should be displayed as highlighted.
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 ICMSControlProperties.)
Public propertyMaxRelativeLevel
Relative level of child documents that should be selected. -1 selects all child documents.
(Inherited from ICMSControlProperties.)
Public propertyOrderBy
Property to set and get the OrderBy.
(Inherited from ICMSBaseProperties.)
Public propertyPath
Path of the documents to be displayed. /% selects all documents.
(Inherited from ICMSControlProperties.)
Public propertySelectedColumns
Columns to select, null or empty returns all columns.
(Inherited from ICMSBaseProperties.)
Public propertySelectOnlyPublished
Indicates if only published documents should be displayed.
(Inherited from ICMSControlProperties.)
Public propertySiteName
Property to set and get the SiteName.
(Inherited from ICMSBaseProperties.)
Public propertyStopProcessing
Stop processing.
(Inherited from ICMSBaseProperties.)
Public propertySubmenuIndicator
Contains a path to image that will be used on the right of every item that contains subitems.
Public propertyTopN
Select top N rows.
(Inherited from ICMSBaseProperties.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from ICMSControlProperties.)
Public propertyUseAlternatingStyles
Indicates if alternating styles should be used for even and odd items in the same level of the menu.
Public propertyUseItemImagesForHighlightedItem
Indicates if highlighted images is not specified, use item image if exist.
Public propertyWhereCondition
Property to set and get the WhereCondition.
(Inherited from ICMSBaseProperties.)
Public propertyWordWrap
Indicates if text can be wrapped or space is replaced with 'nbsp' entity.
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
Top
Methods
  NameDescription
Public methodReloadData
Reload control data.
(Inherited from ICMSControlProperties.)
Top
See Also