CMSListMenu Class |
Namespace: CMS.DocumentEngine.Web.UI
public class CMSListMenu : CMSAbstractMenuProperties
The CMSListMenu type exposes the following members.
Name | Description | |
---|---|---|
CMSListMenu |
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.
| |
mParent |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
mStopProcessing |
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.) | |
mTreeProvider |
Tree provider variable.
(Inherited from CMSAbstractControlProperties.) | |
mULlevelIndent |
UL level indent.
|
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.) | |
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.) | |
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.) | |
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.) | |
DisplayHighlightedItemAsLink |
Indicates if the highlighted item should be displayed as a link.
| |
DisplayOnlySelectedPath |
Specifies whether all submenus should be displayed or just submenu under highlighted (selected) item.
| |
EncodeMenuCaption |
Indicates if menu caption should be HTML encoded.
| |
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.) | |
FirstItemCssClass |
Specifies CSS class for the first item in every menu level.
| |
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.) | |
HighlightedNodePath |
Path of the item that will be highlighted like it was selected. The path type must be the same as PathType. If you omit this value, the control automatically uses the current alias path from the "aliaspath" querystring parameter.
| |
HoverCSSClassName |
Hover CSS class name.
| |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSWebControl.) | |
ItemIdPrefix |
Item ID preffix..
| |
LastItemCssClass |
Specifies CSS class for the last item in every menu level.
| |
LoadDataAutomaticaly |
Indicates if data will be loaded automatically.
| |
MaxRelativeLevel |
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.) | |
OnMouseOutScript |
OnMouseOutScript script for menu items. You can use macro expressions here.
| |
OnMouseOverScript |
OnMouseOver script for menu items. You can use macro expressions here.
| |
OrderBy |
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) | |
ParentControl |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
Path |
Property to set and get the Path.
(Inherited from CMSAbstractMenuProperties.) | |
RenderCssClasses |
Indicates if CSS classes should be rendered for every element. If set to false, only first and last item of menu level will use CSS class.
| |
RenderedHTML |
Gets or set rendered HTML code.
| |
RenderImageAlt |
Render the image alt attribute?
| |
RenderItemID |
Indicates if unique ID should be rendered for every menu item.
| |
RenderLinkTitle |
Render the link title attribute?
| |
RenderStyleForItemLink |
Gets or sets the value that indicates whether menu style should be rendered for link item.
| |
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.) | |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
SiteName |
Site code name.
(Inherited from CMSAbstractBaseProperties.) | |
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.) | |
UrlTarget |
Specifies target frame for all URLs.
| |
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.) | |
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.) |
Name | Description | |
---|---|---|
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.) | |
GetDefaultCacheDependencies |
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractMenuProperties.) | |
GetMenuItems |
Reads sitemap items or menu items from the database and returns them as a DataSet.
(Inherited from CMSAbstractMenuProperties.) | |
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
(Inherited from CMSAbstractMenuProperties.) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSAbstractBaseProperties.) | |
ReloadData |
Reload 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.) | |
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.) | |
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 ControlsExtensions.) | |
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.) |