Share via

<Url> (RibbonDiffXml)

  • Article

 

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

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

Syntax

<Url 
 Address="String"
 PassParams=["0" | "1" | "true" | "false"]
 WinMode="Integer"
 WinParams="String" 
>
 <BoolParameter/>
 <CrmParameter/>
 <DecimalParameter/>
 <IntParameter/>
 <StringParameter/>
</Url>

Attributes and Elements

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

Attributes

Attribute

Description

Type

Usage

Address

The address of the page to open. This value must represent a Uniform Resource Identifier (URI). It can be an absolute or relative path to the page.

String

Required

PassParams

Specifies whether information about the record and language context are passed to the URL.

Boolean

Optional

WinMode

Specifies the window mode. See Remarks.

Valid values:

Value

Description

0

Window [Default]

1

Modal Dialog

2

Modeless Dialog

Enumeration

Optional

WinParams

Specifies the parameters to be passed to the window. The format of this parameter is different depending on the value of the WinMode parameter.

String

Optional

Child Elements

Element

Description

<BoolParameter> (RibbonDiffXml)

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

<CrmParameter> (RibbonDiffXml)

Represents data retrieved from the Microsoft Dynamics 365 application that may be passed as a parameter.

<DecimalParameter> (RibbonDiffXml)

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

<IntParameter> (RibbonDiffXml)

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

<StringParameter> (RibbonDiffXml)

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

Parent Elements

Element

Description

<Actions> (RibbonDiffXml)

Specifies the actions that a command will perform.

Remarks

For WinMode = 0, the window.open method is used. For more information, see the open Method topic in the MSDN Library.

For WinMode = 1 (modal dialog), the window.showModalDialog method is used. For more information, see the showModalDialog Method topic in the MSDN Library.

For WinMode = 2 (modeless dialog), the window.showModelessDialog method is used. For more information, see the showModelessDialog Method topic in the MSDN Library.

Note

Don’t use this action to open entity forms or web resources. Use the <JavaScriptFunction> (RibbonDiffXml) with a function that uses Xrm.Utility.openEntityForm or Xrm.Utility.openWebResource instead.

Element Information

XPath

 
//RibbonDiffXml/CommandDefinitions/CommandDefinition/Actions/Url

Schema Name

UrlType

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