2.4.1.7 Contact Selector Control

  • Article

The contact selector control provides the ability to select one or more entities from a user information list.

CONTACT_SELECTOR:

 <object class="xdActiveX" hideFocus="1" style="CONTACT_SELECTOR_STYLE" (height="HEIGHT" width="WIDTH")? classid="clsid:61e40d31-993d-4777-8fa0-19ca59b6d0bb" tabIndex="TAB_INDEX" tabStop="true" xd:xctname="{{61e40d31-993d-4777-8fa0-19ca59b6d0bb}}" xd:CtrlId="CONTROL_ID" xd:bindingType="xmlNode" xd:bindingProperty="Value" xd:boundProp="xd:inline" contentEditable="false" xd:binding="GROUP_XPATH" (title="ANY_STRING")? (accessKey="SINGLE_CHARACTER")?>
     <xsl:if test="function-available('xdImage:getImageUrl')">
         <xsl:attribute name="src">
             <xsl:value-of select="xdImage:getImageUrl(GROUP_XPATH)"/>
         </xsl:attribute>
     </xsl:if>
     (<xsl:choose>
         (<xsl:when test="BOOLEAN_XPATH_EXPRESSION">
             <xsl:attribute name="xd:disableEditing">yes</xsl:attribute>
         </xsl:when>)+
     </xsl:choose>)?
     <param NAME="ButtonFont" VALUE="CONTACT_SELECTOR_BUTTON_FONT"/>
     <param NAME="ButtonText" VALUE="ANY_STRING"/>
     <param NAME="DisplayNameXPath" VALUE="CONTACT_SELECTOR_DISPLAY_NAME_XPATH"/>
     <param NAME="ObjectIdXPath" VALUE="CONTACT_SELECTOR_ACCOUNT_ID_XPATH"/>
     <param NAME="ObjectTypeXPath" VALUE="CONTACT_SELECTOR_ACCOUNT_TYPE_XPATH"/>
     <param NAME="SiteUrlXPath" VALUE="/Context/@siteUrl"/>
     <param NAME="SiteUrlDataSource" VALUE="Context"/>
     <param NAME="NewNodeTemplate" VALUE="CONTACT_SELECTOR_NEW_NODE_TEMPLATE"/>
     <param NAME="BackgroundColor" VALUE="CONTACT_SELECTOR_BACKGROUND_COLOR"/>
     <param NAME="MaxLines" VALUE="CONTACT_SELECTOR_MAX_LINES"/>
     <param NAME="Direction" VALUE="CONTACT_SELECTOR_DIRECTION"/>
 </object>

Parameters used by the contact selector control are listed in the following table.

Parameter

Specification

ButtonFont

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

ButtonText

This parameter specifies the text that is displayed on the button that opens the address book.

DisplayNameXPath

This parameter specifies the LEAF_XPATH containing the display names.

ObjectIdXPath

This parameter specifies the LEAF_XPATH containing the object identifiers.

ObjectTypeXPath

This parameter specifies the LEAF_XPATH containing the object types.

SiteUrlXPath

This parameter specifies the LEAF_XPATH in the secondary data source containing the server URL, whose user information list this control is querying. This parameter MUST be ignored by the form server.

SiteUrlDataSource

This parameter specifies the name of the secondary data source that contains the server URL, whose user information list (1) this control is querying. This parameter MUST be ignored by the form server.

NewNodeTemplate

This parameter specifies the XML template that is inserted in the form when a new contact is selected.

BackgroundColor

This parameter specifies the background color of the contact selector input box.

MaxLines

This parameter specifies the maximum number of lines used by the contact selector input box to render display names.

Direction

This parameter specifies whether this control is displaying left-to-right or right-to-left.

FONT: ANY_STRING without a comma.

FONT_ITALIC: The symbol that specifies if the text is shown italic or not. The following table lists the possible values and explanations.

Value

Description

"0"

Not italic

"1"

Italic

FONT_SIZE: All integers and all real numbers, ending in .5, between 1 and 2000, inclusive.

FONT_STRIKETHROUGH: The symbol that specifies if the text is shown with a strike though line. The following table lists the possible values and explanations.

Value

Description

"0"

No strike through

"1"

Strike through

FONT_UNDERLINE: The symbol that specifies if the text shown is underlined. The following table lists the possible values and explanations.

Value

Description

"0"

Not underlined

"1"

Underlined

FONT_WEIGHT: The symbol that specifies if the text shown is bold. The following table lists the possible values and explanations.

Value

Description

"400"

Not bold

"700"

Bold

CHARACTER_SET: ANY_STRING without a comma.

CONTACT_SELECTOR_BUTTON_FONT: FONT, FONT_SIZE, CHARACTER_SET, FONT_WEIGHT, FONT_ITALIC, FONT_UNDERLINE, FONT_STRIKETHROUGH

CONTACT_SELECTOR_STYLE: Semicolon-delimited list of (STYLE_SIZE?, STYLE_MARGIN?, STYLE_TEXT_DECORATION?, STYLE_BACKGROUND_COLOR?, STYLE_BORDER?, STYLE_FONT?, STYLE_COLOR?, STYLE_VERTICAL_ALIGN?)

CONTACT_SELECTOR_BACKGROUND_COLOR: 2147483653 | MUST be an integer value that represents a red-green-blue (RGB) color. The value MUST be calculated using three variables (blue part, red part, green part), each of which MUST be an integer between 0 and 255, in the following formula:

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

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

CONTACT_SELECTOR_DIRECTION: The symbol that specifies if the control is rendered left-to-right or right-to-left. The following table lists the possible values and explanations.

Value

Description

"0"

Use the orientation of the form.

"1"

Left to right.

"2"

Right to-left.

CONTACT_SELECTOR_PERSON_XPATH: RELATIVE_REPREATING_GROUP_XPATH

CONTACT_SELECTOR_DISPLAY_NAME_XPATH: RELATIVE_LEAF_XPATH

CONTACT_SELECTOR_ACCOUNT_ID_XPATH: RELATIVE_LEAF_XPATH

CONTACT_SELECTOR_ACCOUNT_TYPE_XPATH: RELATIVE_LEAF_XPATH

CONTACT_SELECTOR_NEW_NODE_TEMPLATE:

 &lt;RELATIVE_REPREATING_GROUP_XPATH&gt;&#xA;
     &lt;CONTACT_SELECTOR_DISPLAY_NAME_XPATH&gt;&lt;/CONTACT_SELECTOR_DISPLAY_NAME_XPATH&gt;&#xA;   
     &lt;CONTACT_SELECTOR_ACCOUNT_ID_XPATH&gt;&lt;/CONTACT_SELECTOR_ACCOUNT_ID_XPATH&gt;&#xA;
     &lt;CONTACT_SELECTOR_ACCOUNT_TYPE_XPATH&gt;&lt;/CONTACT_SELECTOR_ACCOUNT_TYPE_XPATH&gt;&#xA;
 &lt;/RELATIVE_REPREATING_GROUP_XPATH&gt;

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

Control-specific attributes used by the contact selector control are as follows:

The xdImage:getImageUrl XSL function extension, as specified in section 2.4.3.5, is used by the contact selector control.