Action element in Actions

(BDCMetadata Schema)

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Specifies an action supported by an external content type.

Namespace: http://schemas.microsoft.com/windows/2007/BusinessDataCatalog

Schema: BDCMetadata

Actions bridge the gap between Microsoft SharePoint 2010 and Microsoft Office 2010 and an external system's user interface by providing a link back to the external system.

By default, the Business Data Connectivity (BDC) service provides actions such as View Item, Edit Item, and Delete Item after you model these operations in the BDC model. In addition to these default actions, you can create actions for other functionality that you want to attach to your external content type. For example, you can use actions to perform simple actions such as to send email messages to a customer from the Customer external content type or to open a customer's home page in a browser.

Actions travel with an external content type. That is, after you define an action for an external content type, the action appears everywhere you display that external content type—whether in an external list or Business Data web part or in an External Data column.

<Action Position = "Integer" IsOpenedInNewWindow = "Boolean" Url = "String" ImageUrl = "String" Name = "String" DefaultDisplayName = "String" IsCached = "Boolean"></Action>

Elements and attributes

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

Attributes

Attribute

Description

**Position**

Required.

The suggested position of this action among the other actions of this external content type.

Attribute type: **Integer**

**IsOpenedInNewWindow**

Optional.

Specifies whether the results of executing an action are presented in a new user interface window.

Default value: **false**

Attribute type: **Boolean**

**Url**

Required.

The URL to go to when the action is invoked. The URL string is a Microsoft .NET Framework format string. Each format specifier (for example, {0}) corresponds to an **Action** parameter.

Attribute type: **String**

**ImageUrl**

Optional.

The absolute or relative path to the icon image for the action. The icon image should be 16 x 16 pixels.

Attribute type: **String**

**Name**

Required.

The name of this action.

Attribute type: **String**

**DefaultDisplayName**

Optional.

The default display name for this action.

Attribute type: **String**

**IsCached**

Optional.

Specifies whether this action is used frequently. This is used by the BDC client runtime to cache this action.

Default value: **true**

Attribute type: **Boolean**


Child elements

Element

Description

LocalizedDisplayNames element in MetadataObject (BDCMetadata Schema)

The localized names of the action.

Properties element in MetadataObject (BDCMetadata Schema)

The properties of the action.

ActionParameters element in Action (BDCMetadata Schema)

The parameters of the action.


Parent elements

Element

Description

Actions element in Entity (BDCMetadata Schema)

The list of actions of an external content type.