<Tab> (RibbonDiffXml)

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Specifies a tab in the ribbon.

Syntax

<Tab
 Command="String"
 CssClass="String"
 Description="String"
 Id="String"
 Sequence="Integer"
 Title="String">
 <Scaling />
 <Groups />
</Tab>

Attributes and Elements

The following describes the attributes, child elements, and parent elements.

Attributes

Attribute

Description

Type

Usage

Command

Specifies the ID of the ribbon command for this control.

String

Optional

CssClass

The name of the CSS class to apply when the tab is rendered.

String

Optional

Description

The Description attribute is not used by Microsoft Dynamics 365.

String

Optional

Id

Specifies a unique identifier for the definition of a ribbon element. The strongly recommended naming convention is to use a period to separate the parts of the name like so: [solution identifier].[entity].[ribbon].[function].[element name]. For example: MyISV.account.form.SendToOtherSystem.Button.

Use the {!EntityLogicalName} token in the Id attribute when you define a ribbon element that will be used for multiple entities. This inserts the entity logical name into the Id value to make sure that the Id value is globally unique.

For example, if you use MyISV.{!EntityLogicalName}.form.SendToOtherSystem.Button with the account entity, the Id will be MyISV.account.form.SendToOtherSystem.Button. For the contact entity, the Id will be MyISV.contact.form.SendToOtherSystem.Button.

Important

If you don’t set a globally unique Id value, the ribbon might not display.

String

Required

Sequence

Specify the location of the ribbon modification by setting the Sequence value higher or lower than existing ribbon elements.

Integer

Optional

Title

This element is not used in Microsoft Dynamics 365.

String

Optional

Child Elements

Element

Description

<Scaling> (RibbonDiffXml)

Contains a collection of elements used to define how ribbon groups are presented when the horizontal space available changes.

<Groups> (RibbonDiffXml)

Contains a collection of Group elements.

Parent Elements

Element

Description

<CommandUIDefinition> (RibbonDiffXml)

Specifies the visible Ribbon elements to be included within a CustomAction element.

<ContextualGroup> (RibbonDiffXml)

Contains a collection of tabs to be displayed within a specific context.

Element Information

XPath

//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Tab |
//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/ContextualGroup/Tab

Schema Name

TabType

Validation File

RibbonWSS.xsd

Can be Empty

No

See Also

Ribbon XML reference
Customize commands and the ribbon

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright