<StringParameter> (RibbonDiffXml)

 

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

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

Syntax

<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.

Remarks

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	//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

See Also

Ribbon XML reference
Customize commands and the ribbon

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright