TaxonomyCustomPropertyManager

The TaxonomyCustomPropertyManager class manages user-specified taxonomy properties.

Namespace

Ektron.Cms.Framework.Settings.TaxonomyCustomPropertyManager

Constructors

  • TaxonomyCustomPropertyManager()
  • TaxonomyCustomPropertyManager(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.CustomPropertyData)

Adds a taxonomy custom property.

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

  • * Name
  • * Type
  • Is Enabled
  • Is Editable

Parameters

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTypeLabel" AssociatedControlID="uxType" CssClass="span-3 last" runat="server" Text="* Type:" />
        <asp:DropDownList ID="uxType" runat="server">
            <asp:ListItem Value="0">String</asp:ListItem>
            <asp:ListItem Value="2">Numeric</asp:ListItem>
        </asp:DropDownList>
    </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-6" runat="server"  ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEditableLabel" AssociatedControlID="uxIsEditable" CssClass="span-3 last" runat="server" Text="Is Editable:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxIsEditable" 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.Common;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();

            CustomPropertyData customPropertyData = new CustomPropertyData()
            {
                PropertyName = uxName.Text,
                CmsObjectType = EkEnumeration.CustomPropertyObjectType.TaxonomyNode,
                LanguageId = taxonomyCustomPropertyManager.RequestInformation.ContentLanguage,
                PropertyDataType = (EkEnumeration.CustomPropertyItemDataType)Convert.ToInt32(uxType.SelectedItem.Value),
                PropertyStyleType = EkEnumeration.CustomPropertyStyleType.SingleSelect,
                IsEditable = uxIsEditable.Checked,
                IsEnabled = uxIsEnabled.Checked,
            };

            taxonomyCustomPropertyManager.Add(customPropertyData);

            MessageUtilities.UpdateMessage(uxMessage,  "Taxonomy custom property added with Id " + customPropertyData.PropertyId, 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 custom property 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
  • * Language ID

Parameters

  • propertyId. ID of the CustomPropertyData object to delete.
  • languageId. Language Id of the CustomProperty to delete.

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyCustomUserPropertyIdLabel" AssociatedControlID="uxTaxonomyCustomUserPropertyId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaxonomyCustomUserPropertyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageIdLabel" AssociatedControlID="uxLanguageId" CssClass="span-4 last" runat="server" Text="* Language Id:" />
        <ektronUI:TextField ID="uxLanguageId" 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.Common;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long taxonomyCustomUserPropertyId = long.Parse(uxTaxonomyCustomUserPropertyId.Text);
            int languageId = int.Parse(uxLanguageId.Text);

            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();
            CustomPropertyData customPropertyData = taxonomyCustomPropertyManager.GetItem(taxonomyCustomUserPropertyId, languageId);

            if (customPropertyData != null && customPropertyData.PropertyId > 0)
             {
                 taxonomyCustomPropertyManager.Delete(taxonomyCustomUserPropertyId, languageId);
                 MessageUtilities.UpdateMessage(uxMessage, "Taxonomy custom property deleted.", Message.DisplayModes.Success);
             }
             else
             {
                 MessageUtilities.UpdateMessage(uxMessage, "Taxonomy custom property 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.CustomPropertyData)

Retrieves the properties of a specific CustomPropertyData 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
  • * Language ID

Parameters

  • propertyId. ID of theCustomPropertyData object.
  • languageId. Language ID of the CustomPropertyData object to get.

Returns

CustomProperty details in a CustomPropertyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPropertyIdLabel" AssociatedControlID="uxPropertyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxPropertyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageIdLabel" AssociatedControlID="uxLanguageId" CssClass="span-3 last" runat="server" Text="* Language Id :" />
        <ektronUI:TextField ID="uxLanguageId" 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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayValueType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsEditable" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsEnabled" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLanguageIdVal" 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;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long propertyId = long.Parse(uxPropertyId.Text);
            int languageId = int.Parse(uxLanguageId.Text);
            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();
            CustomPropertyData customPropertyData = taxonomyCustomPropertyManager.GetItem(propertyId, languageId);

            if (customPropertyData != null && customPropertyData.PropertyId > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for taxonomy custom property with ID " + customPropertyData.PropertyId.ToString() + " are below", Message.DisplayModes.Success);

                uxName.Text = "Name : " + customPropertyData.PropertyName;
                uxDisplayValueType.Text = "Property Data Type : " + customPropertyData.PropertyDataType;
                uxIsEditable.Text = "Is Editable : " + customPropertyData.IsEditable;
                uxIsEnabled.Text = "Is Enabled : " + customPropertyData.IsEnabled;
                uxLanguageIdVal.Text = "Language Id : " + customPropertyData.LanguageId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Taxonomy custom property does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList (paging info)

GetList(System.Int32,Ektron.Cms.PagingInfo)

Retrieves a list of CustomPropertyData objects with their details.

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

  • * Language ID

Parameters

  • languageId. Language ID of the CustomProperties to get.
  • paging. Paging details.

Returns

List of CustomPropertyData objects.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageIdLabel" AssociatedControlID="uxLanguageId" CssClass="span-3 last" runat="server" Text="* Language Id:" />
        <ektronUI:TextField ID="uxLanguageId" CssClass="span-3" 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-3" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxCustomPropertyDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Property Name
                    </th>
                    <th>
                        Language Id
                    </th>
                    <th>
                        Property Id
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("PropertyName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("LanguageId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("PropertyId")%>
            </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.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            int languageId = int.Parse(uxLanguageId.Text);
          
            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = 100;

            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();
            List<CustomPropertyData> customPropertyData = taxonomyCustomPropertyManager.GetList(languageId, pagingInfo);

            uxCustomPropertyDataListView.Visible = true;
            uxCustomPropertyDataListView.DataSource = customPropertyData;
            uxCustomPropertyDataListView.DataBind();

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

GetList (properties)

GetList(Ektron.Cms.Common.EkEnumeration.CustomPropertyObjectType,
System.Int32,Ektron.Cms.PagingInfo)

Retrieves a list of CustomPropertyData objects with their details.

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

  • * Custom Property
  • * Language ID
  • * Records Per Page

Parameters

  • cmsObjectType. Type of the CustomProperties to get.
  • languageId. Language ID of the CustomProperties to get.
  • paging. Paging details.

Returns

List of CustomPropertyData objects.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPropertyIdLabel" AssociatedControlID="uxPropertyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxPropertyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageIdLabel" AssociatedControlID="uxLanguageId" CssClass="span-3 last" runat="server" Text="* Language Id :" />
        <ektronUI:TextField ID="uxLanguageId" 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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayValueType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsEditable" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsEnabled" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLanguageIdVal" 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;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            EkEnumeration.CustomPropertyObjectType objectValue = EkEnumeration.CustomPropertyObjectType.TaxonomyNode;
            
            int languageId = int.Parse(uxLanguageId.Text);

            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = int.Parse(uxRecordsPerPage.Text);

            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();
            List<CustomPropertyData> customPropertyData = taxonomyCustomPropertyManager.GetList(objectValue, languageId, pagingInfo);

            uxCustomPropertyDataListView.Visible = true;
            uxCustomPropertyDataListView.DataSource = customPropertyData;
            uxCustomPropertyDataListView.DataBind();

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

GetListNonTranslated

GetListNonTranslated(System.Int64)

Retrieves a list of non-translated LanguageData 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

  • * Property ID

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPropertyIdLabel" AssociatedControlID="uxPropertyId" CssClass="span-3 last" runat="server" Text="* Property Id:" />
        <ektronUI:TextField ID="uxPropertyId" CssClass="span-3" 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-3" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxLanguageDataDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Name
                    </th>
                    <th>
                        SiteEnabled
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("SiteEnabled")%>
            </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.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            int propertyId = int.Parse(uxPropertyId.Text);

            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();
            List<LanguageData> languageData = taxonomyCustomPropertyManager.GetListNonTranslated(propertyId);

            uxLanguageDataDataListView.Visible = true;
            uxLanguageDataDataListView.DataSource = languageData;
            uxLanguageDataDataListView.DataBind();

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

GetListTranslated

GetListTranslated(System.Int64)

Retrieves a list of translated LanguageData 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

  • * Property ID

Parameters

Returns

List of LanguageData objects.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPropertyIdLabel" AssociatedControlID="uxPropertyId" CssClass="span-3 last" runat="server" Text="* Property Id:" />
        <ektronUI:TextField ID="uxPropertyId" CssClass="span-3" 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-3" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxLanguageDataDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Name
                    </th>
                    <th>
                        SiteEnabled
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("SiteEnabled")%>
            </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.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            int propertyId = int.Parse(uxPropertyId.Text);

            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();
            List<LanguageData> languageData = taxonomyCustomPropertyManager.GetListTranslated(propertyId);

            uxLanguageDataDataListView.Visible = true;
            uxLanguageDataDataListView.DataSource = languageData;
            uxLanguageDataDataListView.DataBind();

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

Update

Update(Ektron.Cms.Common.CustomPropertyData)

Updates an existing taxonomy CustomPropertyData object 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

  • * Property ID
  • * Language ID
  • Name
  • * Is Enabled
  • * Is Editable

Parameters

Returns

Returns the custom CmsData object updated.

Remarks

Validate the taxonomy custom property item with GetItem() before you update the properties. Then, call Update with your modified CustomPropertyData object.

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxPropertyIdLabel" AssociatedControlID="uxName" CssClass="span-3 last" runat="server" Text="* Property Id:" />
        <ektronUI:TextField  ID="uxPropertyId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageIdLabel" AssociatedControlID="uxLanguageId" CssClass="span-3 last" runat="server" Text="* LanguageId:" />
        <ektronUI:TextField  ID="uxLanguageId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-3 last" runat="server" Text=" Name:" />
        <ektronUI:TextField  ID="uxName" 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-6" runat="server"  ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEditableLabel" AssociatedControlID="uxIsEditable" CssClass="span-3 last" runat="server" Text="* Is Editable:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxIsEditable" 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.Common;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long propertyId = long.Parse(uxPropertyId.Text);
            int languageId = int.Parse(uxLanguageId.Text);

            TaxonomyCustomPropertyManager taxonomyCustomPropertyManager = new TaxonomyCustomPropertyManager();
            CustomPropertyData customPropertyData = taxonomyCustomPropertyManager.GetItem(propertyId, languageId);
            
            if (customPropertyData != null)
            {
                customPropertyData.PropertyName =  (uxName.Text != string.Empty ? uxName.Text : customPropertyData.PropertyName);
                customPropertyData.IsEditable = uxIsEditable.Checked;
                customPropertyData.IsEnabled = uxIsEnabled.Checked;

                taxonomyCustomPropertyManager.Update(customPropertyData);
                MessageUtilities.UpdateMessage(uxMessage, "Taxonomy custom property updated. ", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Taxonomy custom property 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

CustomPropertyData

Namespace

Ektron.Cms.Common

Properties

  • AddItem(object, bool)
    public void AddItem(object value, bool isDefault)
  • CmsObjectType
    public EkEnumeration.CustomPropertyObjectType
  CmsObjectType { set; get; }
  • CustomPropertyData()
    public CustomPropertyData()
  • CustomPropertyData(string, EkEnumeration.CustomPropertyItemDataType, EkEnumeration.CustomPropertyObjectType, int)
    public CustomPropertyData(string propertyName,
  EkEnumeration.CustomPropertyItemDataType propertyDataType, EkEnumeration.CustomPropertyObjectType cmsObjectType, int languageId)
  • IsEditable
    public bool IsEditable { set; get; }
  • IsEnabled
    public bool IsEnabled { set; get; }
  • Items
    public System.Collections.Generic.List<CustomPropertyItemData>
  Items { set; get; }
  • LanguageId
    public int LanguageId { set; get; }
  • PropertyDataType
    public EkEnumeration.CustomPropertyItemDataType
  PropertyDataType { set; get; }
  • PropertyId
    public long PropertyId { set; get; }
  • PropertyName
    public string PropertyName { set; get; }
  • PropertyStyleType
    public EkEnumeration.CustomPropertyStyleType
  PropertyStyleType { set; get; }