Share via

2.4.1.21.4 External Item Picker Control

The external item picker control enables the user to select one or more instances of an external content type.

ENTITY_PICKER:

 <object class="xdActiveX" hideFocus="1" style="ENTITY_PICKER_STYLE" classid="clsid:ad74fc20-e09f-4e47-8a87-1da49930867a" tabIndex="TAB_INDEX" (height="HEIGHT" width="WIDTH")? tabStop="true" xd:xctname="entitypicker" xd:CtrlId="CONTROL_ID" xd:server="ANY_STRING" xd:bindingType="xmlNode" xd:bindingProperty="InfoPathValue" xd:boundProp="xd:inline" contentEditable="false" xd:binding="GROUP_XPATH1" (title="ANY_STRING")? (accessKey="SINGLE_CHARACTER")?>
     <xsl:if test="function-available('xdImage:getImageUrl')">
         <xsl:attribute name="src">
             <xsl:value-of select="xdImage:getImageUrl(GROUP_XPATH1)"/>
         </xsl:attribute>
     </xsl:if>
     (<xsl:attribute name="style">ENTITY_PICKER_STYLE?<xsl:choose>
             (<xsl:when test="BOOLEAN_XPATH_EXPRESSION">STYLE_DISPLAY_NONE; STYLE_CAPTION</xsl:when>|
             <xsl:when test="BOOLEAN_XPATH_EXPRESSION">STYLE_CAPTION</xsl:when>)+
         </xsl:choose>
     </xsl:attribute>)?
     (<xsl:choose>
         (<xsl:when test="BOOLEAN_XPATH_EXPRESSION">
             <xsl:attribute name="xd:disableEditing">yes</xsl:attribute>
         </xsl:when>)+
     </xsl:choose>)?
     <param NAME="ButtonFont" VALUE="ENTITY_PICKER_BUTTON_FONT"/>
     <param NAME="Caption" VALUE="ANY_STRING"/>
     <param NAME="EntityNamespace" VALUE="(ENTITY_PICKER_ENTITY_NAMESPACE)?"/>
     <param NAME="EntityName" VALUE="(ENTITY_PICKER_ENTITY_NAME)?"/>
     <param NAME="EntityFinderName" VALUE="ANY_STRING"/>
     <param NAME="BDCInstanceName" VALUE="ANY_STRING"/>
     <param NAME="DisplayFieldName" VALUE="ENTITY_PICKER_DISPLAY_FIELD"/>
     <param NAME="SystemInstanceName" VALUE="ENTITY_PICKER_SYSTEM_INSTANCE"/>
     <param NAME="EntityBDCServerURL" VALUE="ANY_STRING"/>
     <param NAME="DefaultQuery" VALUE="ANY_STRING"/>
     <param NAME="AssociationName" VALUE="ANY_STRING"/>
     <param NAME="EIRLocation" VALUE="(LEAF_XPATH1)?"/>
     <param NAME="DisplayNameLocation" VALUE="(LEAF_XPATH2)?"/>
     <param NAME="Id1Location" VALUE="(LEAF_XPATH3)?"/>
     <param NAME="Id2Location" VALUE="(LEAF_XPATH4)?"/>
     <param NAME="Id3Location" VALUE="(LEAF_XPATH5)?"/>
     <param NAME="Id4Location" VALUE="(LEAF_XPATH6)?"/>
     <param NAME="Id5Location" VALUE="(LEAF_XPATH7)?"/>
     <param NAME="PickerDialogTitle" VALUE="ANY_STRING"/>
     <param NAME="BackgroundColor" VALUE="ENTITY_PICKER_BACKGROUND_COLOR"/>
     <param NAME="MaxLines" VALUE="ENTITY_PICKER_SELECTOR_MAX_LINES"/>
     <param NAME="Direction" VALUE="ENTITY_PICKER_DIRECTION"/>
     <param NAME="MaxResults" VALUE="ANY_STRING"/>
     <param NAME="EntityButtonWidth" VALUE="ANY_STRING"/>
     <param NAME="QueryRequired" VALUE="ANY_STRING"/>
     <param NAME="RefreshOnOpen" VALUE="ANY_STRING"/>
     <param NAME="PickerTargetMode" VALUE="ANY_STRING"/>
     <param NAME="MultiItem" VALUE="ANY_STRING"/>
 </object>

The following table lists parameters used by the external item picker control.

Parameter

Specification

ButtonFont

This parameter specifies the font that is used to render the button text and display names.

Caption

This parameter specifies the text that is displayed on the button that opens the external item picker dialog.

EntityNamespace

This parameter specifies the entity namespace of an external content type.

EntityName

This parameter specifies the name of an external content type.

EntityFinderName

This parameter MUST be ignored.

BDCInstanceName

This parameter MUST be ignored.

DisplayFieldName

This parameter specifies the location, within the instance of an external content type, from where to obtain the suggested value to be used when displaying the instance of an external content type in the external item picker control.

SystemInstanceName

This parameter specifies the name of a LobSystemInstance.

EntityBDCServerURL

This parameter MUST be ignored.

DefaultQuery

This parameter MUST be ignored.

AssociationName

This parameter MUST be ignored.

EIRLocation

This parameter specifies the LEAF_XPATH containing the reference to the first instance of the external content type selected in the external item picker control.

DisplayNameLocation

This parameter specifies the LEAF_XPATH containing the suggested value to be used when displaying the instance of an external content type in the external item picker control.

Id1Location

This parameter specifies the LEAF_XPATH containing the first Identifier value for the first instance of the external content type selected in the external item picker control.

Id2Location

This parameter specifies the LEAF_XPATH containing the second Identifier value for the first instance of the external content type selected in the external item picker control.

Id3Location

This parameter specifies the LEAF_XPATH containing the third Identifier value for the first instance of the external content type selected in the external item picker control.

Id4Location

This parameter specifies the LEAF_XPATH containing the fourth Identifier value for the first instance of the external content type selected in the external item picker control.

Id5Location

This parameter specifies the LEAF_XPATH containing the fifth Identifier value for the first instance of the external content type selected in the external item picker control.

PickerDialogTitle

This parameter specifies the text that is displayed as the title of the external item picker dialog.

BackgroundColor

This parameter specifies the background color of the external item picker input box.

MaxLines

This parameter specifies the maximum number of lines used by the external item picker input box to render instances of an external content type.

Direction

This parameter specifies whether the external item picker control is displaying left-to-right or right-to-left.

MaxResults

This parameter MUST be ignored.

EntityButtonWidth

This parameter MUST be ignored.

QueryRequired

This parameter MUST be ignored.

RefreshOnOpen

This parameter MUST be ignored.

PickerTargetMode

This parameter MUST be ignored.

MultiItem

This parameter MUST be ignored.

ENTITY_PICKER_BUTTON_FONT: FONT, FONT_SIZE, CHARACTER_SET, FONT_WEIGHT, FONT_ITALIC, FONT_UNDERLINE, FONT_STRIKETHROUGH.

ENTITY_PICKER_STYLE: Semicolon-delimited list of (STYLE_SIZE?, STYLE_MARGIN?, STYLE_TEXT_DECORATION?, (BACKGROUND-COLOR: transparent; STYLE_XD_BACKGROUND_COLOR)?, STYLE_BORDER?, STYLE_FONT?, STYLE_COLOR?, STYLE_VERTICAL_ALIGN?, STYLE_DIRECTION?).

ENTITY_PICKER_BACKGROUND_COLOR: MUST be "2147483653" or MUST be an integer value that represents an RGB color. The value MUST be calculated using three variables (blue part, red part, green part), each of which MUST be an integer between zero and 255, in the following formula:

  • blue part * 65536 + green part * 256 + red part

ENTITY_PICKER_MAX_LINES: MUST be an integer between zero and 999, inclusive.

The ENTITY_PICKER_DIRECTION symbol specifies if the control is rendered left-to-right or right-to-left. The following table describes the possible values.

Value

Description

"0"

Use the form’s orientation.

"1"

Left-to-right.

"2"

Right-to-left.

ENTITY_PICKER_ENTITY_NAMESPACE: The value MUST be an entityNamespace, as specified in section 2.2.1.2.129.

ENTITY_PICKER_ENTITY_NAME: The value MUST be an entityName, as specified in section 2.2.1.2.129.

ENTITY_PICKER_SYSTEM_INSTANCE: The value MUST be a LobSystemInstance, as specified in section 2.2.1.2.129.

ENTITY_PICKER_DISPLAY_FIELD: MUST be an encoded string, as specified in [XML10], and MUST be specified in a hierarchical fashion. The first token in the location MUST be the name of one of the fields of the external content type. Any subsequent token MUST be the name of a field contained in the field identified by the previous token. Tokens MUST be separated by a single period ("."). If appearing within the name of a token, the following characters MUST be replaced by their encoded string counterparts:

Character

Encoded string counterpart

Left bracket ("[")

Backslash, left bracket ("\[")

Period (".")

Backslash, period ("\.")

Backslash ("\")

Backslash, backslash ("\\")

GROUP_XPATH MUST point to an XML node in the main data source.

The following table lists control-specific attributes used by the external item picker control.

Attribute

Section

xd:binding

2.4.2.6

xd:bindingProperty

2.4.2.7

xd:bindingType

2.4.2.8

xd:boundProp

2.4.2.9

xd:CtrlId

2.4.2.10

xd:disableEditing

2.4.2.12

xd:server

2.4.2.37.8

xd:xctname

2.4.2.35

The xdImage:getImageUrl XSL function extension, as specified in section 2.4.3.5, is used by the external item picker control.