Class TabPropertiesBuilder

Inheritance
System.Object
TabPropertiesBuilder
Implements
System.Web.IHtmlString
Inherited Members
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.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class TabPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

TabPropertiesBuilder()

Initializes a new instance of the TabPropertiesBuilder class.

Declaration
public TabPropertiesBuilder()

TabPropertiesBuilder(Tab)

Initializes a new instance of the TabPropertiesBuilder class.

Declaration
public TabPropertiesBuilder(Tab tab)
Parameters
Type Name Description
Tab tab

Accepts the Tab properties

Fields

tab

Creates a new instance of Tab class.

Declaration
public Tab tab
Field Value
Type Description
Tab

Properties

ItemsCollection

Gets or sets the items collection.

Declaration
public List<TabBaseItem> ItemsCollection { get; set; }
Property Value
Type Description
System.Collections.Generic.List<TabBaseItem>

The items collection

Methods

AjaxSettings(Action<jQueryAjaxOptionsBuilder>)

Specifies the ajaxSettings option to load the content to the Tab control.

Declaration
public TabPropertiesBuilder AjaxSettings(Action<jQueryAjaxOptionsBuilder> ajaxOptions)
Parameters
Type Name Description
System.Action<jQueryAjaxOptionsBuilder> ajaxOptions

ajax option
Returns
Type Description
TabPropertiesBuilder

This method returns object value

AllowKeyboardNavigation()

Tab items interaction with keyboard keys, like headers active navigation.

Declaration
public TabPropertiesBuilder AllowKeyboardNavigation()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

AllowKeyboardNavigation(Boolean)

Tab items interaction with keyboard keys, like headers active navigation.with boolean argument.

Declaration
public TabPropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)
Parameters
Type Name Description
System.Boolean allowKeyboardNavigation

allow keyboard navigation
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

ClientSideEvents(Action<TabClientSideEventsBuilder>)

Specify the tab ClientSide Events.

Declaration
public TabPropertiesBuilder ClientSideEvents(Action<TabClientSideEventsBuilder> clientSideEvents)
Parameters
Type Name Description
System.Action<TabClientSideEventsBuilder> clientSideEvents

clientSideEvents
Returns
Type Description
TabPropertiesBuilder

This method returns tab properties builder value

Collapsible()

Allow to collapsing the active item, while click on the active header.

Declaration
public TabPropertiesBuilder Collapsible()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

Collapsible(Boolean)

Allow to collapsing the active item, while click on the active header.with boolean argument.

Declaration
public TabPropertiesBuilder Collapsible(bool collapsible)
Parameters
Type Name Description
System.Boolean collapsible

collapsible
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

CssClass(String)

Set the root class for Tab theme. This cssClass API helps to use custom skinning option for Tab control.

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

css class
Returns
Type Description
TabPropertiesBuilder

This method returns string value

DisabledItemIndex(List<Int32>)

Disables the given tab headers and content panels.

Declaration
public TabPropertiesBuilder DisabledItemIndex(List<int> disabledItemIndex)
Parameters
Type Name Description
System.Collections.Generic.List<System.Int32> disabledItemIndex

disabled item index
Returns
Type Description
TabPropertiesBuilder

This method returns array value

EnableAnimation()

Specifies the animation behavior of the tab.

Declaration
public TabPropertiesBuilder EnableAnimation()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

EnableAnimation(Boolean)

Specifies the animation behavior of the tab.with boolean argument.

Declaration
public TabPropertiesBuilder EnableAnimation(bool enableAnimation)
Parameters
Type Name Description
System.Boolean enableAnimation

enable animation
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

Enabled()

When this property is set to false, it disables the tab control.

Declaration
public TabPropertiesBuilder Enabled()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

Enabled(Boolean)

When this property is set to false, it disables the tab control.with boolean argument.

Declaration
public TabPropertiesBuilder Enabled(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

enabled
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

EnabledItemIndex(List<Int32>)

Enables the given tab headers and content panels.

Declaration
public TabPropertiesBuilder EnabledItemIndex(List<int> enabledItemIndex)
Parameters
Type Name Description
System.Collections.Generic.List<System.Int32> enabledItemIndex

enable item index
Returns
Type Description
TabPropertiesBuilder

This method returns array value

EnablePersistence()

Save current model value to browser cookies for state maintains. While refresh the Tab control page the model value apply from browser cookies.

Declaration
public TabPropertiesBuilder EnablePersistence()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

EnablePersistence(Boolean)

Save current model value to browser cookies for state maintains. While refresh the Tab control page the model value apply from browser cookies.with boolean argument.

Declaration
public TabPropertiesBuilder EnablePersistence(bool enablePersistence)
Parameters
Type Name Description
System.Boolean enablePersistence

enable persistence
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

EnableRTL()

Display Right to Left direction for headers and panels text of tab.

Declaration
public TabPropertiesBuilder EnableRTL()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

EnableRTL(Boolean)

Display Right to Left direction for headers and panels text of tab.with boolean argument.

Declaration
public TabPropertiesBuilder EnableRTL(bool enableRTL)
Parameters
Type Name Description
System.Boolean enableRTL

enable RTL
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

EnableTabScroll()

Specify to enable scrolling for Tab header.

Declaration
public TabPropertiesBuilder EnableTabScroll()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

EnableTabScroll(Boolean)

Specify to enable scrolling for Tab header.with boolean argument.

Declaration
public TabPropertiesBuilder EnableTabScroll(bool enableTabScroll)
Parameters
Type Name Description
System.Boolean enableTabScroll

enable tab scroll
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

Events(String)

The event API to bind the action for active the tab items.

Declaration
public TabPropertiesBuilder Events(string events)
Parameters
Type Name Description
System.String events

events
Returns
Type Description
TabPropertiesBuilder

This method returns string value

HeaderPosition(HeaderPosition)

Specifies the position of Tab header as top, bottom, left or right.

Declaration
public TabPropertiesBuilder HeaderPosition(HeaderPosition headerPosition)
Parameters
Type Name Description
HeaderPosition headerPosition

header position
Returns
Type Description
TabPropertiesBuilder

This method returns string|enum value

HeaderSize(String)

Set the height of the tab header element. Default this property value is null, so height take content height.

Declaration
public TabPropertiesBuilder HeaderSize(string headerSize)
Parameters
Type Name Description
System.String headerSize

header size
Returns
Type Description
TabPropertiesBuilder

This method returns string value

Height(String)

Height set the outer panel element. Default this property value is null, so height take content height.

Declaration
public TabPropertiesBuilder Height(string height)
Parameters
Type Name Description
System.String height

height
Returns
Type Description
TabPropertiesBuilder

This method returns string value

HeightAdjustMode(HeightAdjustMode)

Specifies the possible values for the status of height adjust mode.

Declaration
public TabPropertiesBuilder HeightAdjustMode(HeightAdjustMode heightAdjustMode)
Parameters
Type Name Description
HeightAdjustMode heightAdjustMode

height adjust mode
Returns
Type Description
TabPropertiesBuilder

This method returns string|enum value

HiddenItemIndex(List<Int32>)

Specifies to hide a pane of Tab control.

Declaration
public TabPropertiesBuilder HiddenItemIndex(List<int> hiddenItemIndex)
Parameters
Type Name Description
System.Collections.Generic.List<System.Int32> hiddenItemIndex

hidden item index
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

HtmlAttributes(IDictionary<String, Object>)

Specifies the HTML Attributes of the Tab.

Declaration
public TabPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.Object> itemHtmlAttributes

html Attributes
Returns
Type Description
TabPropertiesBuilder

This method returns object value

IdPrefix(String)

The idPrefix property appends the given string on the added tab item id’s in runtime.

Declaration
public TabPropertiesBuilder IdPrefix(string idPrefix)
Parameters
Type Name Description
System.String idPrefix

id prefix
Returns
Type Description
TabPropertiesBuilder

This method returns string value

Items(Action<TabBaseItemAdder>)

Specify the tab Items

Declaration
public TabPropertiesBuilder Items(Action<TabBaseItemAdder> items)
Parameters
Type Name Description
System.Action<TabBaseItemAdder> items

items
Returns
Type Description
TabPropertiesBuilder

This method returns tab properties builder value

Render()

Renders this instance.

Declaration
public void Render()

SelectedItemIndex(Int32)

Specifies the Tab header in active for given index value.

Declaration
public TabPropertiesBuilder SelectedItemIndex(int selectedItemIndex)
Parameters
Type Name Description
System.Int32 selectedItemIndex

selected item index
Returns
Type Description
TabPropertiesBuilder

This method returns int value

ShowCloseButton()

Display the close button for each tab items. While clicking on the close icon, particular tab item will be removed.

Declaration
public TabPropertiesBuilder ShowCloseButton()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

ShowCloseButton(Boolean)

Display the close button for each tab items. While clicking on the close icon, particular tab item will be removed.with boolean argument.

Declaration
public TabPropertiesBuilder ShowCloseButton(bool showCloseButton)
Parameters
Type Name Description
System.Boolean showCloseButton

show close button
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

ShowReloadIcon()

Display the Reload button for each tab items.

Declaration
public TabPropertiesBuilder ShowReloadIcon()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

ShowReloadIcon(Boolean)

Display the Reload button for each tab items.with boolean argument.

Declaration
public TabPropertiesBuilder ShowReloadIcon(bool showReloadIcon)
Parameters
Type Name Description
System.Boolean showReloadIcon

show reload icon
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

ShowRoundedCorner()

Tab panels and headers to be displayed in rounded corner style.

Declaration
public TabPropertiesBuilder ShowRoundedCorner()
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

ShowRoundedCorner(Boolean)

Tab panels and headers to be displayed in rounded corner style.with boolean argument.

Declaration
public TabPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)
Parameters
Type Name Description
System.Boolean showRoundedCorner

show rounded corner
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

ToHtmlString()

Returns an HTML-encoded string.

Declaration
public string ToHtmlString()
Returns
Type Description
System.String

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Width(String)

Set the width for outer panel element, if not it’s take parent width.

Declaration
public TabPropertiesBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
TabPropertiesBuilder

This method returns boolean value

Implements

System.Web.IHtmlString