SignInControl.Hide Method (Microsoft.Live.Messenger.UI)

Windows Live Messenger Web Toolkit Class Reference

SignInControl..::.Hide Method

Hides the SignInControl.

Script: http://www.wlmessenger.net/api/3.5/loader.js
Feature: Messenger.Core
Namespace: Microsoft.Live.Messenger.UI

Syntax

JavaScript

instance.hide();

C# (Script#)

public void Hide()

Remarks

The sign-in control is initially visible since the user must use the control to sign into Messenger. Once the AuthenticationCompleted event has been raised, an application can invoke the Hide()()() method to prevent the control from being rendered as UI on the page. To render the control when it is hidden, use the Show()()() method.

If this method is called, the application must show the sign-in control links. An application can access the sign-in control links by using the Links property of SignInControl.

If this method is invoked when the control is already hidden it has no effect.

Examples

JavaScript

            // Add a function that handles the AuthenticationCompleted event.
            _signin.add_authenticationCompleted(authenticationCompleted);
            
            // This function is invoked once the user has authenticated with Windows Live.
            function authenticationCompleted(sender, e) {
                // Hide the control.
                _signin.hide();
            
                _user = new Microsoft.Live.Messenger.User(e.get_identity());
                _user.add_signInCompleted(signInCompleted);
                _user.signIn();
            }

Version Information

Windows Live Messenger Web Toolkit

Supported in: 3.5, 3.1, 3.0, 2.5

Platforms

Internet Explorer 8.0, Internet Explorer 7.0, Internet Explorer 6.0, Firefox 3.5, Firefox 3.0, Firefox 2.0, Firefox 1.5, Chrome 2.0, Chrome 1.0, Safari 4.0, Safari 3.0