Class Tab
Inheritance
System.Object
Tab
Assembly: Syncfusion.EJ2.dll
Syntax
public class Tab : EJTagHelper
Constructors
Tab()
Declaration
Properties
Added
The event will be fired after adding the item to the Tab.
Declaration
public string Added { get; set; }
Property Value
Type |
Description |
System.String |
|
Adding
The event will be fired before adding the item to the Tab.
Declaration
public string Adding { get; set; }
Property Value
Type |
Description |
System.String |
|
AllowDragAndDrop
Sets true to allow drag and drop the Tab items
Declaration
public bool AllowDragAndDrop { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Animation
Specifies the animation configuration settings while showing the content of the Tab.
Declaration
public TabTabAnimationSettings Animation { get; set; }
Property Value
ClassName
Declaration
protected override string ClassName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Created
The event will be fired once the component rendering is completed.
Declaration
public string Created { get; set; }
Property Value
Type |
Description |
System.String |
|
CssClass
Sets the CSS classes to root element of the Tab that helps to customize component styles.
Declaration
public string CssClass { get; set; }
Property Value
Type |
Description |
System.String |
|
Destroyed
The event will be fired when the component gets destroyed.
Declaration
public string Destroyed { get; set; }
Property Value
Type |
Description |
System.String |
|
DragArea
Defines the area in which the draggable element movement will be occurring. Outside that area will be restricted
for the draggable element movement. By default, the draggable element movement occurs in the toolbar.
Declaration
public string DragArea { get; set; }
Property Value
Type |
Description |
System.String |
|
Dragged
The event will be fired after dropping the Tab item
Declaration
public string Dragged { get; set; }
Property Value
Type |
Description |
System.String |
|
Dragging
The event will be fired while dragging the Tab item
Declaration
public string Dragging { get; set; }
Property Value
Type |
Description |
System.String |
|
EnableHtmlSanitizer
Defines whether to allow the cross-scripting site or not.
Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnablePersistence
Enable or disable persisting component's state between page reloads.
If enabled, following list of states will be persisted.
- selectedItem
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Specifies the orientation of Tab header.
The possible values are:
- Top: Places the Tab header on the top.
- Bottom: Places the Tab header at the bottom.
- Left: Places the Tab header on the left.
- Right: Places the Tab header at the right.
Declaration
public HeaderPosition HeaderPlacement { get; set; }
Property Value
Height
Specifies the height of the Tab component. By default, Tab height is set based on the height of its parent.
To use height property, heightAdjustMode must be set to 'None'.
Declaration
public string Height { get; set; }
Property Value
Type |
Description |
System.String |
|
HeightAdjustMode
Specifies the height style for Tab content.
The possible values are:
- None: Based on the given height property, the content panel height is set.
- Auto: Tallest panel height of a given Tab content is set to all the other panels.
- Content: Based on the corresponding content height, the content panel height is set.
- Fill: Based on the parent height, the content panel height is set.
Declaration
public HeightStyles HeightAdjustMode { get; set; }
Property Value
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
Type |
Description |
System.Object |
|
IsFor
Declaration
protected override bool IsFor { get; }
Property Value
Type |
Description |
System.Boolean |
|
Overrides
Items
An array of object that is used to configure the Tab component.
Declaration
public List<TabTabItem> Items { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.List<TabTabItem> |
|
LoadOn
Specifies the modes for Tab content.
The possible modes are:
Dynamic
Load Tab content dynamically at the time of switching it's header.
Init
Load all tab contents at initial load.
Demand
Load Tab content when required but keep content once it is rendered.
Declaration
public ContentLoad LoadOn { get; set; }
Property Value
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }
Property Value
Type |
Description |
System.String |
|
NameSpace
Declaration
protected override string NameSpace { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
OnDragStart
The event will be fired before dragging the item from Tab
Declaration
public string OnDragStart { get; set; }
Property Value
Type |
Description |
System.String |
|
OverflowMode
Specifies the Tab display mode when Tab content exceeds the viewing area.
The possible modes are:
- Scrollable: All the elements are displayed in a single line with horizontal scrolling enabled.
- Popup: Tab container holds the items that can be placed within the available space and rest of the items are moved to the popup.
If the popup content overflows the height of the page, the rest of the elements can be viewed by scrolling the popup.
Declaration
public OverflowMode OverflowMode { get; set; }
Property Value
Removed
The event will be fired after removing the item from the Tab.
Declaration
public string Removed { get; set; }
Property Value
Type |
Description |
System.String |
|
Removing
The event will be fired before removing the item from the Tab.
Declaration
public string Removing { get; set; }
Property Value
Type |
Description |
System.String |
|
ReorderActiveTab
Determines whether to re-order tab items to show active tab item in the header area or popup when OverflowMode is Popup.
True, if active tab item should be visible in header area instead of pop-up. The default value is true.
Declaration
public bool ReorderActiveTab { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Specifies the scrolling distance in scroller.
Declaration
public double ScrollStep { get; set; }
Property Value
Type |
Description |
System.Double |
|
Selected
The event will be fired after the item gets selected.
Declaration
public string Selected { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectedItem
Specifies the index for activating the current Tab item.
Declaration
public double SelectedItem { get; set; }
Property Value
Type |
Description |
System.Double |
|
Selecting
The event will be fired before the item gets selected.
Declaration
public string Selecting { get; set; }
Property Value
Type |
Description |
System.String |
|
Specifies whether to show the close button for header items to remove the item from the Tab.
Declaration
public bool ShowCloseButton { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
TagName
Declaration
protected override string TagName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Width
Specifies the width of the Tab component. Default, Tab width sets based on the width of its parent.
Declaration
public string Width { get; set; }
Property Value
Type |
Description |
System.String |
|