United States (English)

Home Library Learn Samples Downloads Support Community Forums

MSDN Library

Servers and Enterprise Development

Microsoft Dynamics

Microsoft Dynamics CRM

Microsoft Dynamics CRM 2011

Software Development Kit

Software Development Kit for Microsoft Dynamics CRM

Customize Microsoft Dynamics CRM

Customize the Ribbon

Ribbon XML Reference

<Actions> (RibbonDiffXml)

<BoolParameter> (RibbonDiffXml)

<Button> (RibbonDiffXml)

<CheckBox> (RibbonDiffXml)

<Color> (RibbonDiffXml)

<ColorPicker> (RibbonDiffXml)

<Colors> (RibbonDiffXml)

<ComboBox> (RibbonDiffXml)

<CommandDefinition> (RibbonDiffXml)

<CommandDefinitions> (RibbonDiffXml)

<CommandUIDefinition> (RibbonDiffXml)

<ContextualGroup> (RibbonDiffXml)

<ControlRef> (RibbonDiffXml)

<Controls> (RibbonDiffXml)

<CrmClientTypeRule> (RibbonDiffXml)

<CrmOfflineAccessStateRule> (RibbonDiffXml)

<CrmOutlookClientTypeRule> (RibbonDiffXml)

<CrmOutlookClientVersionRule> (RibbonDiffXml)

<CrmParameter> (RibbonDiffXml)

<CustomAction> (RibbonDiffXml)

<CustomActions> (RibbonDiffXml)

<CustomRule> (RibbonDiffXml)

<DecimalParameter> (RibbonDiffXml)

<DisplayRule> (RibbonDiffXml)

<DisplayRules> (RibbonDiffXml)

<DropDown> (RibbonDiffXml)

<EnableRule> (RibbonDiffXml)

<EnableRules> (RibbonDiffXml)

<EntityPrivilegeRule> (RibbonDiffXml)

<EntityPropertyRule> (RibbonDiffXml)

<EntityRule> (RibbonDiffXml)

<FlyoutAnchor> (RibbonDiffXml)

<FormEntityContextRule> (RibbonDiffXml)

<FormStateRule> (RibbonDiffXml)

<Gallery> (RibbonDiffXml)

<GalleryButton> (RibbonDiffXml)

<Group> (RibbonDiffXml)

<Groups> (RibbonDiffXml)

<GroupTemplate> (RibbonDiffXml)

<HideCustomAction> (RibbonDiffXml)

<InsertTable> (RibbonDiffXml)

<IntParameter> (RibbonDiffXml)

<JavaScriptFunction> (RibbonDiffXml)

<Label> (RibbonDiffXml)

<Layout> (RibbonDiffXml)

<LocLabel> (RibbonDiffXml)

<LocLabels> (RibbonDiffXml)

<LowScaleWarning> (RibbonDiffXml)

<MaxSize> (RibbonDiffXml)

<Menu> (RibbonDiffXml)

<MenuSection> (RibbonDiffXml)

<MiscellaneousPrivilegeRule> (RibbonDiffXml)

<MRUSplitButton> (RibbonDiffXml)

<Or> (RibbonDiffXml)

<OrganizationSettingRule> (RibbonDiffXml)

<OrRule> (RibbonDiffXml)

<OutlookCommand> (RibbonDiffXml)

<OutlookItemTrackingRule> (RibbonDiffXml)

<OutlookRenderTypeRule> (RibbonDiffXml)

<OutlookVersionRule> (RibbonDiffXml)

<OverflowArea> (RibbonDiffXml)

<OverflowSection> (RibbonDiffXml)

<PageRule> (RibbonDiffXml)

<RecordPrivilegeRule> (RibbonDiffXml)

<ReferencingAttributeRequiredRule> (RibbonDiffXml)

<RelationshipTypeRule> (RibbonDiffXml)

<RibbonDiffXml> (RibbonDiffXml)

<RibbonNotSupported> (RibbonDiffXml)

<RibbonTemplates> (RibbonDiffXml)

<Row> (RibbonDiffXml)

<RuleDefinitions> (RibbonDiffXml)

<Scale> (RibbonDiffXml)

<Scaling> (RibbonDiffXml)

<Section> (RibbonDiffXml)

<SelectionCountRule> (RibbonDiffXml)

<SkuRule> (RibbonDiffXml)

<Spinner> (RibbonDiffXml)

<SplitButton> (RibbonDiffXml)

<StringParameter> (RibbonDiffXml)

<Strip> (RibbonDiffXml)

<Tab> (RibbonDiffXml)

<TabDisplayRule> (RibbonDiffXml)

<TabDisplayRules> (RibbonDiffXml)

<Templates> (RibbonDiffXml)

<TextBox> (RibbonDiffXml)

<Title> (RibbonDiffXml)

<Titles> (RibbonDiffXml)

<ToggleButton> (RibbonDiffXml)

<Unit> (RibbonDiffXml)

<UnitAbbreviation> (RibbonDiffXml)

<Url> (RibbonDiffXml)

<ValueRule> (RibbonDiffXml)

Minimize

This topic has not yet been rated - Rate this topic

<StringParameter> (RibbonDiffXml)

[Applies to: Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online]

Specifies a value with a string data type that may be passed as a parameter.

<StringParameter 
 Name="String" 
 Value="String"
/>

Attributes and Elements

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

Attributes

Attribute	Description	Type	Usage
Name	Represents the name of a query string parameter passed for this value when using a Url element.	String	See Remarks
Value	Specifies the value to be passed as a parameter.	String	Required

Child Elements

This element has no child elements.

Parent Elements

Element	Description
<CustomRule> (RibbonDiffXml)	Specifies a rule used with an EnableRule definition that is composed of a reference to a function within a JavaScript library.
<JavaScriptFunction> (RibbonDiffXml)	Specifies an action that calls a function from a specific JavaScript library.
<Url> (RibbonDiffXml)	An action that opens a web page at a specified address.

When the StringParameter is a child of the <Url> (RibbonDiffXml) a Name attribute is required. When the StringParameter is a child of the <JavaScriptFunction> (RibbonDiffXml) or <CustomRule> (RibbonDiffXml) elements, the Name attribute is not valid.

Element Information

XPath	Copy //RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/CustomRule/StringParameter \| //RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/OrRule/Or/CustomRule/StringParameter \| //RibbonDiffXml/CommandDefinitions/CommandDefinition/Actions/Url/Stringparameter \| //RibbonDiffXml/CommandDefinitions/CommandDefinition/Actions/JavaScriptFunction/Stringparameter
Schema Name	StringParameterType StringNamedParameterType
Validation File	RibbonTypes.xsd
Can be Empty	Yes

Other Resources

Customize the Ribbon

Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2012 Microsoft Corporation. All rights reserved.

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

© 2013 Microsoft. All rights reserved.