CMSMenu Class |
Namespace: CMS.Controls
public class CMSMenu : CMSAbstractMenuProperties
The CMSMenu type exposes the following members.
Name | Description | |
---|---|---|
AddMenuItemSeparator |
Add separator to the menu in top level.
| |
CreateChildControls |
Creates child controls collection.
(Overrides ControlCreateChildControls.) | |
GetCacheDependency |
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.) | |
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.) | |
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.) | |
GetDataSource |
Returns data - either from database or from cache.
(Inherited from CMSAbstractMenuProperties.) | |
GetDataSource(Boolean) |
Returns data - either from database or from cache.
(Inherited from CMSAbstractMenuProperties.) | |
GetDefaultCacheDependencies |
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractMenuProperties.) | |
GetItemUrl |
Returns URL to menu item, depend on site name.
(Inherited from CMSAbstractMenuProperties.) | |
GetMenuItems |
Reads sitemap items or menu items from the database and returns them as a DataSet.
(Inherited from CMSAbstractMenuProperties.) | |
GetMinNodeLevel |
Returns minimum NodeLevel of all nodes in the provided dataset.
| |
GetNewMenuItem |
Returns a new MenuItem object based on provided data row.
| |
HandleCulture |
Appends culture parameter to query. Handles "##ALL##" macro
(Inherited from CMSAbstractControlProperties.) | |
InitControl |
Ensures default data binding
(Overrides CMSAbstractMenuPropertiesInitControl(Boolean).) | |
OnInit |
Init event
(Inherited from CMSAbstractMenuProperties.) | |
OnLoad |
Load event handler.
(Overrides CMSAbstractMenuPropertiesOnLoad(EventArgs).) | |
ProcessMainMenuItemDR |
Creates menu items at the top level.
| |
ProcessSubItem |
Gets a menu item and creates its subitems.
| |
ReleaseContext |
Releases the control context.
(Inherited from CMSAbstractBaseProperties.) | |
ReloadData |
Reloads the menu data.
(Overrides CMSAbstractControlPropertiesReloadData(Boolean).) | |
Render |
Renders the control.
(Overrides WebControlRender(HtmlTextWriter).) | |
SetContext |
Sets the control context.
(Inherited from CMSAbstractBaseProperties.) |
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
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.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Name | Description | |
---|---|---|
mControlContext |
Control context.
(Inherited from CMSAbstractBaseProperties.) | |
mCSSPrefixes |
CSS Prefixes.
(Inherited from CMSAbstractMenuProperties.) | |
mDataSource |
Data source variable.
(Inherited from CMSAbstractControlProperties.) | |
mFilterControl |
Filter control.
| |
mFilterName |
Filter name.
| |
mHighlightedMenuItem |
Currently highlighted menu item.
| |
mMenu |
Menu object.
| |
mParent |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
mStopProcessing |
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.) | |
mTreeProvider |
Tree provider variable.
(Inherited from CMSAbstractControlProperties.) |
Name | Description | |
---|---|---|
ApplyMenuDesign |
Indicates if apply document menu item properties.
(Inherited from CMSAbstractMenuProperties.) | |
CacheDependencies |
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseProperties.) | |
CacheItemName |
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseProperties.) | |
CacheMinutes |
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractBaseProperties.) | |
ClassNames |
Property to set and get the class names list (separated by the semicolon).
(Inherited from CMSAbstractControlProperties.) | |
Columns |
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractMenuProperties.) | |
CombineWithDefaultCulture |
Property to set and get the CombineWithDefaultCulture flag.
(Inherited from CMSAbstractControlProperties.) | |
ContextResolver |
Gets current macro resolver.
(Inherited from CMSAbstractMenuProperties.) | |
ControlContext |
Control context.
(Inherited from CMSAbstractBaseProperties.) | |
ControlTagKey |
Overrides the generation of the SPAN tag with custom tag.
(Inherited from CMSAbstractBaseProperties.) | |
CSSPrefix |
Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels.
(Inherited from CMSAbstractMenuProperties.) | |
CultureCode |
Property to set and get the CultureCode.
(Inherited from CMSAbstractControlProperties.) | |
Cursor | Represents Cursor for menu (skmMenu) control. | |
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.) | |
DefaultColumns |
Gets the default columns which are used to retrieve data if Columns property not set to '*'.
(Inherited from CMSAbstractMenuProperties.) | |
EnableMouseUpDownClass |
Indicates if are assigned classes for mouse down and up.
| |
EnableRTLBehaviour |
Enable RTL behaviour.
| |
EncodeMenuCaption |
Indicates if menu caption should be HTML encoded.
| |
ExternalScriptPath | Path of the external .js file with skmMenu scripts. The default path is ~/cmsscripts/skmmenu.js. | |
FilterControl |
Filter control.
| |
FilterName |
Gets or Set filter name.
| |
FilterOutDuplicates |
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSAbstractControlProperties.) | |
GroupedDS |
Grouped data source.
(Inherited from CMSAbstractMenuProperties.) | |
HideControlForZeroRows |
Hides the control when no data is loaded. Default value is False.
(Inherited from CMSAbstractMenuProperties.) | |
HighlightAllItemsInPath |
Indicates if all items in the unfolded path should be displayed as highlighted.
(Inherited from CMSAbstractMenuProperties.) | |
HighlightedMenuItem |
Highlighted menu item. You can use it to set its style.
| |
HighlightedNodePath |
Path of the item that will be highlighted like it was selected. If you omit this value, the control automatically uses the current alias path from the "aliaspath" querystring parameter.
| |
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.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSWebControl.) | |
Layout |
Represents Layout for menu (skmMenu) control.
| |
MaxRelativeLevel |
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.) | |
MenuControl |
Menu (skmMenu) control that ensures rendering.
| |
OrderBy |
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) | |
Padding | Padding of the CMSMenu table. | |
ParentControl |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
Path |
Property to set and get the Path.
(Inherited from CMSAbstractMenuProperties.) | |
RenderImageAlt |
Render the image alt attribute?
| |
RenderItemName |
Indicates if ItemName attribute should be rendered.
| |
SelectedColumns |
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.) | |
SelectOnlyPublished |
Property to set and get the SelectOnlyPublished flag.
(Inherited from CMSAbstractControlProperties.) | |
SeparatorCssClass |
Menu item separator CSS class for top level of the menu.
| |
SeparatorHeight |
Menu item separator height for top level of the menu.
| |
SeparatorText |
Menu item separator text for top level of the menu.
| |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
SiteName |
Site code name.
(Inherited from CMSAbstractBaseProperties.) | |
Spacing | Spacing of the CMSMenu table. | |
StopProcessing |
Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
(Inherited from CMSAbstractBaseProperties.) | |
SubmenuIndicator |
Contains a path to image that will be used on the right of every item that contains sub items.
(Inherited from CMSAbstractMenuProperties.) | |
TopN |
Select top N rows.
(Inherited from CMSAbstractBaseProperties.) | |
TreeProvider |
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from CMSAbstractControlProperties.) | |
UIContext |
Returns control's UI context
(Inherited from CMSWebControl.) | |
UseAlternatingStyles |
Indicates if alternating styles should be used for even and odd items in the same level of the menu.
(Inherited from CMSAbstractMenuProperties.) | |
UseItemImagesForHighlightedItem |
Indicates if highlighted images is not specified, use item image if exist.
(Inherited from CMSAbstractMenuProperties.) | |
UseItemImagesForHiglightedItem | Obsolete.
Indicates if highlighted images is not specified, use item image if exist.
(Inherited from CMSAbstractMenuProperties.) | |
WhereCondition |
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) | |
WordWrap |
Indicates if text can be wrapped or space is replaced with 'nbsp' entity.
(Inherited from CMSAbstractMenuProperties.) | |
ZeroRowsText |
Text to be shown when the control is hidden by HideControlForZeroRows.
(Inherited from CMSAbstractMenuProperties.) |