RadTab Object

The RadTab object is returned by the getTab() method of the RadTabCollection object. It is also exposed by the eventArgs of many client-side events. The following table lists the most important methods of the RadTab object:  

Name	Parameters	Return Type	Description
findControl	String	Object	Returns the client-side object of the Control with the specified ID nested in the Tab's Template. The ID passed as an argument to the function MUST be the ID attribute of the nested Control.
disable	none	none	Disables the tab if it is enabled. See Example 1.
enable	none	none	Enables the tab if it is disabled.
get_isEnabled	none	bool	Returns true if both the tab and the tabstrip are enabled. If one of them is disabled, get_isEnabled() will return false.
get_enabled	none	bool	Same as get_isEnabled.
set_enabled	bool	none	Sets the enabled state of the tab. See Example 2.
get_tabs	none	RadTabCollection	Gets the child tabs of the current tab.
get_nextSibling	none	RadTab	Returns the next sibling of the tab. If the tab is last, returns null.
get_previousSibling	none	RadTab	Returns the previous sibling of the tab. If the tab is first, returns null.
get_parent	none	RadTabStrip or RadTab	Returns an instance of the parent object. RadTabStrip if this is a root tab, RadTab if it is a child tab.
get_tabStrip	none	RadTabStrip	Returns an instance of the tabstrip that contains the tab.
get_pageView	none	RadPageView	Returns the pageview associated with the tab.
get_pageViewID	none	string	Returns the ID of the pageview.
set_pageViewID	string	none	Sets the ID of the pageview.
get_index	none	Integer	Gets the zero based index of the tab inside the parent tabs collection.
get_level	none	Integer	Gets the level of the tab. Root level tabs are first level.
get_attributes	none	Collection	Returns the collection of custom attributes for the tab. See Example 3.
get_visible	none	boolean	Returns true if the tab is visible or false otherwise.
set_visible	boolean	none	Shows/Hides a tab.
set_text	string text	none	Sets the text of the tab.
get_text	none	string text	Returns the text of the tab.
set_value	string value	none	Sets the Value property of the tab.
get_value	none	string value	Returns the Value property of the tab.
get_isSeparator	none	boolean	Returns true the tab is a separator (sever-side property IsSeparator = true)
get_selected	none	boolean	Returns whether the tab is selected.
set_selected	boolean	none	Selects or de-selects the tab on the client. When RenderSelectedPageOnly is set to true for the associated multi page, use click to select a tab.
select	none	none	Selects the tab on the client. When RenderSelectedPageOnly is set to true for the associated multi page, use click.
unselect	none	none	De-selects the tab .
get_navigateUrl	none	string	Gets the URL of the Web page the tab launches.
set_navigateUrl	string	none	Sets the navigateURL property of the tab. This is the URL of the Web page the tab launches. The navigateUrl parameter should be passed as an absolute URL on the client side: e.g., http://mydomain.com/default.aspx" notdefault.aspx`.
get_imageUrl	none	string	Gets the URL of the image.
set_imageUrl	string	none	Sets the URL of the image.
get_hoveredImageUrl	none	string	Gets the URL of the image displayed when the mouse if over the tab.
set_hoveredImageUrl	string	none	Sets the URL of the image displayed when the mouse if over the tab.
get_element	none	HTML Element	Gets the root DOM element of the tab (LI).
get_linkElement	none	HTML Element	Gets the anchor DOM element of the tab(A).
get_imageElement	none	HTML Element	Gets the image DOM element of the tab. If the server side ImageUrl property is not set,returns null.
get_textElement	none	HTML Element	Gets the DOM element of the tab text (SPAN).
get_childListElement	none	HTML Element	Gets the DOM element of the list of child tabs (UL).
scrollIntoView	none	none	Scrolls to the tab.
click	none	none	Simulate user click on a tab. Use to select a tab when RenderSelectedPageOnly is set to true for the associated multi page.

Changes to the tab made using these methods do not persist after a postback unless surrounded by a call to the trackChanges() and the commitChanges() methods of the tab strip object.

Example 1. Disable tab

function disableTab() { 
    var tabStrip = $find("<%= RadTabStrip1.ClientID %>");
    var tab = tabStrip.findTabByText("Paris");
    tab.disable();   
}

Example 2. Enable tab

function enableTab() {  
    var tabStrip = $find( "<%= RadTabStrip1.ClientID %>");
    var tab = tabStrip.findTabByText( "Paris");
    tab.set_enabled(true);
}

Example 3. Access the attributes collection of the tab

function manipulateAttributes() {
    var tabStrip = $find("<%= RadTabStrip1.ClientID %>");
    var foundTab = tabStrip.findTabByAttribute( "Population", "0");
    var attributes = foundTab.get_attributes();
    var size = attributes.getAttribute( "size");
    if (size) {
        attributes.setAttribute( "Population", size);
        attributes.removeAttribute( "size");
    } else {
        attributes.setAttribute( "Population", "Unknown" );
    } 
}

Example 4. Scroll into view the last tab

function scrollToTheLastTab() {
    var tabStrip = $find("<%=RadTabStrip1.ClientID %>");
    tabStrip.get_tabs().getTab(tabStrip.get_tabs().get_count()-1).scrollIntoView();     
}       

See Also

• RadTabStrip Object

• Overview

• Overview

• Working With Tabs at the Client