BasicTabControl Class

General tab control class.

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: 8.2.23

Syntax

public class BasicTabControl : CMSWebControl, 
	INamingContainer, IPostBackEventHandler

The BasicTabControl type exposes the following members.

Constructors

	Name	Description
Public method	BasicTabControl

Methods

	Name	Description
Public method	AddTab	Adds a tab.
Protected method	CreateChildControls	Create child controls (Overrides Control.CreateChildControls().)
Protected method	GenerateMenu	Generate menu
Public method	GetRedirScript	Gets the redirection script
Public method Static member	GetTabMenuLayout	Returns TabControlLayoutEnum value derived from name
Public method	InsertTab	Inserts tab at specified index.
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Protected method	OnPreRender	OnPreRender override - register javascript functions (Overrides Control.OnPreRender(EventArgs).)
Public method	RaisePostBackEvent	RaisePostbackEvent handler
Protected method	RegisterScripts	Register scrips
Protected method	Render	Renders the control. (Overrides WebControl.Render(HtmlTextWriter).)
Protected method	VerifySelectedTab	Verifies the selected tab index making sure that it doesn't exceed the number of tabs

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	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
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 CoreExtensions.)
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.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	AfterLastTab	Content located after the last tab (in its own cell)
Public property	BeforeFirstTab	Content located before the first tab (in its own cell)
Public property	EnableScrolling	Indicates whether the tab control should support inbuilt scrolling.
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	RenderedHTML	Get or set rendered HTML code.
Public property	RenderLinks	If true, the tab renders the link as well as the javascript
Public property	RenderLinkTitle	Render the link title attribute?
Public property	ScrollPanelCss	Gets or sets the CSS style used for the scroll panel wrapper tag.
Public property	SelectedTab	Index of the selected tab.
Public property	SelectFirstItemByDefault	If is set true, first item will be selected by default if is not some other item selected
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	TabControlIdPrefix	Tab control ID prefix
Public property	TabControlLayout	Horizontal or vertical layout.
Public property	TabItems	Collection of tabs.
Protected property	TabItemsInternal	Internal collection of tabs (built either from Tabs or TabItems).
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.
Public property	UseClientScript	Indicates if client script should be generated for each tab.
Public property	UseIFrame	If true, target frame is not in parent frames but iframe
Public property	UsePostback	Indicates if postback is fired when tab is clicked.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows.

Events

	Name	Description
Public event	OnTabClicked	Event for tab clicked.