TabControl

The TabControl component is a control that contains several elements using the same workspace.

Comments

Example

The component can contain several tabs. New tabs are added on clicking the tab with the + sign. The AfterAddItem and BeforeAddItem events occur when new tabs are being added.

The tab opens on clicking the heading. The ItemSelected and ItemDeselected events are related to tab opening and closing.

Using the TabControl.EnableDelete property, you can show the

icon in the tabs. Clicking the icon deletes the tab.

Depending on value of the DragDropEnabled property, the tabs can be dragged using the Drag&Drop method:

Constructor

Properties

	Property name	Brief description
	AddTabButtonTemplate	The AddTabButtonTemplate property determines a tab template on adding it to the panel.
	Background	The Background property determines a component panel background. that houses tabs' headings.
	Buttons	The Buttons property determines an object with buttons arrays for each side of a control.
	ContentAutoFit	The ContentAutoFit property determines whether control contents is automatically fit to the parent component.
	DragDropEnabled	The DragDropEnabled property determines whether tabs can be dragged.
	EnableDelete	The EnableDelete property determines whether tabs can be deleted.
	EnableDragOutside	The EnableDragOutside property determines whether a tab can be dragged out of the control.
	EnableDropFromOutside	The EnableDropFromOutside property determines whether a tab can be inserted from the other control.
	EnableEdit	The EnableEdit proeprty determines whether tab titles can be edited.
	EnableGroupSeparator	The EnableGroupSeparator property determines whether there is a separator between groups of tabs.
	HeaderHeight	The HeaderHeight property determines height of tabs of a control.
	ImagePath	The ImagePath property sets the path to the folder with component images.
	IsAddTabButtonVisible	The IsAddTabButtonVisible property determines whether a tab is displayed for adding new tabs.
	Items	The Items property contains an array of control tabs.
	MenuAddItems	The MenuAddItems property determines the menu for adding tabs.
	PaddingLeft	The PaddingLeft property determines value of the left padding of control tabs panel.
	SelectedIndex	The SelectedIndex property determines the selected tab by index.
	SelectedItem	The SelectedItem property determines the selected tab.
	SelectOnStartEditing	The SelectOnStartEditing property determines whether a tab title is selected on double-click.
	UseToolBarSwitch	The UseToolBarSwitch property determines whether tabs have the same style as a toolbar.

Methods

	Method name	Brief description
	addButton	The addButton method adds a button to the TabControl component.
	addItem	The addItem method adds a tab to the component.
	beginUpdate	The beginUpdate method disables rerendering of a control.
	clear	The clear method removes all tabs of a component.
	endUpdate	The endUpdate method enables rerendering of control and refreshes it.
	getActiveItem	The getActiveItem method returns the selected control tab.
	getContentPanel	The getContentPanel method returns the DOM node that stores tabs contents.
	getItemsList	The getItemsList method returns the list of tabs in the drop-down component panel.
	getToolBarButtonByTabItem	The getToolBarButtonByTabItem method returns a button of control tab toolbar.
	getToolBarButtonTemplate	The getToolBarButtonTemplate method returns a template of toolbar buttons.
	getVisibleItems	The getVisibleItems method returns the array of visible control panel tabs.
	hideContent	The hideContent method hides tabs contents.
	insertButton	The insertButton method adds a button to the TabControl component.
	insertItem	The insertItem method inserts a tab to the specified position.
	removeItem	The removeItem method removes a tab from the component by its index.
	removeItemByIndex	The removeItemByIndex method removes a tab by its index.
	scrollToItem	The scrollToItem method scrolls the tabs panel up to the specified tab.
	showContent	The showContent method displays tabs contents.

Events

	Event name	Brief description
	AddButton	The AddButton event occurs on adding a button to the tab control.
	AddMenuShowing	The AddMenuShowing event occurs on opening the tab adding menu.
	AfterAddItem	The AfterAddItem event occurs after a new tab is added to the component.
	BeforeAddItem	The BeforeAddItem event occurs before adding a new tab.
	BeforeShowGroupSeparator	The BeforeShowGroupSeparator event occurs before showing a separator between groups of tabs.
	ItemDeselected	The ItemDeselected event occurs on closing a tab.
	ItemMoved	The ItemMoved event occurs after moving a tab.
	ItemSelected	The ItemSelected event occurs on selecting a tab.
	SelectableSelected	The SelectableSelected event occurs on the mouse click on the element.
	TabDeleted	The TabDeleted event occurs after deleting a tab.
	TabDragIn	The TabDragIn event occurs on dragging a tab to the control area.
	TabDragOut	The TabDragOut event occurs on dragging a tab out of the control area.
	TabEdited	The TabEdited event occurs after exiting the edit mode.
	TabEditing	The TabEditing event occurs on switching to edit mode.
	TabMenuShowing	The TabMenuShowing event occurs on opening the tab menu.
	TabTextEdited	The TabTextEdited event occurs on exiting the edit mode if the heading text has been changed.
	TabTextEditing	The TabTextEditing event occurs on exiting the tab title edit mode, even if the title has not been changed.

Properties inherited from the Control class

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property determines component animation parameters.
	Bottom	The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
	Content	The Content property determines component contents.
	ContextMenu	The ContextMenu property determines a component's context menu.
	Data	The Data property is used to store any custom data.
	Enabled	The Enabled property determines whether a component can be used.
	Height	The Height property determines component height.
	IsRTL	The IsRTL property determines whether component elements are aligned to the right.
	IsVisible	The IsVisible property determines whether a component is displayed.
	Left	The Left property determines a left margin if a component is placed inside GridPanel.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property determines a parent DOM node.
	ResourceKey	The ResourceKey property determines a component resource key.
	Right	The Right property determines a right margin if a component is placed inside LayoutPanel.
	Rotate	The Rotate property determines a component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether a tooltip of the component can be displayed.
	Style	The Style property determines a component style.
	TabIndex	The TabIndex property determines the order of the control element passing inside the container.
	Tag	The Tag property determines a JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property determines a top margin if a component is placed inside GridPanel.
	Value	The Value property determines a component value.
	Width	The Width property determines component width.

Methods inherited from the Control class

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether a component can be dragged on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method sets up component displaying only on mouseover.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the Control class

Properties inherited from the class Object

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates an object copy.
	dispose	The dispose method deletes the component.
	getHashCode	The getHashCode method returns hash code of repository object.
	getId	The getId method returns repository object identifier.
	getSettings	The getSettings method returns repository object settings.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.
	isEqual	The isEqual method determines whether the specified object is equal to the current repository object.
	isLive	The isLive method determines validity of repository object.
	removeAllEvents	The removeAllEvents method removes all object event handlers by the specified context.
	setId	The setId method determines a repository object identifier.
	setSettings	The setSettings method determines repository object settings.
	defineProps	The defineProps method creates get and set methods from name array for the specified class.
	keys	The keys method returns array of methods and properties names for the specified object.

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.

	Constructor name	Brief description
	TabControl	The TabControl constructor creates an instance of the TabControl component.

	Property name	Brief description
	Id	The Id property determines a repository object identifier.