Export (0) Print
Expand All

Xrm.Page.ui tab (client-side reference)

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

A tab is a group of sections on a page. It contains methods to manipulate tabs as well as access to sections within the tab through the sections collection.

DisplayState
Use the getDisplayState and setDisplayState methods to determine whether the tab is collapsed or to collapse and expand the tab.

getName
Method to get the name of the tab.

getParent
Method to return the Xrm.Page.ui (client-side reference) object that is the parent to all tabs.

Label
Use the getLabel and setLabel methods to determine the label for the tab or to hide and show the tab label.

sections
A collection of sections within the tab.

setFocus
Method to set focus on a tab.

Visible
Use the getVisible and setVisible methods to determine the tab is visible or to hide and show the tab.

Use the getDisplayState and setDisplayState methods to determine whether the tab is collapsed or to collapse and expand the tab.

getDisplayState

Returns a value that indicates whether the tab is collapsed or expanded.

tabObj.getDisplayState()
Return Value
Type: String

Possible values:

  • expanded

  • collapsed

Remarks
For Microsoft Dynamics CRM for tablets this method will always return expanded because tabs cannot be collapsed.

setDisplayState

Sets the tab to be collapsed or expanded.

tabObj.setDisplayState(string)
Arguments
String

Valid argument values:

  • expanded

  • collapsed

Remarks
This method does not work with Microsoft Dynamics CRM for tablets because tabs cannot be collapsed.

Returns the name of the tab.

tabObj.getName()
Return Value
Type: String

Returns the Xrm.Page.ui (client-side reference) object.

tabObj.getParent()
Return Value
Type: Object

Use the getLabel and setLabel methods to determine the label for the tab or to hide and show the tab label.

getLabel

Returns the tab label.

tabObj.getLabel()
Return Value
Type: String

setLabel

Sets the label for the tab.

tabObj.setLabel(String)
Arguments
String

The sections collection provides access to sections within the tab. See Collections (client-side reference) for information about methods to access the sections in the collection. See Xrm.Page.ui section (client-side reference) for information about the properties and methods of the section objects in the collection.

Sets the focus on the tab.

tabObj.setFocus()

Use the getVisible and setVisible methods to determine the tab is visible or to hide and show the tab.

noteNote
Another way to hide a tab is to hide all the sections within it. If all the sections within a tab are not visible, the tab will not be visible.

getVisible

Returns a value that indicates whether the tab is visible.

tabObj.getVisible()
Return Value
Type: Boolean

setVisible

Sets a value that indicates whether the control is visible.

tabObj.setVisible(boolean);
Arguments
Boolean

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.
Show:
© 2014 Microsoft