Add

Add(Ektron.Cms.Common.UrlAliasAutoData)

Adds a UrlAliasAutoData object.

The method populates the message.Id with the newly created ID.

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

• * Auto Alias Type
• * Extension
• Source ID
• Is Enabled

Parameters

• data. UrlAliasAutoData object.

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAutoAliasTypeLabel" AssociatedControlID="uxAutoAliasType" CssClass="span-3 last" runat="server" Text="* Auto Alias Type:" />
        <asp:DropDownList ID="uxAutoAliasType" runat="server">
            <asp:ListItem>Taxonomy</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="uxSourceIdLabel" AssociatedControlID="uxSourceId" CssClass="span-3 last" runat="server" Text=" Source Id:" />
        <ektronUI:TextField  ID="uxSourceId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"  Text="248"  /> 
    </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: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.Framework.Settings.UrlAliasing;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            AutoAliasManager autoAliasManager = new AutoAliasManager();
            UrlAliasAutoData urlAliasAutoData = new UrlAliasAutoData(-1, EkEnumeration.AutoAliasType.Taxonomy, long.Parse(uxSourceId.Text) , uxExtension.SelectedItem.Text)
            {
                IsEnabled = uxIsEnabled.Checked,
                LanguageId = autoAliasManager.RequestInformation.ContentLanguage ,
                PageNameType = EkEnumeration.AutoAliasNameType.ContentId
            };

            autoAliasManager.Add(urlAliasAutoData);

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

ClearCache

ClearCache()

Clears the cache. This method has no parameters.

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.

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            AutoAliasManager autoAliasManager = new AutoAliasManager();
            autoAliasManager.ClearCache();

            MessageUtilities.UpdateMessage(uxMessage, "Cache Cleared", 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 a UrlAliasAutoData 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. Unique ID of the AutoAlias

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAutoAliasIdLabel" AssociatedControlID="uxAutoAliasId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxAutoAliasId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
                <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                    Text="Status:" />
            </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 autoAliasId = long.Parse(uxAutoAliasId.Text);

            AutoAliasManager autoAliasManager = new AutoAliasManager();
            UrlAliasAutoData urlAliasAutoData = autoAliasManager.GetItem(autoAliasId);

            if (urlAliasAutoData != null)
            {
                autoAliasManager.Delete(autoAliasId);
                MessageUtilities.UpdateMessage(uxMessage,"Auto Alias deleted.", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid AutoAliasId.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.UrlAliasAutoData)

Retrieves the properties of a specific UrlAliasAutoData 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. Unique ID of the AutoAlias.

Returns

UrlAliasAutoData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxManualAliasIdLabel" AssociatedControlID="uxManualAliasId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxManualAliasId" 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="uxSelectedPath" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAutoAliasType" 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 autoAliasId = long.Parse(uxManualAliasId.Text);

            AutoAliasManager autoAliasManager = new AutoAliasManager();
            UrlAliasAutoData urlAliasAutoData = autoAliasManager.GetItem(autoAliasId);

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

                uxIsEnabled.Text = "Is Enabled : " + urlAliasAutoData.IsEnabled;
                uxSelectedPath.Text = "Selected Path : " + urlAliasAutoData.SelectedPath;
                uxAutoAliasType.Text = "Auto Alias Type : " + (EkEnumeration.AutoAliasType)urlAliasAutoData.AutoAliasType;
                uxFileExtension.Text = "File Extension : " + urlAliasAutoData.FileExtension;
                uxLanguageId.Text = "Language Id : " + urlAliasAutoData.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(AutoAliasCriteria)

Retrieves lists of objects through the GetList(AutoAliasCriteria) method.

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

• Manual Alias Property
• * Object Value

Parameters

• criteria. AutoAliasCriteria defining which AutoAlias to get.

Returns

List of UrlAliasAutoData object.

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.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxManualAliasPropertyLabel" AssociatedControlID="uxManualAliasProperty" CssClass="span-6 last" runat="server" Text="Manual Alias Property:" />
        <asp:DropDownList ID="uxManualAliasProperty" runat="server">
            <asp:ListItem>AutoAliasType</asp:ListItem>
            <asp:ListItem>SelectedPath</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="uxAutoAliasDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Selected Path
                    </th>
                    <th>
                        Auto Alias Type
                    </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("SelectedPath")%>
            </td>
            <td class="devsite-method">
                <%# Eval("AutoAliasType")%>
            </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;

            AutoAliasCriteria criteria = new AutoAliasCriteria();
            if (uxManualAliasProperty.SelectedItem.Text == "AutoAliasType")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(AutoAliasProperty.AutoAliasType, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(AutoAliasProperty.SelectedPath, CriteriaFilterOperator.Contains, Objectvalue);
            }

            AutoAliasManager autoAliasManager = new AutoAliasManager();
            List<UrlAliasAutoData> urlAliasAutoDataList = autoAliasManager.GetList(criteria);

            uxAutoAliasDataListView.Visible = true;
            uxAutoAliasDataListView.DataSource = urlAliasAutoDataList;
            uxAutoAliasDataListView.DataBind();

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

GetTarget (alias and host)

GetTarget(System.String,System.String)

Retrieves the target data based on the URL alias and the host.

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

• * URL Alias
• Host

Parameters

• urlAlias. urlAlias of the target to retrieve.
• host. Host of the target to retrieve.

Returns

Target string.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUrlAliasLabel" AssociatedControlID="uxUrlAlias" CssClass="span-3 last" runat="server" Text="* Url Alias :" />
        <ektronUI:TextField ID="uxUrlAlias" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxHostLabel" AssociatedControlID="uxHost" CssClass="span-3 last" runat="server" Text=" Host :" />
        <ektronUI:TextField ID="uxHost" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Target"></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
        {
            AutoAliasManager autoAliasManager = new AutoAliasManager();
            string target = autoAliasManager.GetTarget(uxUrlAlias.Text, uxHost.Text);
            if (!string.IsNullOrEmpty(target))
            {
                MessageUtilities.UpdateMessage(uxMessage, "Target URL :     " + target, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "There is No Target URL.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetTarget (alias, host and type)

GetTarget(System.String,System.String,
Ektron.Cms.Common.EkEnumeration.AutoAliasType)

Retrieves the target data based on the URL alias, host, and AutoAliasType.

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

• * URL Alias
• Host
• * Auto Alias Type

Parameters

• urlAlias. urlAlias of the Target to retrieve.
• host. Host of the target to retrieve.
• autoAliasType. AutoAliasType of the Target to retrieve.

Returns

Target string.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUrlAliasLabel" AssociatedControlID="uxUrlAlias" CssClass="span-3 last" runat="server" Text="* Url Alias :" />
        <ektronUI:TextField ID="uxUrlAlias" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxHostLabel" AssociatedControlID="uxHost" CssClass="span-3 last" runat="server" Text=" Host :" />
        <ektronUI:TextField ID="uxHost" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAutoAliasTypeLabel" AssociatedControlID="uxAutoAliasType" CssClass="span-3 last" runat="server" Text="* Auto Alias Type:" />
        <asp:DropDownList ID="uxAutoAliasType" runat="server">
            <asp:ListItem>Folder</asp:ListItem>
            <asp:ListItem>Taxonomy</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Target"></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
        {
            AutoAliasManager autoAliasManager = new AutoAliasManager();
            EkEnumeration.AutoAliasType autoAliasType = (uxAutoAliasType.SelectedItem.Text ==  "Folder" ? EkEnumeration.AutoAliasType.Folder : EkEnumeration.AutoAliasType.Taxonomy );
            string target = autoAliasManager.GetTarget(uxUrlAlias.Text, uxHost.Text, autoAliasType);

            MessageUtilities.UpdateMessage(uxMessage,  "Target URL :     " + target, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.AutoAliasData)

Updates an existing UrlAutoAlias in 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
• * Extension
• Source ID
• * Is Enable

Parameters

• data. UrlAliasAutoData object

Returns

Returns the custom CmsData object updated.

Remarks

Validate the message item with GetItem() before you update the properties. Then, call Update with your modified UrlAliasAutoData object.

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAutoAliasIdLabel" AssociatedControlID="uxAutoAliasId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxAutoAliasId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </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="uxSourceIdLabel" AssociatedControlID="uxSourceId" CssClass="span-3 last" runat="server" Text=" Source Id:" />
        <ektronUI:TextField  ID="uxSourceId" 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:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></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
        {
            long autoAliasId = long.Parse(uxAutoAliasId.Text);

            AutoAliasManager autoAliasManager = new AutoAliasManager();
            UrlAliasAutoData urlAliasAutoData = autoAliasManager.GetItem(autoAliasId);

            if (urlAliasAutoData != null)
            {
                urlAliasAutoData.IsEnabled = uxIsEnabled.Checked;
                urlAliasAutoData.FileExtension = uxExtension.SelectedItem.Text;
                urlAliasAutoData.SourceId = (uxSourceId.Text != string.Empty ? long.Parse(uxSourceId.Text) : urlAliasAutoData.SourceId); 

                autoAliasManager.Update(urlAliasAutoData);

                MessageUtilities.UpdateMessage(uxMessage, "Auto Alias updated", Message.DisplayModes.Success);
            }
            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);
        }
    }

AutoAliasCriteria

Namespace

Ektron.Cms.UrlAliasing

Constructors

• AutoAliasCriteria()

  public AutoAliasCriteria()

• AutoAliasCriteria(Ektron.Cms.UrlAliasing.AutoAliasProperty, EkEnumeration.OrderByDirection)

  public AutoAliasCriteria(Ektron.Cms.UrlAliasing.AutoAliasProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the AutoAliasProperty are:

  • AutoAliasType
  • Example
  • ExcludedPath
  • FileExtension
  • IsEnabled
  • LanguageId
  • PageNameType
  • ReplacementCharacter
  • SelectedPath
  • SiteId
  • SourceId
  • SourceName
  • SourceParmName

AutoAliasType

Namespace

Ektron.Cms.Common.EkEnumeration

Properties

• Folder

  public Const Folder As Ektron.Cms.Common.EkEnumeration.AutoAliasType = 2

• Taxonomy

  public Const Taxonomy As Ektron.Cms.Common.EkEnumeration.AutoAliasType = 1

UrlAliasAutoData

Namespace

Ektron.Cms.Common

Properties

• AliasName. Gets or sets the alias name for the URL.

  public string AliasName { set; get; }

• AutoAliasType. Gets or sets the automatic alias source type. Types are Taxonomy and Folder.

  public EkEnumeration.AutoAliasType AutoAliasType { set; get; }

• AutoId. Gets the unique ID generated for this record.

  public long AutoId { set; get; }

• ContentId

  public long ContentId { set; get; }

• Example. Gets or sets a sample of the selected configuration.

  public string Example { set; get; }

• ExcludedPath. Returns the folder or taxonomy path excluded from the selected path.

  public string ExcludedPath { set; get; }

• FileExtension. Gets or sets the selected file extension.

  public string FileExtension { set; get; }

• FormattedSelectionPath. Returns the folder or taxonomy path with modifications.

  public string FormattedSelectedPath { 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 override long Id { set; get; }

• IsEnabled. Gets or sets whether the configuration is active or not.

  public bool IsEnabled { set; get; }

• LanguageId. Gets the language ID for the automatic alias.

  public int LanguageId { set; get; }

• PageNameType. Gets or sets the name for the configuration. Available types are:
  • ContentTitle
  • ContentId
  • ContentIdAndLanguage

  public EkEnumeration.AutoAliasNameType PageNameType { set; get; }

• ReplacementCharacter. Gets or sets the character that will replace special characters in the generated URL.

  public string ReplacementCharacter { set; get; }

• SelectedPath. Returns the folder or taxonomy path selected by the user.

  public string SelectedPath { set; get; }

• SiteId. Gets or sets the root folder ID of the site. If no site is specified, returns zero (0).

  public long SiteId { set; get; }

• SourceId. Gets or sets either the taxonomy ID or the folder ID depending on the auto alias type selected.

  public long SourceId { set; get; }

• SourceName. Gets the name of the taxonomy or folder selected depending on the auto alias type selected.

  public string SourceName { set; get; }

• SourceParmName

  public string SourceParmName { set; get; }

• Target. Gets or sets the destination for the alias.

  public string Target { set; get; }

• TimeStamp

  public System.DateTime TimeStamp { set; get; }

• UrlAliasAutoData()

  public UrlAliasAutoData()

• UrlAliasAutoData(long, EkEnumeration.AutoAliasType, long, string)

  public UrlAliasAutoData(long siteId,
    EkEnumeration.AutoAliasType autoAliasType,
    long sourceId, string fileExtension)

• UrlAliasAutoData(long, EkEnumeration.AutoAliasType, long, string, long, string, string, int, string, bool, string, EkEnumeration.AutoAliasNameType, string, string, string, System.DateTime, long, string, string)

  public UrlAliasAutoData(long siteId,
    EkEnumeration.AutoAliasType autoAliasType,
    long sourceId, string fileExtension, long autoId,
    string aliasName, string target, int languageId,
    string sourceName, bool isEnabled, string example,
    EkEnumeration.AutoAliasNameType pagenametype,
    string replacementCharacter, string hostName,
    string selectedPath, System.DateTime timeStamp,
    long contentId, string excludedPath, string sourceParmname)