CMSTabControl Class

Tab control that can be bounded to the CMS content.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.ExtendedControls.CMSWebControl
        CMS.Controls.BasicTabControl
          CMS.Controls.CMSTabControl

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0

Syntax

public class CMSTabControl : BasicTabControl

The CMSTabControl type exposes the following members.

Constructors

	Name	Description
Public method	CMSTabControl	Constructor.

Fields

	Name	Description
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mProperties	Menu properties variable.

Properties

	Name	Description
Public property	AfterLastTab	Content located after the last tab (in its own cell) (Inherited from BasicTabControl.)
Public property	ApplyMenuDesign	Indicates if apply document menu item properties.
Public property	BeforeFirstTab	Content located before the first tab (in its own cell) (Inherited from BasicTabControl.)
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	ClassNames	Property to set and get the classnames list (separated by the semicolon).
Public property	Columns	Gets or sets the columns to be retrieved from database.
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
Public property	ControlContext	Control context.
Public property	CultureCode	Property to set and get the CultureCode.
Public property	DataSource	Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public property	EnableScrolling	Indicates whether the tab control should support inbuilt scrolling. (Inherited from BasicTabControl.)
Public property	EncodeMenuCaption	Indicates if menu caption should be HTML encoded.
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False. (Inherited from BasicTabControl.)
Public property	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.
Public property	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.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	LoadDataAutomaticaly	Indicates if data will be loaded automatically.
Public property	MaxRelativeLevel	Level of nesting.
Public property	OrderBy	ORDER BY expression.
Public property	Path	Path of the menu items to be displayed.
Public property	RenderedHTML	Get or set rendered HTML code. (Inherited from BasicTabControl.)
Public property	RenderImageAlt	Render the image alt attribute?
Public property	RenderLinks	If true, the tab renders the link as well as the javascript (Inherited from BasicTabControl.)
Public property	RenderLinkTitle	Render the link title attribute? (Inherited from BasicTabControl.)
Public property	ScrollPanelCss	Gets or sets the CSS style used for the scroll panel wrapper tag. (Inherited from BasicTabControl.)
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database.
Public property	SelectedTab	Index of the selected tab. (Inherited from BasicTabControl.)
Public property	SelectFirstItemByDefault	If is set true, first item will be selected by default if is not some other item selected. (Overrides BasicTabControl.SelectFirstItemByDefault.)
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	SiteName	Property to set and get the SiteName.
Public property	StopProcessing	Stop processing
Public property	TabControlIdPrefix	Tab control ID prefix (Inherited from BasicTabControl.)
Public property	TabControlLayout	Horizontal or vertical layout. (Inherited from BasicTabControl.)
Public property	TabItems	Collection of tabs. (Inherited from BasicTabControl.)
Protected property	TabItemsInternal	Internal collection of tabs (built either from Tabs or TabItems). (Inherited from BasicTabControl.)
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	TopN	Select top N rows.
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	UIContext	Returns control's UI context (Inherited from CMSWebControl.)
Public property	UrlTarget	If URL for tab items is set, this property specifies target frame for all URLs. (Inherited from BasicTabControl.)
Public property	UseAlternatingStyles	Indicates if alternating styles should be used for even and odd items in the same level of the menu.
Public property	UseClientScript	Indicates if client script should be generated for each tab. (Inherited from BasicTabControl.)
Public property	UseIFrame	If true, target frame is not in parent frames but iframe (Inherited from BasicTabControl.)
Public property	UseItemImagesForHighlightedItem	Indicates if highlighted images is not specified, use item image if exist.
Public property	UsePostback	Indicates if postback is fired when tab is clicked. (Inherited from BasicTabControl.)
Public property	WhereCondition	Property to set and get the WhereCondition.
Public property	WordWrap	Indicates if text can be wrapped or space is replaced with non breakable space.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows. (Inherited from BasicTabControl.)

Methods

	Name	Description
Public method	AddTab	Adds a tab. (Inherited from BasicTabControl.)
Protected method	CreateChildControls	Create child controls (Inherited from BasicTabControl.)
Protected method	GenerateMenu	Generate menu (Inherited from BasicTabControl.)
Public method	GetCacheDependency	Gets the cache dependency for the control.
Public method	GetRedirScript	Gets the redirection script (Inherited from BasicTabControl.)
Public method	GetTabControlLayout	Returns the layout mode based on the given string.
Protected method	GetTabs	Returns an array of tabs according to the current settings.
Protected method	InitControl	Ensures default data binding
Public method	InsertTab	Inserts tab at specified index. (Inherited from BasicTabControl.)
Protected method	OnInit	Init event handler (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	OnPreRender override - register javascript functions (Inherited from BasicTabControl.)
Public method	RaisePostBackEvent	RaisePostbackEvent handler (Inherited from BasicTabControl.)
Protected method	RegisterScripts	Register scrips (Inherited from BasicTabControl.)
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	ReloadData.
Protected method	Render	Renders the control. (Overrides BasicTabControl.Render(HtmlTextWriter).)
Public method	SetContext	Sets the web part context.
Protected method	VerifySelectedTab	Verifies the selected tab index making sure that it doesn't exceed the number of tabs (Inherited from BasicTabControl.)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	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.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnTabClicked	Event for tab clicked. (Inherited from BasicTabControl.)