ActionParameter element in ActionParameters (BDCMetadata Schema)
Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013
Specifies the parameters of a URL-based action. Defines how to parameterize the URL of an action with EntityInstance-specific data.
Namespace: http://schemas.microsoft.com/windows/2007/BusinessDataCatalog
Schema: BDCMetadata
The URL attribute of a URL-based action can receive parameters by using the ActionParameter element.
Important
ActionParameters can either represent identifier values, or values that correspond to TypeDescriptors in a SpecificFinder of the Entity.
The ActionParameter represents an identifier value when the IdOrdinal property is present. The value of the property specifies the index of the identifier whose value this ActionParameter represents. If the IdOrdinal property is not specified, the ActionParameter represents a TypeDescriptor, and the Name attribute specifies which type descriptor is being represented. The Name attribute is specified as a Dotted Path.
The ActionParameter element accepts the following property.
Important
Properties are case-sensitive.
Properties
Property |
Type |
Description |
Required |
Default Value |
Limits/Accepted Values |
|---|---|---|---|---|---|
**IdOrdinal** |
**System.Int32** |
Specifies if the **ActionParameter** represents an identifier instead of a field. |
Optional |
<ActionParameter Index = "Integer" Name = "String" DefaultDisplayName = "String" IsCached = "Boolean"> </ActionParameter>
Elements and attributes
The following sections describe attributes, child elements, and parent elements.
Attributes
Attribute |
Description |
|---|---|
**Index** |
Required. An ordinal attribute that specifies the position of this **ActionParameter** among other **ActionParameters** in the URL. Attribute type: **Integer** |
**Name** |
Required. The name of the **ActionParameter**. Attribute type: **String** |
**DefaultDisplayName** |
Optional. The default display name for the **ActionParameter**. Attribute type: **String** |
**IsCached** |
Optional. Specifies whether this **ActionParameter** is used frequently. This attribute 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 display names for the ActionParameter. |
| Properties element in MetadataObject (BDCMetadata Schema) | The properties of the ActionParameter. |
Parent elements
| Element | Description |
|---|---|
| ActionParameters element in Action (BDCMetadata Schema) | The ActionParameters element that contains this ActionParameter. |