CommunityAliasManager

The CommunityAliasManager class manages aliases that apply to communities.

Namespace

Ektron.Cms.Framework.Settings.UrlAliasing.CommunityAliasManager

Constructors

  • CommunityAliasManager()
  • CommunityAliasManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Common.UrlAliasCommunityData)

Adds a UrlAliasCommunityData object.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Community Alias Type
  • * Extension
  • * Alias Path
  • Is Enabled
  • Primary

Parameters

  • data

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCommunityAliasTypeLabel" AssociatedControlID="uxCommunityAliasType" CssClass="span-3 last" runat="server" Text="* Community Alias Type:" />
        <asp:DropDownList ID="uxCommunityAliasType" runat="server">
            <asp:ListItem>User</asp:ListItem>
            <asp:ListItem>Group</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxExtensionLabel" AssociatedControlID="uxExtension" CssClass="span-3 last" runat="server" Text="* Extension:" />
        <asp:DropDownList ID="uxExtension" runat="server">
            <asp:ListItem>.aspx</asp:ListItem>
            <asp:ListItem>/</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAliasPathLabel" AssociatedControlID="uxAliasPath" CssClass="span-3 last" runat="server" Text="* Alias Path:" />
        <ektronUI:TextField  ID="uxAliasPath" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEnabledLabel" AssociatedControlID="uxIsEnabled" CssClass="span-3 last" runat="server" Text=" Is Enabled:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxIsEnabled" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPrimaryLabel" AssociatedControlID="uxPrimary" CssClass="span-3 last" runat="server" Text=" Primary:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxPrimary" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
                    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Settings.UrlAliasing;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CommunityAliasManager communityAliasManager = new CommunityAliasManager();
            UrlAliasCommunityData urlAliasCommunityData = new UrlAliasCommunityData()
            {
                IsEnabled = uxIsEnabled.Checked,
                IsDefault = uxPrimary.Checked ,
                CommunityAliasType = (uxCommunityAliasType.SelectedItem.Value == "User" ? EkEnumeration.CommunityAliasType.Group : EkEnumeration.CommunityAliasType.User),
                FileExtension = uxExtension.SelectedItem.Value,
                AliasPath = uxAliasPath.Text,
                Example = uxAliasPath.Text + "/[" + uxCommunityAliasType.SelectedItem.Value + "Name]" + uxExtension.SelectedItem.Value
            };

            communityAliasManager.Add(urlAliasCommunityData);

            MessageUtilities.UpdateMessage(uxMessage, "Community Alias added with Id " + urlAliasCommunityData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes an UrlAliasCommunityData object from the CMS.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • id. Community Alias ID.

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCommunityAliasIdLabel" AssociatedControlID="uxCommunityAliasId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxCommunityAliasId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Settings.UrlAliasing;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long communityAliasId = long.Parse(uxCommunityAliasId.Text);
            CommunityAliasManager communityAliasManager = new CommunityAliasManager();
            UrlAliasCommunityData urlAliasCommunityData = communityAliasManager.GetItem(communityAliasId);
            if (urlAliasCommunityData != null)
            {
                communityAliasManager.Delete(communityAliasId);
                MessageUtilities.UpdateMessage(uxMessage, "Community Alias deleted.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Activity", Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetCommunityGroupAlias

GetCommunityGroupAlias(System.Int64)

Retrieves the alias of a community group.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • groupId. ID of the group.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxGroupIdLabel" AssociatedControlID="uxGroupId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Community Group Alias"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Settings.UrlAliasing;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CommunityAliasManager communityAliasManager = new CommunityAliasManager();
            string communityGroupAlias = communityAliasManager.GetCommunityGroupAlias(long.Parse(uxGroupId.Text));

            if(communityGroupAlias != string.Empty)
                 MessageUtilities.UpdateMessage(uxMessage, "community Group Alias :   " + communityGroupAlias, Message.DisplayModes.Success);
            else
             MessageUtilities.UpdateMessage(uxMessage, "community Group Alias does not exists.", Message.DisplayModes.Error);

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.UrlAliasCommunityData)

Retrieves the properties of a specific UrlAliasCommunityData object.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • id. ID of the UrlAliasCommunity to get.

Returns

UrlAliasCommunity details in a UrlAliasCommunityData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCommunityAliasIdLabel" AssociatedControlID="uxCommunityAliasId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxCommunityAliasId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsEnabled" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAliasName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCommunityAliasType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFileExtension" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLanguageId" runat="server"></asp:Literal> 
    </li>
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Settings.UrlAliasing;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long communityAliasId = long.Parse(uxCommunityAliasId.Text);

            CommunityAliasManager communityAliasManager = new CommunityAliasManager();
            UrlAliasCommunityData urlAliasCommunityData = communityAliasManager.GetItem(communityAliasId);

            if (urlAliasCommunityData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage,"Details for community alias with ID " + urlAliasCommunityData.Id.ToString() + " are below", Message.DisplayModes.Success);

                uxIsEnabled.Text = "Is Enabled : " + urlAliasCommunityData.IsEnabled;
                uxAliasName.Text = "Alias Name : " + urlAliasCommunityData.AliasName ;
                uxCommunityAliasType.Text = "Community Alias Type : " + (EkEnumeration.CommunityAliasType)urlAliasCommunityData.CommunityAliasType;
                uxFileExtension.Text = "File Extension : " + urlAliasCommunityData.FileExtension;
                uxLanguageId.Text = "Language Id : " + urlAliasCommunityData.LanguageId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Auto Alias does not exists.", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.UrlAliasing.CommunityAliasCriteria)

Retrieves lists of objects.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • Community Alias Property
  • * Object Value

Parameters

Returns

A list of UrlAliasCommunityData objects.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

Remarks

Use ListView because it has a paging option and data grouping.

Use the default page size = 50.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCommunityAliasPropertyLabel" AssociatedControlID="uxCommunityAliasProperty" CssClass="span-6 last" runat="server" Text="Community Alias Property:" />
        <asp:DropDownList ID="uxCommunityAliasProperty" runat="server">
            <asp:ListItem>CommunityAliasType</asp:ListItem>
            <asp:ListItem>AliasPath</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
        
<asp:ListView ID="uxUrlAliasCommunityDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        Alias Path
                    </th>
                    <th>
                        File Extension
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("AliasPath")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FileExtension")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.UrlAliasing;
using Ektron.Cms.Framework.Settings.UrlAliasing;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;

            CommunityAliasCriteria criteria = new CommunityAliasCriteria();
            if (uxCommunityAliasProperty.SelectedItem.Text == "CommunityAliasType")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CommunityAliasProperty.CommunityAliasType, CriteriaFilterOperator.EqualTo , Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CommunityAliasProperty.AliasPath, CriteriaFilterOperator.Contains, Objectvalue);
            }

            CommunityAliasManager communityAliasManager = new CommunityAliasManager();
            List<UrlAliasCommunityData> urlAliasCommunityDataList = communityAliasManager.GetList(criteria);

            uxUrlAliasCommunityDataListView.Visible = true;
            uxUrlAliasCommunityDataListView.DataSource = urlAliasCommunityDataList;
            uxUrlAliasCommunityDataListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetUserAlias

GetUserAlias(System.Int64)

Retrieves the alias of a user.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • userId. ID of the user.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get User Alias"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Settings.UrlAliasing;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CommunityAliasManager communityAliasManager = new CommunityAliasManager();
            string userAlias = communityAliasManager.GetUserAlias(long.Parse(uxUserId.Text));
            if(userAlias != string.Empty)
                 MessageUtilities.UpdateMessage(uxMessage, "User Alias :   " + userAlias, Message.DisplayModes.Success);
            else
             MessageUtilities.UpdateMessage(uxMessage, "User Alias does not exists. ", Message.DisplayModes.Error);

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Common.UrlAliasCommunityData)

Updates a UrlAliasCommunity, with details from the supplied UrlAliasCommunityData object.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Community Alias ID
  • * Extension
  • Alias Path
  • * Is Enabled
  • * Primary

Parameters

  • data

Returns

Returns the custom CmsData object updated.

Remarks

Validate the community alias with GetItem() before you update the properties. Then, call Update with your modified UrlAliasCommunityData object.

NOTE: You cannot change all properties after the initial Add event, such as the UrlAliasCommunityData .Type.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCommunityAliasIdLabel" AssociatedControlID="uxCommunityAliasId" CssClass="span-4 last" runat="server" Text="* Community Alias Id:" />
        <ektronUI:TextField  ID="uxCommunityAliasId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxExtensionLabel" AssociatedControlID="uxExtension" CssClass="span-4 last" runat="server" Text="* Extension:" />
        <asp:DropDownList ID="uxExtension" runat="server">
            <asp:ListItem>.aspx</asp:ListItem>
            <asp:ListItem>/</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAliasPathLabel" AssociatedControlID="uxAliasPath" CssClass="span-4 last" runat="server" Text=" Alias Path:" />
        <ektronUI:TextField  ID="uxAliasPath" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEnabledLabel" AssociatedControlID="uxIsEnabled" CssClass="span-4 last" runat="server" Text="* Is Enabled:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxIsEnabled" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPrimaryLabel" AssociatedControlID="uxPrimary" CssClass="span-4 last" runat="server" Text="* Primary:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxPrimary" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
                    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Settings.UrlAliasing;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long communityAliasId = long.Parse(uxCommunityAliasId.Text);

            CommunityAliasManager communityAliasManager = new CommunityAliasManager();
            UrlAliasCommunityData urlAliasCommunityData = communityAliasManager.GetItem(communityAliasId);

            if (urlAliasCommunityData != null)
            {
                urlAliasCommunityData.IsEnabled = uxIsEnabled.Checked;
                urlAliasCommunityData.IsDefault = uxPrimary.Checked;
                urlAliasCommunityData.FileExtension = uxExtension.SelectedItem.Value;
                urlAliasCommunityData.AliasName = uxAliasPath.Text != string.Empty ? uxAliasPath.Text : urlAliasCommunityData.AliasName;
				urlAliasCommunityData.AliasPath = uxAliasPath.Text != string.Empty ? uxAliasPath.Text : urlAliasCommunityData.AliasPath;
                urlAliasCommunityData.Example = uxAliasPath.Text != string.Empty ? uxAliasPath.Text + "/[" + urlAliasCommunityData.CommunityAliasType.ToString() + "Name]" + uxExtension.SelectedItem.Value : urlAliasCommunityData.Example;

                communityAliasManager.Update(urlAliasCommunityData);

                MessageUtilities.UpdateMessage(uxMessage,  "Community Alias updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,"Community Alias does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

CommunityAliasCriteria

Namespace

Ektron.Cms.UrlAliasing

Constructors

  • CommunityAliasCriteria()
    public CommunityAliasCriteria()
  • CommunityAliasCriteria(Ektron.Cms.UrlAliasing.CommunityAliasProperty, EkEnumeration.OrderByDirection)
    public CommunityAliasCriteria(Ektron.Cms.UrlAliasing.CommunityAliasProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the CommunityAliasProperty are:

    • AliasPath
    • CommunityAliasType
    • Example
    • FileExtension
    • Id
    • IsDefault
    • IsEnabled
    • LanguageId
    • ReplacementCharacter
    • SiteId
    • SourceParmName

UrlAliasCommunityData

Namespace

Ektron.Cms.Common

Properties

  • AliasName
    public string AliasName { set; get; }
  • AliasPath
    public string AliasPath { set; get; }
  • CommunityAliasType
    public EkEnumeration.CommunityAliasType
  CommunityAliasType { set; get; }
  • DisplayName
    public string DisplayName { set; get; }
  • Example. Gets or sets a sample of the selected configuration.
    public string Example { set; get; }
  • FileExtension
    public string FileExtension { set; get; }
  • HostName. Gets the name of the host where the content resides.
    public string HostName { set; get; }
  • Id. Gets the unique ID generated for this record.
    public long Id { set; get; }
  • IsDefault
    public bool IsDefault { set; get; }
  • IsEnabled. Gets or sets whether the configuration is active.
    public bool IsEnabled { set; get; }
  • LanguageId. Gets the language ID for the automatic alias.
    public int LanguageId { set; get; }
  • ObjectId
    public long ObjectId { set; get; }
  • ReplacementCharacter. Gets or sets the character that will replace special characters in the generated URL.
    public string ReplacementCharacter { set; get; }
  • SiteId
    public long SiteId { set; get; }
  • SourceParmName
    public string SourceParmName { set; get; }
  • Target. Gets the destination for the alias.
    public string Target { set; get; }
  • TimeStamp
    public System.DateTime TimeStamp { set; get; }
  • UrlAliasCommunityData()
    public UrlAliasCommunityData()
  • UrlAliasCommunityData(long, EkEnumeration.CommunityAliasType, string, string)
    public UrlAliasCommunityData(long siteId,
  EkEnumeration.CommunityAliasType communityAliasType,
  string aliasPath, string fileExtension)