<BoolParameter> (RibbonDiffXml)

 

Applies To: Dynamics CRM 2013

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

Syntax

<BoolParameter
 Name="string"
 Value=["0" | "1" | "true" | "false"]
</ BoolParameter >

Attributes and Elements

The following table lists the attributes, child elements, and parent elements.

Attributes

Attribute

Description

Type

Usage

Value

Specifies the value to be passed as a parameter.

Boolean

Required

Name

Represents the name of a query string parameter passed for this value when using a Url element.

The name of the Boolean value to pass when BoolParameter is used as a child of <Url> (RibbonDiffXml).

String

Required

Note

This parameter is only available when BooleanParameter is a child of <Url> (RibbonDiffXml).

Child Elements

This element has no child elements.

Parent Elements

Element

Description

<JavaScriptFunction> (RibbonDiffXml)

Specifies an action that calls a function from a specific JavaScript library.

<CustomRule> (RibbonDiffXml)

Specifies a rule used with an EnableRule definition that is composed of a reference to a function within a JavaScript library.

<Url> (RibbonDiffXml)

An action that opens a web page at a specified address.

Example

This <Url> (RibbonDiffXml) action passes the Boolean value of ”false” with the name ”test” to a Web resource.

<Actions> <Url Address="$webresource:New_ShowParams.htm">  <BoolParameter Name="test"                 Value="false"/> </Url></Actions>

Element Information

XPath

//RibbonDiffXml/CommandDefinitions/CommandDefinition/Actions/JavaScriptFunction/BoolParameter |
//RibbonDiffXml/CommandDefinitions/CommandDefinition/Actions/Url/BoolParameter |
//RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/CustomRule/BoolParameter |
//RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/OrRule/Or/CustomRule/BoolParameter |
//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/CustomRule/BoolParameter |
//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/OrRule/Or/CustomRule/BoolParameter

Schema Name

BoolParameterType or BoolNamedParameterType

Validation File

RibbonTypes.xsd

Can be Empty

Yes

See Also

Customize commands and the ribbon
Ribbon XML reference