Share via

UrlAction Element in Actions (SolutionManifestDeclarativeExtensions Schema)

  • Article

Applies to: SharePoint Server 2010

The <CodeMethodAction> element is used to execute a URL-based action in Microsoft Outlook 2010.

Namespace: https://schemas.microsoft.com/office/2009/05/BusinessApplications/Manifest/DeclarativeExtensions

Schema: SolutionManifestDeclarativeExtensions

<UrlAction  Url = "String" Caption = "String" Tooltip = "String" Image = "String" DisplayLocations = "String" DisplayOrder = "Int" Scope = "String" Name = "String" Description = "String"> </UrlAction>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute

Description

Url

The full URL of the page that the user browses to when he or she clicks the action. A command can include parameters that will be populated with the contents of one or more fields in the external content type. In the URL that you type in this field, you can include placeholders for each parameter to use. Placeholders should be numbered with integers starting at zero (0, 1, 2, and so on) and should be of the form {number}. For example, the following sample URL provides two parameters, p0 and p1:

https://www.adventure-works.com/sample.aspx?p0={0}&p1={1}

Required.

Attribute type: String

Caption

The caption for the action. This is displayed as a caption for the action in the Outlook user interface.

Optional.

Attribute type: String

Tooltip

The tooltip for the action. This is displayed as a tooltip for the action in the Outlook user interface.

Optional.

Attribute type: String

Image

The path to an icon file. The icon is displayed for the action in the Outlook user interface. The path should be relative to the location of the solution manifest.

Optional.

Attribute type: String

DisplayLocations

The locations in the Outlook user interface where this action should be displayed. This attribute can be a combination of the following bit flags: 0 (none, action is not displayed anywhere), 1 (action is displayed on the external data parts menu), 2 (action is displayed on the item context menu), 4 (action is displayed on the ribbon).

Optional.

Attribute type: String

DisplayOrder

Used if the action is surfaced in a List External Data Part. Specifies the suggested position of this action among the other actions of this external content type in the menu.

Optional.

Attribute type: Int

Scope

Used if the action is surfaced in a List External Data Part. Specifies whether this action needs an item to be selected in a List External Data Part.

Optional.

The following table lists the possible values for this attribute.

Value

Description

ItemContext

Needs an item context. For example, an update action needs an item context to update an item.

StaticContext

Does not need an item context. For example, a create action does not need any item context.

Name

A name for this action.

Required.

Attribute type: String

Description

A description for this action.

Optional.

Attribute type: String

Child Elements

Element

Description

Parameters Element in ActionDefinition (SolutionManifestDeclarativeExtensions Schema)

Actions can take parameters. The Parameters element lists the parameters of the action.

Parent Elements

Element

Description

Actions Element in DeclarativeContextDefinition (SolutionManifestDeclarativeExtensions Schema)

The Actions element that contains this action.