Use the StartInstantMessagingButton control in Microsoft Lync Control applications to enable the user to open a Microsoft Lync 2010 conversation window and start an instant messaging conversation between the user who activated the control, and another user specified by the Source property. The control can also start an IM conversation with a distribution group.

StartInstantMessagingButton Control

Members

Notable StartInstantMessagingButton control public properties and events relating to unified communications appear in the following table. For a full list, see Lync 2010 API Class Library documentation.

Property

Description

DisplayName property

Gets the display name of the currently signed-in user.

Source property

Gets or sets the contact to use. Valid types include Contact and DistributionGroup objects, and String.

  • If the value is a string which does not contain the sip: or tel: prefix, the control will perform a search, using the string specified as a search criteria, and will load the first contact in the result set matching the specified string. This behavior is not deterministic, and yields the slowest performance.

  • If the value is a SIP URI string qualified by the sip: or tel: prefix, the contact will be loaded using an exact match of the specified URI. This behavior is deterministic, and yields better performance.

  • If the value is a Contact or DistributionGroup object, it will be used without changes. This behavior is deterministic, and yields the best performance.

ContextualInformation property

Gets or sets a data structure which contains information used to customize the information that accompanies messages. For more information about the use of contextual information, see Contextual Conversations .

Model property

Reserved for internal use. This property may appear in XAML text when editing templates. To preserve control functionality it should remain static.

Code Example

The following example can be used for Microsoft Silverlight and Microsoft Windows Presentation Foundation (WPF) application development.

  Copy imageCopy Code 
<StackPanel>
  <controls:StartInstantMessagingButton
Source="sip:elise@contoso.com" />
</StackPanel>

See Also

Other Resources

Lync Controls