Export (0) Print
Expand All

Understanding UI Suppression in Lync SDK

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

Use UI suppression in Microsoft Lync 2013 Preview SDK applications to completely hide the Microsoft Lync 2013 Preview UI. UI suppression is useful to support development of a customized, alternative UI in a Lync SDK application.

Note Note

UI suppression disables extensibility through the Automation class and Microsoft Lync Controls.

UI suppression is configured through a registry key. When the key is set, Lync 2013 Preview responds by not initializing the UI layer. When Lync 2013 Preview .exe is started, the associated process runs but the UI is not visible. The Lync 2013 Preview icon does not appear in the Microsoft Windows notification area located to the far right of the task bar or in the Start menu. The Lync 2013 Preview UI can still be accessed using the Microsoft Lync Model API. The UI suppression feature is useful when you want to embed Lync 2013 Preview features in your application and create your own UI to host the Lync 2013 Preview features.

Important note Important

In UI suppression mode, you can only start Lync 2013 Preview from your application by calling the LyncClient.BeginInitialize method on a LyncClient instance. Lync 2013 Preview cannot be started from the Start menu. In addition, if your application initializes Lync 2013 Preview, then your application must also call the LyncClient.BeginShutdown method before closing your custom application.

There are three methods to determine the current UI suppression mode.

  • Check the LyncClient.InSuppressedMode property.

    if (LyncClient.GetClient().InSuppressedMode == true)
    {
        MessageBox.Show("Lync is configured for full UI suppression");
        return;
    }
    
    
  • Discover the value by attempting to get an instance of the Automation class and catching the resulting exception that is raised if UI suppression is enabled.

  • If your computer is a 64-bit computer, read the [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Communicator]"UISuppressionMode" key in the local registry and set the value to dword:00000001, otherwise read the [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Communicator]"UISuppressionMode" key. The key values are identical for both keys. This method is not supported in Lync SDK.

You can set the Lync 2013 Preview suppression mode when you install the Lync client. At the command prompt, start the Lync installation .exe with a command-line argument from the following table.

Argument

Description

/Install

Installs all files.

/Uninstall

Removes all files.

/Silent

Installed UI does not appear.

/FullUisuppression

Lync 2013 Preview is installed so that Lync runs but UI does not appear.

If you want to suppress the Lync UI after it is installed normally, you must first uninstall Lync and then reinstall it with the /FullUisuppression command-line argument.

Community Additions

Show:
© 2014 Microsoft