Click or drag to resize
CMSTabControl Class
Tab control that can be bounded to the CMS content.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 10.0.0
Syntax
C#
public class CMSTabControl : BasicTabControl

The CMSTabControl type exposes the following members.

Constructors
  NameDescription
Public methodCMSTabControl
Constructor.
Top
Fields
  NameDescription
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmProperties
Menu properties variable.
Top
Properties
  NameDescription
Public propertyAfterLastTab
Content located after the last tab (in its own cell)
(Inherited from BasicTabControl.)
Public propertyApplyMenuDesign
Indicates if apply document menu item properties.
Public propertyBeforeFirstTab
Content located before the first tab (in its own cell)
(Inherited from BasicTabControl.)
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
Public propertyCacheItemName
Name of the cache item the control will use.
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyClassNames
Property to set and get the classnames list (separated by the semicolon).
Public propertyColumns
Gets or sets the columns to be retrieved from database.
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
Public propertyControlContext
Control context.
Public propertyCultureCode
Property to set and get the CultureCode.
Public propertyDataSource
Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public propertyEnableScrolling
Indicates whether the tab control should support inbuilt scrolling.
(Inherited from BasicTabControl.)
Public propertyEncodeMenuCaption
Indicates if menu caption should be HTML encoded.
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
(Inherited from BasicTabControl.)
Public propertyHighlightedNodePath
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.
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.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyLoadDataAutomaticaly
Indicates if data will be loaded automatically.
Public propertyMaxRelativeLevel
Level of nesting.
Public propertyOrderBy
ORDER BY expression.
Public propertyPath
Path of the menu items to be displayed.
Public propertyRenderedHTML
Get or set rendered HTML code.
(Inherited from BasicTabControl.)
Public propertyRenderImageAlt
Render the image alt attribute?
Public propertyRenderLinks
If true, the tab renders the link as well as the javascript
(Inherited from BasicTabControl.)
Public propertyRenderLinkTitle
Render the link title attribute?
(Inherited from BasicTabControl.)
Public propertyScrollPanelCss
Gets or sets the CSS style used for the scroll panel wrapper tag.
(Inherited from BasicTabControl.)
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
Public propertySelectedTab
Index of the selected tab.
(Inherited from BasicTabControl.)
Public propertySelectFirstItemByDefault
If is set true, first item will be selected by default if is not some other item selected.
(Overrides BasicTabControlSelectFirstItemByDefault.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySiteName
Property to set and get the SiteName.
Public propertyStopProcessing
Stop processing
Public propertyTabControlIdPrefix
Tab control ID prefix
(Inherited from BasicTabControl.)
Public propertyTabControlLayout
Horizontal or vertical layout.
(Inherited from BasicTabControl.)
Public propertyTabItems
Collection of tabs.
(Inherited from BasicTabControl.)
Protected propertyTabItemsInternal
Internal collection of tabs (built either from Tabs or TabItems).
(Inherited from BasicTabControl.)
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.)
Public propertyTopN
Select top N rows.
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUrlTarget
If URL for tab items is set, this property specifies target frame for all URLs.
(Inherited from BasicTabControl.)
Public propertyUseAlternatingStyles
Indicates if alternating styles should be used for even and odd items in the same level of the menu.
Public propertyUseClientScript
Indicates if client script should be generated for each tab.
(Inherited from BasicTabControl.)
Public propertyUseIFrame
If true, target frame is not in parent frames but iframe
(Inherited from BasicTabControl.)
Public propertyUseItemImagesForHighlightedItem
Indicates if highlighted images is not specified, use item image if exist.
Public propertyUsePostback
Indicates if postback is fired when tab is clicked.
(Inherited from BasicTabControl.)
Public propertyWhereCondition
Property to set and get the WhereCondition.
Public propertyWordWrap
Indicates if text can be wrapped or space is replaced with non breakable space.
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
(Inherited from BasicTabControl.)
Top
Methods
  NameDescription
Public methodAddTab
Adds a tab.
(Inherited from BasicTabControl.)
Protected methodCreateChildControls
Create child controls
(Inherited from BasicTabControl.)
Protected methodGenerateMenu
Generate menu
(Inherited from BasicTabControl.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
Public methodGetRedirScript
Gets the redirection script
(Inherited from BasicTabControl.)
Public methodGetTabControlLayout
Returns the layout mode based on the given string.
Protected methodGetTabs
Returns an array of tabs according to the current settings.
Protected methodInitControl
Ensures default data binding
Public methodInsertTab
Inserts tab at specified index.
(Inherited from BasicTabControl.)
Protected methodOnInit
Init event handler
(Overrides CMSWebControlOnInit(EventArgs).)
Protected methodOnLoad
Load event handler
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
OnPreRender override - register javascript functions
(Inherited from BasicTabControl.)
Public methodRaisePostBackEvent
RaisePostbackEvent handler
(Inherited from BasicTabControl.)
Protected methodRegisterScripts
Register scrips
(Inherited from BasicTabControl.)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
ReloadData.
Protected methodRender
Renders the control.
(Overrides BasicTabControlRender(HtmlTextWriter).)
Public methodSetContext
Sets the web part context.
Protected methodVerifySelectedTab
Verifies the selected tab index making sure that it doesn't exceed the number of tabs
(Inherited from BasicTabControl.)
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 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 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 ControlsExtensions.)
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.)
Top
Events
  NameDescription
Public eventOnTabClicked
Event for tab clicked.
(Inherited from BasicTabControl.)
Top
See Also