CMSAbstractMenuProperties Class |
Namespace: CMS.DocumentEngine.Web.UI
public abstract class CMSAbstractMenuProperties : CMSAbstractControlProperties, ICMSMenuProperties, ICMSControlProperties, ICMSBaseProperties
The CMSAbstractMenuProperties type exposes the following members.
Name | Description | |
---|---|---|
CMSAbstractMenuProperties |
Menu properties constructor.
| |
CMSAbstractMenuProperties(HtmlTextWriterTag) |
Menu properties constructor.
|
Name | Description | |
---|---|---|
mControlContext |
Control context.
(Inherited from CMSAbstractBaseProperties.) | |
mCSSPrefixes |
CSS Prefixes.
| |
mDataSource |
Data source variable.
(Inherited from CMSAbstractControlProperties.) | |
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.
| |
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.
| |
CombineWithDefaultCulture |
Property to set and get the CombineWithDefaultCulture flag.
(Inherited from CMSAbstractControlProperties.) | |
ContextResolver |
Gets current macro resolver.
| |
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.
| |
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 '*'.
| |
FilterOutDuplicates |
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSAbstractControlProperties.) | |
GroupedDS |
Grouped data source.
| |
HideControlForZeroRows |
Hides the control when no data is loaded. Default value is False.
| |
HighlightAllItemsInPath |
Indicates if all items in the unfolded path should be displayed as highlighted.
| |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSWebControl.) | |
MaxRelativeLevel |
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.) | |
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.
(Overrides CMSAbstractControlPropertiesPath.) | |
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.
| |
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.) | |
UseAlternatingStyles |
Indicates if alternating styles should be used for even and odd items in the same level of the menu.
| |
UseItemImagesForHighlightedItem |
Indicates if highlighted images is not specified, use item image if exist.
| |
WhereCondition |
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) | |
WordWrap |
Indicates if text can be wrapped or space is replaced with 'nbsp' entity.
| |
ZeroRowsText |
Text to be shown when the control is hidden by HideControlForZeroRows.
|
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
| |
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.
| |
GetDataSource |
Returns data - either from database or from cache.
| |
GetDataSource(Boolean) |
Returns data - either from database or from cache.
| |
GetDefaultCacheDependencies |
Gets the default cache dependencies for the data source.
(Overrides CMSAbstractControlPropertiesGetDefaultCacheDependencies.) | |
GetMenuItems |
Reads sitemap items or menu items from the database and returns them as a DataSet.
| |
HandleCulture |
Appends culture parameter to query. Handles "##ALL##" macro
(Inherited from CMSAbstractControlProperties.) | |
InitControl |
Ensures default data binding
| |
OnInit |
Init event
(Overrides CMSWebControlOnInit(EventArgs).) | |
OnLoad |
Load event
(Overrides ControlOnLoad(EventArgs).) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSAbstractBaseProperties.) | |
ReloadData |
Reload control data.
(Inherited from CMSAbstractControlProperties.) | |
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.) |