Export (0) Print
Expand All

SendEmailButton Control

[This is preliminary documentation and is subject to change.]

Use the SendEmailButton control in Microsoft Lync Control applications to start Microsoft Outlook and compose an email to a selected contact. The selected contact must have an email address exposed in order for this feature to work. Optionally, you can specify a subject for the email as well.

The control is designed to mimic the functionality provided by the corresponding button on the Quick Connect toolbar of the ContactCard. As such, it must be bound to a contact using the Source property before it can be used. When clicked, it starts Outlook and initiates the desired action with that contact. This button is not a general purpose Outlook Integration tool. It is intended to be used together with other Lync Controls to provide a full set of collaboration options for interacting with a specific contact or distribution group. Despite the fact that no Microsoft Lync 2013 Preview functionality is actually used here, this control leverages the binding model of the other Lync Controls to provide the full scope of features accessible on the ContactCard quick-connect toolbar.

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

Property or Event

Description

DisplayName property

Gets the display name of the currently logged 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 as-is. This behavior is deterministic, and yields the best performance.

Subject property

Gets or sets the subject string for the message.

ContextualInformation property

This property is ignored. Gets or sets a data structure which contains information used to customize the information that accompanies messages. For more information on the use of contextual information, see the topics listed at 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 unchanged.

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

<StackPanel>
  <controls:SendEmailButton Source="sip:elise@contoso.com"/>
</StackPanel>

Community Additions

Show:
© 2014 Microsoft