ActionParameter Element in ActionParameters (BDCMetadata Schema)

  • Article

Applies to: SharePoint Server 2010

Specifies the parameters of a URL-based action. It defines how to parameterize the URL of an action with EntityInstance-specific data.

Namespace: https://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>

Attributes and Elements

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.