Class Tab

Represents the Tab UI element.

Inheritance

System.Object

CommonControl

Tab

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class Tab : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

Tab()

Declaration

public Tab()

Properties

AjaxSettings

Gets or sets the ajaxSettings option to load the content to the Tab control.

Declaration

public jQueryAjaxOptions AjaxSettings { get; set; }

Property Value

Type	Description
jQueryAjaxOptions	The ajax settings.

AllowKeyboardNavigation

Gets or sets the allow keyboard navigation.

Declaration

public bool AllowKeyboardNavigation { get; set; }

Property Value

Type	Description
System.Boolean	true if [allow keyboard navigation]; otherwise, false.

ClientSideOnActive

Occurs after a tab item activated

Declaration

public string ClientSideOnActive { get; set; }

Property Value

Type	Description
System.String	The client side on active.

ClientSideOnAjaxBeforeLoad

Occurs before ajax content has been loaded.

Declaration

public string ClientSideOnAjaxBeforeLoad { get; set; }

Property Value

Type	Description
System.String	The client side on ajax before load.

ClientSideOnAjaxError

Occurs when error in Ajax request.

Declaration

public string ClientSideOnAjaxError { get; set; }

Property Value

Type	Description
System.String	The client side on ajax error.

ClientSideOnAjaxLoad

Occurs after ajax content load action.

Declaration

public string ClientSideOnAjaxLoad { get; set; }

Property Value

Type	Description
System.String	The client side on ajax load.

ClientSideOnAjaxSuccess

Occurs after a tab item activated.

Declaration

public string ClientSideOnAjaxSuccess { get; set; }

Property Value

Type	Description
System.String	The client side on ajax success.

ClientSideOnBeforeActive

Occurs before a tab item activated.

Declaration

public string ClientSideOnBeforeActive { get; set; }

Property Value

Type	Description
System.String	The client side on before active.

ClientSideOnBeforeItemRemove

Occurs before a tab item remove.

Declaration

public string ClientSideOnBeforeItemRemove { get; set; }

Property Value

Type	Description
System.String	The client side on before item remove.

ClientSideOnCreate

Occurs before a tab item Create.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String	The client side on create.

ClientSideOnDestroy

Occurs before a tab item destroy.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String	The client side on destroy.

ClientSideOnItemAdd

Occurs after new tab item add.

Declaration

public string ClientSideOnItemAdd { get; set; }

Property Value

Type	Description
System.String	The client side on item add.

ClientSideOnItemRemove

Occurs after tab item removed.

Declaration

public string ClientSideOnItemRemove { get; set; }

Property Value

Type	Description
System.String	The client side on item remove.

Collapsible

Gets or sets collapsible.

Declaration

public bool Collapsible { get; set; }

Property Value

Type	Description
System.Boolean	true if [collapsible]; otherwise, false.

CssClass

Gets or sets the css class.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The css class.

DisabledItemIndex

Gets or sets the given tab headers and content panels.

Declaration

public List<int> DisabledItemIndex { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>	The disabled item index.

EmptyDataText

Gets or sets the empty data text.

Declaration

public string EmptyDataText { get; set; }

Property Value

Type	Description
System.String	The empty data text.

EnableAnimation

Gets or sets the animation behavior of the tab.

Declaration

public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable animation]; otherwise, false.

Enabled

Gets or sets the enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	The enabled.

EnabledItemIndex

Gets or sets enable item index.

Declaration

public List<int> EnabledItemIndex { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>	The enabled item index.

EnablePersistence

Gets or sets enable persistence.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable persistence]; otherwise, false.

EnableRTL

Gets or sets the Right to Left direction for headers and panels text of tab.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable RTL]; otherwise, false.

EnableTabScroll

Gets or sets the enable tab scroll.

Declaration

public bool EnableTabScroll { get; set; }

Property Value

Type	Description
System.Boolean	true if [enabled]; otherwise, false.

Events

Gets or sets the event API to bind the action for active the tab items.

Declaration

[JsonProperty("events")]
public string Events { get; set; }

Property Value

Type	Description
System.String	The events.

HeaderPosition

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

Declaration

public HeaderPosition HeaderPosition { get; set; }

Property Value

Type	Description
HeaderPosition	The header position.

HeaderSize

Gets or sets the height of the tab header element.

Declaration

public string HeaderSize { get; set; }

Property Value

Type	Description
System.String	The header size.

Height

Gets or sets the height.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The height.

HeightAdjustMode

Gets or sets the content panel height for given option (content, auto and fill), by default panels height adjust based on the content.

Declaration

public HeightAdjustMode HeightAdjustMode { get; set; }

Property Value

Type	Description
HeightAdjustMode	The height adjust mode.

HiddenItemIndex

Gets or sets the hidden item index.

Declaration

public List<int> HiddenItemIndex { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>	The hidden item index.

IdPrefix

Gets or sets the idPrefix.

Declaration

public string IdPrefix { get; set; }

Property Value

Type	Description
System.String	The id prefix.

Items

Gets or sets the collections of tab headers.

Declaration

public List<TabItem> Items { get; }

Property Value

Type	Description
System.Collections.Generic.List<TabItem>	The items.

Model

Gets or sets the Tab properties to its Model

Declaration

public TabProperties Model { get; set; }

Property Value

Type	Description
TabProperties

SelectedItemIndex

Gets or sets the selected item index.

Declaration

public int SelectedItemIndex { get; set; }

Property Value

Type	Description
System.Int32	true if [selected item index]; otherwise, false.

ShowCloseButton

Gets or sets the close button for each tab items.

Declaration

public bool ShowCloseButton { get; set; }

Property Value

Type	Description
System.Boolean	true if [show close button]; otherwise, false.

ShowReloadIcon

Gets or sets the reload button for each tab items.

Declaration

public bool ShowReloadIcon { get; set; }

Property Value

Type	Description
System.Boolean	true if [show reload icon]; otherwise, false.

ShowRoundedCorner

Gets or sets the tab panels and headers to be displayed in rounded corner style.

Declaration

public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean	true if [show rounded corner]; otherwise, false.

Width

Gets or sets the width.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The width.

Methods

CreateChildControls()

Create the child controls

Declaration

protected override void CreateChildControls()

DependentScripts()

Represents the dependent scripts for Tab control.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	This method returns the list of dependent script files which is of type string

GetDependentFiles()

Get the dependent files for Tab control

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonControl.LoadViewState(Object)

OnPreRender(EventArgs)

Modifying server controls before sending them to the client.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

PostBackEventHandler(String, Dictionary<String, Object>)

Gets a value that indicates whether the page is being loaded in response to a postback.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Render this instance

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Maintaining viewstate model values on post back

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

TabItemActive

Occurs when tab item is active.

Declaration

public event Tab.TabEventHandler TabItemActive

Event Type

Type	Description
Tab.TabEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService