Class Tab
Inheritance
Namespace: Syncfusion.EJ2.Navigations
Assembly: Syncfusion.EJ2.dll
Syntax
public class Tab : EJTagHelperConstructors
Tab()
Declaration
public Tab()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 | The default value is null |
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 | The default value is null |
AllowDragAndDrop
Sets true to allow drag and drop the Tab items
Declaration
public bool AllowDragAndDrop { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
Animation
Specifies the animation configuration settings while showing the content of the Tab.
Declaration
public TabAnimationSettings Animation { get; set; }Property Value
| Type | Description |
|---|---|
| TabAnimationSettings | The default value is null |
ClearTemplates
Specifies whether the templates need to be cleared or not while changing the Tab items dynamically.
Declaration
public bool ClearTemplates { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }Property Value
| Type |
|---|
| Syncfusion.EJ2.MvcTemplate<System.Object> |
Created
The event will be fired once the component rendering is completed.
Declaration
public string Created { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
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 | The default value is "" |
Destroyed
The event will be fired when the component gets destroyed.
Declaration
public string Destroyed { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
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 | The default value is null |
Dragged
The event will be fired after dropping the Tab item
Declaration
public string Dragged { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Dragging
The event will be fired while dragging the Tab item
Declaration
public string Dragging { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
EnableHtmlSanitizer
Specifies whether to enable the rendering of untrusted HTML values in the Tab component. When this property is enabled, the component will sanitize any suspected untrusted strings and scripts before rendering them.
Declaration
public bool EnableHtmlSanitizer { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
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 | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
HeaderPlacement
Specifies the orientation of Tab header.
The possible values for this property as follows
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
| Type | Description |
|---|---|
| HeaderPosition | The default value is HeaderPosition.Top |
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 | The default value is "auto" |
HeightAdjustMode
Specifies the height style for Tab content.
The possible values for this property as follows
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
| Type | Description |
|---|---|
| HeightStyles | The default value is HeightStyles.Content |
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 |
|---|
| System.Object |
Items
An array of object that is used to configure the Tab component.
Declaration
public List<TabItem> Items { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<TabItem> | The default value is null |
LoadOn
Specifies the modes for Tab content.
The possible modes are:
Demand - The content of the selected tab alone is loaded initially. The content of the tabs which were loaded once will be maintained in the DOM.
Dynamic - Only the content of the selected tab is loaded and available in the DOM, and it will be replaced with the corresponding content if the tab is selected dynamically.
Init - The content of all the tabs are rendered on the initial load and maintained in the DOM.
Declaration
public ContentLoad LoadOn { get; set; }Property Value
| Type | Description |
|---|---|
| ContentLoad | The default value is ContentLoad.Demand |
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 | The default value is "" |
OnDragStart
The event will be fired before dragging the item from Tab
Declaration
public string OnDragStart { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
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
| Type | Description |
|---|---|
| OverflowMode | The default value is OverflowMode.Scrollable |
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 | The default value is null |
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 | The default value is null |
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 | The default value is true |
ScrollStep
Specifies the scrolling distance in scroller.
Declaration
public double ScrollStep { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is Double.NaN |
Selected
The event will be fired after the item gets selected.
Declaration
public string Selected { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
SelectedItem
Specifies the index for activating the current Tab item.
Declaration
public double SelectedItem { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 0 |
Selecting
The event will be fired before the item gets selected.
Declaration
public string Selecting { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
ShowCloseButton
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 | The default value is false |
SwipeMode
Defines whether the tab transition should occur or not when performing Touch/Mouse swipe action.
Declaration
public TabSwipeMode SwipeMode { get; set; }Property Value
| Type | Description |
|---|---|
| TabSwipeMode | The default value is TabSwipeMode.Both |
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 | The default value is "100%" |