Ektron CMS400.Net Reference

>>Getting Started with CMS400.NET > Logging In and Out > Login Server Control

Login Server Control

The Login server control paints a login button on the template when displayed in a browser. When the Login server control is inserted and the project is built, the control displays the following buttons on a Web page.

Button

Description

When user is not logged in, this button appears. Clicking the button opens the login window, where a user can enter a username and password. Upon authentication, the user is logged in to the Ektron CMS400 Web site.

After a user logs in, this button replaces the login button to let the user log out.

When logged in, this button appears under the logout button, allowing the user to access the Workarea.

Lets the user preview the entire Web site as if all checked-in content were published. For more information, see Site Preview

Turns off site preview mode.

Launches online help for Ektron CMS400.NET.

This subsection contains the following topics:

Placing a Login Button

Login Server Control Properties

Placing a Login Button

You can add any number of login buttons to a template. You can insert a login button on each template, or set up a special Web page, called login.aspx, from which users can log into the CMS400 site without the public being able to access the page.

Login Server Control Properties

The following table explains the properties of the Login server control.

Note: The following table only lists Ektron-specific properties. It does not describe native .NET properties such as font, height, width and border style. For documentation of these properties, see Visual Studio help.

Property

Value

Data Type

Authenticated

Indicates if you are logged in to the CMS
Explorer and can use it to browse to Content, Collections, etc. See Also: Using CMS Explorer to Browse Your Ektron CMS400.NET Site

String

AutoAddType

When using Single Signon, the Login Server Control can be used to add users to Ektron CMS400.NET. In this scenario, when a user signs on with his Active Directory credentials, that user is created within the Ektron CMS400.NET database.

Use this property to define the type of user that is automatically added to Ektron CMS400.NET.

Author = Ektron CMS400.NET user

Member = membership user

See Also: Single Sign On

Common.EkEnumeration.
AutoAddUserType

AutoLogin

If this property is set to true and Active Directory Integration is enabled, users are automatically logged in using Active Directory authentication. They do not need to enter a username or password.

The default is False.

True = Use Active Directory authentication when logging in.

False = Do not use Active Directory authentication when logging in.

Warning! For this property to function
properly, you must be using Active Directory authentication with your Ektron CMS400.NET Site. See Also: Active Directory Feature

Boolean

 

DoInitFill

By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, FIll is automatically called during the Page Render event.

You might do this if you need to set or change a property on the control in codebehind and have it render with your changes shown.

Boolean

Hide

Used to hide login button in design time and run time.

True = Hide login button

False = Show login button

Boolean

Language

Set a language for the Login server control. This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

Integer

OnlyAllowMemberLogin

Allows only membership users to log in. This property prevent users from logging as an Ektron CMS400.NET user and accessing the Ektron CMS400.NET Workarea.

If a CMS user tries to log in using this control, this message appears: “Only members are allowed to login here.”

The default is False.

True = Only membership users can log in

False = Ektron CMS400.NET users and membership users can log in

Boolean

PromptLogout

When set to False, the logout process omits the Logout window (shown below).

True = Users must click Logout to log out.

False =The Logout window does not appear

Boolean

SuppressHelpButton

Hides the Help button that appears below the Login button when set to true. The default is False.

True = Do not display the Help button.

False = Display Help button.

If you are editing this server control from a text file and want to suppress the Help button, add the following code to the login tag source:

<CMS:Login ID="Login1" runat="server"
SuppressHelpButton="True" />

Boolean

SuppressWrapperTags

Suppresses the output of the span/div tags around the control. The default is False.

True - Suppress wrap tags.

False - Allow wrap tags.

Boolean

WrapTag

Allows a developer to specify a server control’s tag.

The default is Span.

Span - The <span> tag is used to designate an in-line portion of an HTML document as a span element.

Div - The <div> tag is used when you want to apply attributes to a block of code.

Custom - Allows you to use a custom tag.

String


Visit the Ektron Dev Center at http://dev.ektron.com 1-866 - 4 - EKTRON

Ektron CMS400.NET Reference Version 8.02 SP1 Rev 1

Ektron Documentation,© 2011 Ektron, Inc.