TaxonomyManager

The TaxonomyManager class manages taxonomies. For information about taxonomies, see Organizing Content with Taxonomies in the Ektron Reference.

Namespace

Ektron.Cms.Framework.Organization.TaxonomyManager

Constructors

  • TaxonomyManager()
  • TaxonomyManager(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.
  • TaxonomyService. Taxonomy Service
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

  • GetList(TaxonomyCustomPropertyCriteria). Returns a list of all taxonomies based upon custom property criteria supplied.
  • GetTree(Int64,Int32,Boolean,PagingInfo,TaxonomyType,TaxonomyItemsSortOrder). Returns a taxonomy tree based on taxonomy ID.
  • GetTree(String,Int32,Boolean,PagingInfo,TaxonomyType,TaxonomyItemsSortOrder). Returns a taxonomy tree based on taxonomy path.
  • ImportTaxonomy(String,String). Creates a taxonomy using XML file.
  • MoveTaxonomy(Int64,Int64). Moves the taxonomy with items from one to another at any level.
  • Reorder(Int64,Int32,Boolean). Reorders the taxonomy category based on taxonomy ID.

Add

Add(Ektron.Cms.TaxonomyData)

Adds a taxonomy from TaxonomyData object.

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Name
  • * Parent ID
  • Taxonomy Type
  • Description

Parameters

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyNameLabel" AssociatedControlID="uxTaxonomyName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField ID="uxTaxonomyName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxParentIdLabel" AssociatedControlID="uxParentId" CssClass="span-3 last" runat="server" Text="* Parent Id:" />
        <ektronUI:TextField ID="uxParentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyTypeLabel" AssociatedControlID="uxTaxonomyType" CssClass="span-3 last" runat="server" Text=" Taxonomy Type:" />
        <asp:DropDownList ID="uxTaxonomyType" runat="server">
            <asp:ListItem Value="0">Content</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-3 last" runat="server" Text="Description:" />
        <asp:TextBox TextMode="MultiLine" ID="uxDescription" CssClass="span-6" 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;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = new TaxonomyData()
            {
                Name = uxTaxonomyName.Text,
                ParentId = long.Parse(uxParentId.Text),
                Description = uxDescription.Text,
                Visible = true,
                TaxonomyType = (Ektron.Cms.Common.EkEnumeration.TaxonomyType)(Convert.ToInt32(uxTaxonomyType.Text)), 
            };

            taxonomyData.TaxonomyConfigurations.Add(Ektron.Cms.Common.EkEnumeration.TaxonomyConfiguration.Content);
            taxonomyManager.Add(taxonomyData);

            MessageUtilities.UpdateMessage(uxMessage, "Taxonomy Added with Id  " + taxonomyData.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 a taxonomy from the CMS.

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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

  • taxonomyId

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIdLabel" AssociatedControlID="uxTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaxonomyId" 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-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.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long taxonomyID = long.Parse(uxTaxonomyId.Text);
            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = taxonomyManager.GetItem(taxonomyID);
            if (taxonomyData != null)
            {
                taxonomyManager.Delete(taxonomyID);
                MessageUtilities.UpdateMessage(uxMessage, "Taxonomy with Id " + taxonomyID.ToString() + " deleted", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Taxonomy with Id " + taxonomyID.ToString() + " is Invalid", Message.DisplayModes.Error);
            }
            
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem (taxonomy ID)

GetItem(System.Int64)

Retrieves a taxonomy node-based on taxonomy ID. To retrieve child items, use GetTree().

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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 taxonomy node to return.

Returns

TaxonomyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIdLabel" AssociatedControlID="uxTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxTaxonomyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLevel" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxVisible" 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;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

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

            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = taxonomyManager.GetItem(taxonomyId);
           // taxonomyData = taxonomyManager.GetItem(taxonomyId);

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

                uxName.Text = "Name : " + taxonomyData.Name;
                uxType.Text = "Taxonomy Type : " + taxonomyData.TaxonomyType;
                uxDescription.Text = "Description :" + taxonomyData.Description;
                uxLevel.Text = "Level :" + taxonomyData.Level;
                uxVisible.Text = "Visible :" + taxonomyData.Visible;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,"Taxonomy does not exists. ", Message.DisplayModes.Error);
            }

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

GetItem (taxonomy path)

GetItem(System.String)

Retrieves a taxonomy node-based on taxonomy path. To retrieve child items, use GetTree().

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Taxonomy Path

Parameters

  • path. Path of taxonomy node to return.

Returns

TaxonomyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyPathLabel" AssociatedControlID="uxTaxonomyPath" CssClass="span-3 last" runat="server" Text="* Taxonomy Path :" />
        <ektronUI:TextField ID="uxTaxonomyPath" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="\" />
    </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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLevel" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxVisible" 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;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = taxonomyManager.GetItem(uxTaxonomyPath.Text);

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

                uxName.Text = "Name : " + taxonomyData.Name;
                uxType.Text = "Taxonomy Type : " + taxonomyData.TaxonomyType;
                uxDescription.Text = "Description :" + taxonomyData.Description;
                uxLevel.Text = "Level :" + taxonomyData.Level;
                uxVisible.Text = "Visible :" + taxonomyData.Visible;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Taxonomy 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.Organization.TaxonomyCriteria)

Retrieves lists of objects.

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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

Fields

*=Required

  • Taxonomy Property
  • * Object Value

Parameters

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="uxTaxonomyPropertyLabel" AssociatedControlID="uxTaxonomyProperty" CssClass="span-5 last" runat="server" Text="Taxonomy Property:" />
        <asp:DropDownList ID="uxTaxonomyProperty" runat="server">
            <asp:ListItem>Taxonomy Id</asp:ListItem>
            <asp:ListItem>Taxonomy Name</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-5 last" runat="server" Text="* Object Value:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="189" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxTaxonomylistView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Taxonomy Name
                    </th>
                    <th>
                        Taxonomy Path
                    </th>
                    <th>
                        Taxonomy Level
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("TaxonomyName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TaxonomyPath")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TaxonomyLevel")%>
            </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;
using Ektron.Cms.Common;
using Ektron.Cms.Organization;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

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

            TaxonomyCriteria criteria = new TaxonomyCriteria();
            if (uxTaxonomyProperty.SelectedItem.Text == "Taxonomy Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter( TaxonomyProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxonomyProperty.Name, CriteriaFilterOperator.Contains, Objectvalue);
            }

            TaxonomyManager taxonomyManager = new TaxonomyManager();
            List<TaxonomyData> taxonomyItemList = taxonomyManager.GetList(criteria);

            uxTaxonomylistView.Visible = true;
            uxTaxonomylistView.DataSource = taxonomyItemList;
            uxTaxonomylistView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetTaxonomyConfigurationList

GetTaxonomyConfigurationList(System.Int64)

Retrieves a list of taxonomy configurations for a taxonomy. Taxonomy configurations determine the type of CMS objects that you can assign to a taxonomy.

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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

  • taxonomyId. ID of taxonomy to retrieve configurations for.

Returns

List of taxonomy configuration enumerations.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIdLabel" AssociatedControlID="uxTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxTaxonomyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </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="GetConfigurationList"></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>         
</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;
using Ektron.Cms.Framework.Organization;
using Ektron.Cms.Common;

.aspx.cs code-behind method

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

            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = taxonomyManager.GetItem(taxonomyId);

            if (taxonomyData != null)
            {
                List<EkEnumeration.TaxonomyConfiguration> list = taxonomyManager.GetTaxonomyConfigurationList(taxonomyId);

                if (list != null)
                {
                    MessageUtilities.UpdateMessage(uxMessage,  "Taxonomy Configuration for taxonomy ID " + taxonomyId + " is " + list[0].ToString() + " .", Message.DisplayModes.Success);
                }             

            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid TaxonomyId.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }
}

Update

Update(Ektron.Cms.TaxonomyData)

Update is used to update an existing TaxonomyData object in the CMS.

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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
  • Name
  • Parent ID
  • * Taxonomy Type
  • Description

Parameters

  • taxonomyData

Returns

Returns the custom CmsData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIdLabel" AssociatedControlID="uxTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaxonomyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyNameLabel" AssociatedControlID="uxTaxonomyName" CssClass="span-3 last" runat="server" Text=" Name:" />
        <ektronUI:TextField ID="uxTaxonomyName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxParentIdLabel" AssociatedControlID="uxParentId" CssClass="span-3 last" runat="server" Text=" Parent Id:" />
        <ektronUI:TextField ID="uxParentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyTypeLabel" AssociatedControlID="uxTaxonomyType" CssClass="span-3 last" runat="server" Text=" * Taxonomy Type:" />
        <asp:DropDownList ID="uxTaxonomyType" runat="server">
            <asp:ListItem Value="0">Content</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-3 last" runat="server" Text="Description:" />
        <asp:TextBox TextMode="MultiLine" ID="uxDescription" CssClass="span-6" 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;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long taxonomyId = long.Parse(uxTaxonomyId.Text);
            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = taxonomyManager.GetItem(taxonomyId);

            if (taxonomyData != null)
            {
                taxonomyData.Name = (uxTaxonomyName.Text != string.Empty ? uxTaxonomyName.Text : taxonomyData.Name);
                taxonomyData.TaxonomyType = (EkEnumeration.TaxonomyType )Convert.ToInt32(uxTaxonomyType.SelectedItem.Value);
                taxonomyData.ParentId = (uxParentId.Text != string.Empty ? long.Parse(uxParentId.Text) : taxonomyData.ParentId);
                taxonomyData.Description = (uxDescription.Text != string.Empty ?uxDescription.Text :taxonomyData.Description);

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

UpdateTaxonomyConfigurations

UpdateTaxonomyConfigurations(System.Int64,System.Collections.Generic.List)

Updates a configuration list for a taxonomy.

Authenticated users

  • CMS Administrators
  • Taxonomy Administrators
  • Users that have access permission

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
  • Taxonomy Configuration

Parameters

  • taxonomyId. Taxonomy ID that is updated.
  • configurationList. List of taxonomy configurations to apply for update.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIdLabel" AssociatedControlID="uxTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxTaxonomyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
        <li class="clearfix">
                <ektronUI:Label ID="uxTaxonomyConfigurationLabel" AssociatedControlID="uxTaxonomyConfiguration" CssClass="span-5 last" runat="server" Text="Taxonomy Configuration:" />
                <asp:DropDownList ID="uxTaxonomyConfiguration" runat="server">
                    <asp:ListItem>Content</asp:ListItem>
                    <asp:ListItem>User</asp:ListItem>
                    <asp:ListItem>Group</asp:ListItem>
                </asp:DropDownList>
            </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="UpdateConfigurationList"></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>         
</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;
using Ektron.Cms.Framework.Organization;
using Ektron.Cms.Common;

.aspx.cs code-behind method

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

            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = taxonomyManager.GetItem(taxonomyId);

            if (taxonomyData != null)
            {
                List<EkEnumeration.TaxonomyConfiguration> list = new List<EkEnumeration.TaxonomyConfiguration>();
                if (uxTaxonomyConfiguration.SelectedItem.ToString() == "Content")
                {
                    list.Add(EkEnumeration.TaxonomyConfiguration.Content);
                }
                else if (uxTaxonomyConfiguration.SelectedItem.ToString() == "User")
                {
                    list.Add(EkEnumeration.TaxonomyConfiguration.User);
                }
                else
                {
                    list.Add(EkEnumeration.TaxonomyConfiguration.Group);
                }
                taxonomyManager.UpdateTaxonomyConfigurations(taxonomyId, list);
                MessageUtilities.UpdateMessage(uxMessage, "Taxonomy Configuration for taxonomy ID " + taxonomyId + " has updated.", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid TaxonomyId.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }c

Data Classes

TaxonomyCriteria

Namespace

Ektron.Cms.Organization

Properties

  • ReturnRecursiveChildren. Gets or sets the ReturnRecursiveChildren flag. If true AND a ParentId filter is supplied, all recursive children taxonomies will be returned for the parent ID.
    public bool ReturnRecursiveChildren { set; get; }
  • TaxonomyCriteria()
    public TaxonomyCriteria()
  • TaxonomyCriteria(Ektron.Cms.Organization.TaxonomyProperty, EkEnumeration.OrderByDirection)
    public TaxonomyCriteria(Ektron.Cms.Organization.TaxonomyProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the TaxonomyProperty are:

    • DateCreated
    • HasChildren
    • Id
    • ItemCount
    • LanguageId
    • Level
    • Name
    • ParendId
    • Path
    • TaxonomyDisplayOrder
    • TemplateId
    • Type

TaxonomyData

Namespace

Ektron.Cms

Properties

  • FolderId
    public long FolderId { set; get; }
  • Taxonomy
    public Ektron.Cms.Controls.CmsWebService.TaxonomyData[]
  Taxonomy { set; get; }
  • TaxonomyConfigurations
    public Ektron.Cms.Controls.CmsWebService.TaxonomyConfiguration[]
  TaxonomyConfigurations { set; get; }
  • TaxonomyItems
    public Ektron.Cms.Controls.CmsWebService.TaxonomyItemData[]
  TaxonomyItems { set; get; }