ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TabBuilder

    Show / Hide Table of Contents

    Class TabBuilder

    Inheritance
    System.Object
    ControlBuilder
    TabBuilder
    Inherited Members
    ControlBuilder.Context
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.EJ2.Navigations
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class TabBuilder : ControlBuilder

    Constructors

    TabBuilder()

    Declaration
    public TabBuilder()

    TabBuilder(Tab)

    Declaration
    public TabBuilder(Tab model)
    Parameters
    Type Name Description
    Tab model

    Fields

    model

    Declaration
    public Tab model
    Field Value
    Type Description
    Tab

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    Added(String)

    The event will be fired after adding the item to the Tab.

    Declaration
    public TabBuilder Added(string added)
    Parameters
    Type Name Description
    System.String added
    Returns
    Type Description
    TabBuilder

    Adding(String)

    The event will be fired before adding the item to the Tab.

    Declaration
    public TabBuilder Adding(string adding)
    Parameters
    Type Name Description
    System.String adding
    Returns
    Type Description
    TabBuilder

    AllowDragAndDrop(Boolean)

    Sets true to allow drag and drop the Tab items

    Declaration
    public TabBuilder AllowDragAndDrop(bool allowDragAndDrop = true)
    Parameters
    Type Name Description
    System.Boolean allowDragAndDrop
    Returns
    Type Description
    TabBuilder

    Animation(TabTabAnimationSettings)

    Specifies the animation configuration settings while showing the content of the Tab.

    Declaration
    public TabBuilder Animation(TabTabAnimationSettings animation)
    Parameters
    Type Name Description
    TabTabAnimationSettings animation
    Returns
    Type Description
    TabBuilder

    Animation(Action<TabTabAnimationSettingsBuilder>)

    Declaration
    public TabBuilder Animation(Action<TabTabAnimationSettingsBuilder> animation)
    Parameters
    Type Name Description
    System.Action<TabTabAnimationSettingsBuilder> animation
    Returns
    Type Description
    TabBuilder

    ContentTemplate(Action<Object>)

    Declaration
    public TabBuilder ContentTemplate(Action<object> template)
    Parameters
    Type Name Description
    System.Action<System.Object> template
    Returns
    Type Description
    TabBuilder

    ContentTemplate(Func<Object, Object>)

    Declaration
    public TabBuilder ContentTemplate(Func<object, object> template)
    Parameters
    Type Name Description
    System.Func<System.Object, System.Object> template
    Returns
    Type Description
    TabBuilder

    Created(String)

    The event will be fired once the component rendering is completed.

    Declaration
    public TabBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    TabBuilder

    CssClass(String)

    Sets the CSS classes to root element of the Tab that helps to customize component styles.

    Declaration
    public TabBuilder CssClass(string cssClass)
    Parameters
    Type Name Description
    System.String cssClass
    Returns
    Type Description
    TabBuilder

    Destroyed(String)

    The event will be fired when the component gets destroyed.

    Declaration
    public TabBuilder Destroyed(string destroyed)
    Parameters
    Type Name Description
    System.String destroyed
    Returns
    Type Description
    TabBuilder

    DragArea(String)

    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 TabBuilder DragArea(string dragArea)
    Parameters
    Type Name Description
    System.String dragArea
    Returns
    Type Description
    TabBuilder

    Dragged(String)

    The event will be fired after dropping the Tab item

    Declaration
    public TabBuilder Dragged(string dragged)
    Parameters
    Type Name Description
    System.String dragged
    Returns
    Type Description
    TabBuilder

    Dragging(String)

    The event will be fired while dragging the Tab item

    Declaration
    public TabBuilder Dragging(string dragging)
    Parameters
    Type Name Description
    System.String dragging
    Returns
    Type Description
    TabBuilder

    EnableHtmlSanitizer(Boolean)

    Defines whether to allow the cross-scripting site or not.

    Declaration
    public TabBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
    Parameters
    Type Name Description
    System.Boolean enableHtmlSanitizer
    Returns
    Type Description
    TabBuilder

    EnablePersistence(Boolean)

    Enable or disable persisting component's state between page reloads. If enabled, following list of states will be persisted.

    1. selectedItem
    Declaration
    public TabBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    TabBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public TabBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    TabBuilder

    HeaderPlacement(HeaderPosition)

    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 TabBuilder HeaderPlacement(HeaderPosition headerPlacement)
    Parameters
    Type Name Description
    HeaderPosition headerPlacement
    Returns
    Type Description
    TabBuilder

    Height(Double)

    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 TabBuilder Height(double height)
    Parameters
    Type Name Description
    System.Double height
    Returns
    Type Description
    TabBuilder

    Height(String)

    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 TabBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    TabBuilder

    HeightAdjustMode(HeightStyles)

    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 TabBuilder HeightAdjustMode(HeightStyles heightAdjustMode)
    Parameters
    Type Name Description
    HeightStyles heightAdjustMode
    Returns
    Type Description
    TabBuilder

    HtmlAttributes(Object)

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    public TabBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    TabBuilder

    Items(Action<TabTabItemBuilder>)

    Declaration
    public TabBuilder Items(Action<TabTabItemBuilder> items)
    Parameters
    Type Name Description
    System.Action<TabTabItemBuilder> items
    Returns
    Type Description
    TabBuilder

    Items(List<TabTabItem>)

    An array of object that is used to configure the Tab component.

    Declaration
    public TabBuilder Items(List<TabTabItem> items)
    Parameters
    Type Name Description
    System.Collections.Generic.List<TabTabItem> items
    Returns
    Type Description
    TabBuilder

    LoadOn(ContentLoad)

    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 - The content of all the tabs are rendered on the initial load and maintained in the DOM. Init - The content of all the tabs are rendered on the initial load and maintained in the DOM.

    Declaration
    public TabBuilder LoadOn(ContentLoad loadOn)
    Parameters
    Type Name Description
    ContentLoad loadOn
    Returns
    Type Description
    TabBuilder

    Locale(String)

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public TabBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    TabBuilder

    OnDragStart(String)

    The event will be fired before dragging the item from Tab

    Declaration
    public TabBuilder OnDragStart(string onDragStart)
    Parameters
    Type Name Description
    System.String onDragStart
    Returns
    Type Description
    TabBuilder

    OverflowMode(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 TabBuilder OverflowMode(OverflowMode overflowMode)
    Parameters
    Type Name Description
    OverflowMode overflowMode
    Returns
    Type Description
    TabBuilder

    Removed(String)

    The event will be fired after removing the item from the Tab.

    Declaration
    public TabBuilder Removed(string removed)
    Parameters
    Type Name Description
    System.String removed
    Returns
    Type Description
    TabBuilder

    Removing(String)

    The event will be fired before removing the item from the Tab.

    Declaration
    public TabBuilder Removing(string removing)
    Parameters
    Type Name Description
    System.String removing
    Returns
    Type Description
    TabBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    System.Web.HtmlString

    ReorderActiveTab(Boolean)

    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 TabBuilder ReorderActiveTab(bool reorderActiveTab = true)
    Parameters
    Type Name Description
    System.Boolean reorderActiveTab
    Returns
    Type Description
    TabBuilder

    ScrollStep(Double)

    Specifies the scrolling distance in scroller.

    Declaration
    public TabBuilder ScrollStep(double scrollStep)
    Parameters
    Type Name Description
    System.Double scrollStep
    Returns
    Type Description
    TabBuilder

    Selected(String)

    The event will be fired after the item gets selected.

    Declaration
    public TabBuilder Selected(string selected)
    Parameters
    Type Name Description
    System.String selected
    Returns
    Type Description
    TabBuilder

    SelectedItem(Double)

    Specifies the index for activating the current Tab item.

    Declaration
    public TabBuilder SelectedItem(double selectedItem)
    Parameters
    Type Name Description
    System.Double selectedItem
    Returns
    Type Description
    TabBuilder

    Selecting(String)

    The event will be fired before the item gets selected.

    Declaration
    public TabBuilder Selecting(string selecting)
    Parameters
    Type Name Description
    System.String selecting
    Returns
    Type Description
    TabBuilder

    ShowCloseButton(Boolean)

    Specifies whether to show the close button for header items to remove the item from the Tab.

    Declaration
    public TabBuilder ShowCloseButton(bool showCloseButton = true)
    Parameters
    Type Name Description
    System.Boolean showCloseButton
    Returns
    Type Description
    TabBuilder

    Width(Double)

    Specifies the width of the Tab component. Default, Tab width sets based on the width of its parent.

    Declaration
    public TabBuilder Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    TabBuilder

    Width(String)

    Specifies the width of the Tab component. Default, Tab width sets based on the width of its parent.

    Declaration
    public TabBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    TabBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved