<Scale> (RibbonDiffXml)

 

Applies To: Dynamics CRM 2013

Specifies one of the possible layouts that may be used by a group when the maximum size layout cannot be displayed.

Syntax

<Scale 
 GroupId="String" 
 Id="String" 
 PopupSize="String" 
 Sequence="Integer" 
 Size="String" 
 />

Attributes and Elements

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

Attributes

Attribute

Description

Type

Usage

GroupId

A string that identifies the <Group> (RibbonDiffXml)that this scale applies to.

String

Required

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

PopupSize

A string that corresponds to the value of the Title attribute of a <Layout> (RibbonDiffXml) element that defines the size.

String

Optional

Sequence

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

Integer

Optional

Size

Links to a specific layout with a reference to a LayoutTitle attribute value.

String

Required

Child Elements

This element has no child elements.

Parent Elements

Element

Description

<CommandUIDefinition> (RibbonDiffXml)

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

<Scaling> (RibbonDiffXml)

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

Element Information

XPath

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

Schema Name

ScaleType

Validation File

RibbonWSS.xsd

Can be Empty

Yes

See Also

Ribbon XML reference
Customize commands and the ribbon