Click or drag to resize
CMSAbstractMenuProperties Class
Base menu controls properties.
Inheritance Hierarchy

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 8.2.23
Syntax
C#
public abstract class CMSAbstractMenuProperties : CMSAbstractControlProperties, 
	ICMSMenuProperties, ICMSControlProperties, ICMSBaseProperties

The CMSAbstractMenuProperties type exposes the following members.

Constructors
Methods
  NameDescription
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.)
Public methodGetColumns
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
Public methodGetCSSPrefix
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.
Public methodGetDataSource
Returns data - either from database or from cache.
Public methodGetDataSource(Boolean)
Returns data - either from database or from cache.
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
(Overrides CMSAbstractControlPropertiesGetDefaultCacheDependencies.)
Public methodGetItemUrl
Returns URL to menu item, depend on site name.
Protected methodGetMenuItems
Reads sitemap items or menu items from the database and returns them as a DataSet.
Protected methodHandleCulture
Appends culture parameter to query. Handles "##ALL##" macro
(Inherited from CMSAbstractControlProperties.)
Protected methodInitControl
Ensures default data binding
Protected methodOnInit
Init event
(Overrides CMSWebControlOnInit(EventArgs).)
Protected methodOnLoad
Load event
(Overrides ControlOnLoad(EventArgs).)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSAbstractBaseProperties.)
Public methodReloadData
Reload control data.
(Inherited from CMSAbstractControlProperties.)
Public methodSetContext
Sets the control context.
(Inherited from CMSAbstractBaseProperties.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodCallHandled
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.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldmControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmCSSPrefixes
CSS Prefixes.
Protected fieldmDataSource
Data source variable.
(Inherited from CMSAbstractControlProperties.)
Protected fieldmParent
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmStopProcessing
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmTreeProvider
Tree provider variable.
(Inherited from CMSAbstractControlProperties.)
Top
Properties
  NameDescription
Public propertyApplyMenuDesign
Indicates if apply document menu item properties.
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractBaseProperties.)
Public propertyClassNames
Property to set and get the class names list (separated by the semicolon).
(Inherited from CMSAbstractControlProperties.)
Public propertyColumns
Gets or sets the columns to be retrieved from database.
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
(Inherited from CMSAbstractControlProperties.)
Public propertyContextResolver
Gets current macro resolver.
Public propertyControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Public propertyControlTagKey
Overrides the generation of the SPAN tag with custom tag.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCSSPrefix
Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels.
Public propertyCultureCode
Property to set and get the CultureCode.
(Inherited from CMSAbstractControlProperties.)
Public propertyDataSource
Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
(Inherited from CMSAbstractControlProperties.)
Public propertyDefaultColumns
Gets the default columns which are used to retrieve data if Columns property not set to '*'.
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSAbstractControlProperties.)
Public propertyGroupedDS
Grouped data source.
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 CMSAbstractControlProperties.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.)
Public propertyOrderBy
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Public propertyParentControl
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Public propertyPath
Property to set and get the Path.
(Overrides CMSAbstractControlPropertiesPath.)
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
(Inherited from CMSAbstractControlProperties.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySiteName
Site code name.
(Inherited from CMSAbstractBaseProperties.)
Public propertyStopProcessing
Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
(Inherited from CMSAbstractBaseProperties.)
Public propertySubmenuIndicator
Contains a path to image that will be used on the right of every item that contains sub items.
Public propertyTopN
Select top N rows.
(Inherited from CMSAbstractBaseProperties.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from CMSAbstractControlProperties.)
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
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 propertyUseItemImagesForHiglightedItem Obsolete.
Indicates if highlighted images is not specified, use item image if exist.
Public propertyWhereCondition
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
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
See Also
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      CMS.ExtendedControlsCMSWebControl
        CMS.ControlsCMSAbstractBaseProperties
          CMS.ControlsCMSAbstractControlProperties
            CMS.ControlsCMSAbstractMenuProperties
              CMS.ControlsCMSBreadCrumbs
              CMS.ControlsCMSListMenu
              CMS.ControlsCMSMenu
              CMS.ControlsCMSMenuProperties
              CMS.ControlsCMSSiteMap
              CMS.ControlsCMSTreeMenu
              CMS.ControlsGoogleSitemap