Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Contact List Control

The Contact List control shows the contact list for the signed-in user. It is represented in markup by the contact-list tag.

The following example shows the markup to insert the Contact List control into a Web page.

<msgr:contact-list
   context-menu-enabled="true"
   hide-messenger-contacts="false"
   hide-offline-contacts="false"
   mobile-contacts-grouped="true"
   on-selected="my_ContactSelectedEventHandler"
   sort-mode="group"
   word-wheel-enabled="true">
</msgr:contact-list>

For default functionality, insert the control tag with no attributes as shown in the following example.

<msgr:contact-list></msgr:contact-list>

The following table lists the attributes for the Contact List control.

Name Type Required Default Value Description

context-menu-enabled

Boolean

No

True

Sets whether a context menu is enabled for the contact list.

hide-messenger-contacts

Boolean

No

False

Sets whether Messenger contacts are hidden. Set to true to hide contacts.

hide-offline-contacts

Boolean

No

False

Sets whether only online contacts are rendered. Set to true to hide offline contacts.

mobile-contacts-grouped

Boolean

No

False

Sets whether mobile contacts are grouped together. Set to true to group mobile contacts.

on-selected

Function Callback

No

None

Sets the event handler for when contacts are selected. The on-selected event fires when a user selects a contact. The first parameter for the function is ContactSelectedEventArgs.

sort-mode

group | status

No

Group

Sets the sort mode. Set this value to "group" to sort contacts by group, or to "status" to sort by status, such as online, busy, and so on.

word-wheel-enabled

Boolean

No

True

Sets whether a word wheel is rendered as part of the contact list. The word wheel enables the user to search for contacts within the contact list.

The Contact List control is illustrated in the following screen shot.

Search box on the Contact List Control.
Show:
© 2015 Microsoft