Login

The Login server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. places a login button on the template when displayed in a browser. The Login server control displays the following buttons on a Web page. See also: Managing Logins and Passwords.

. 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 website.

. 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 website as if all checked-in content were published.

. Turns off site preview mode.

. Launches Ektron online help.

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 Ektron site without the public being able to access the page.

Inserting the Login server control onto a page

Prerequisite

You must have installed the server controls. See Installing server controls into Visual Studio Toolbox.

  1. In Visual Studio, choose View > Toolbox.
  2. Click the Ektron server control tab to display the server controls.
  3. Drag the Login server control and drop it into the desired location on the page.

    NOTE: You also can place the cursor on the page where you want the server control, then double click the server control that you want.

    <CMS:Login ID="Login1" runat="server" />
  4. Click on Login in the code to display and modify the control’s properties using the Properties window of Visual Studio. The page is updated as you modify the property values.

Login properties

The following are Ektron-specific server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. properties. For information about native .NET properties such as font, height, width and border style, use Visual Studio® help.

  • AutoAddType (Common.EkEnumeration.AutoAddUserType)

    When using Single Signon, the Login server control can be used to add users to Ektron. In this scenario, when a user signs on with Active Directory credentials, that user is created within the Ektron database. Use this property to define the type of user that is automatically added to Ektron. See also: Single Sign On.

    • Author. Ektron user
    • Member. Membership user
  • AutoLogin (Boolean)

    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. See also: Single Sign On.

    • True. Use Active Directory authentication when logging in.
    • False (default). Do not use Active Directory authentication when logging in.
  • DoInitFill (Boolean)

    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 code-behind and have it render with your changes shown.

  • Hide (Boolean)

    Hides or displays the output of the control in design time and run time.

    • True. Hide the control output.
    • False. Display the control output.
  • Language (Integer)

    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).

  • OnlyAllowMemberLogin (Boolean)

    Allows only membership usera user with limited privileges, such as writing to a community forum, but not having the same privileges as a forum moderator, or an administrator who has access to the Workarea. (A community user is the same as a membership user.)s to log in. This property prevent users from logging as an Ektron user and accessing the Workarea. If an Ektron 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 users and membership users can log in
  • PromptLogout (Boolean)

    When set to False, the logout process omits the Logout window.

    • True. Users must click Logout to log out.
    • False. Logout window does not appear.
  • SuppressHelpButton (Boolean)

    Hides or displays the Help button. When displayed, the button appears below the Login button.

    • True. Do not display the Help button.

    • False (default). 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" />
  • SuppressWrapperTags (Boolean)

    Suppresses the output of the span/div tags around the control.

    • True. Suppress wrap tags.
    • False (default). Allow wrap tags.
  • WrapTag (String)

    Lets a developer specify a server control’s tag.

    • Span (default). Designate an inline portion of an HTML document as a span element.
    • Div. Apply attributes to a block of code.
    • Custom. Lets you use a custom tag.