TagManager

The TagManager class manages tags. Tags are keywords that you can assign to content and library items, which allows for tag-based searching. For example, you can add the tag Electronics and tag content that is related to the electronic devices, so that people can search for the content using the Electronics tag. For information about how tagging is used in Ektron, see Tagging Content, Library Items, Users, and Groups with Keywords in the Ektron Reference.

Namespace

Ektron.Cms.Framework.Community.TagManager

Constructors

  • TagManager()
  • TagManager(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.
  • TagManagerService. Returns an instance of the business objects TagManager service.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.TagData)

Adds a tag based on information in a TagData object. The method populates the tag.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

  • * Tag Type
  • * Tag Text

Parameters

  • tagData. The TagData object to add.

Returns

Returns the custom TagData object added.

.aspx Code Snippxet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTagTypeLabel" AssociatedControlID="uxTagType" CssClass="span-4 last" runat="server" Text="* Tag Type:" />
        <asp:DropDownList ID="uxTagType" runat="server">
            <asp:ListItem>ContentDefault</asp:ListItem>
            <asp:ListItem>UserDefault</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTagTextLabel" AssociatedControlID="uxTagText" CssClass="span-4 last" runat="server" Text="* Tag Text:" />
        <ektronUI:TextField ID="uxTagText" 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-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;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            TagManager tagManager = new TagManager();
            TagData tagData = new TagData()
            {
                Type = uxTagType.Text == "ContentDefault" ? TagTypes.ContentDefault : TagTypes.UserDefault ,
                Text = uxTagText.Text
            };

            tagManager.Add(tagData);

            MessageUtilities.UpdateMessage(uxMessage, "Tag added with Id " + tagData.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 tag 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. ID of the tag to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTagIdLabel" AssociatedControlID="uxTagId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTagId" 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.Community;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long tagId = long.Parse(uxTagId.Text);
            TagManager tagManager = new TagManager();
            TagData tagData = tagManager.GetItem(tagId);
            if (tagData != null)
            {
                tagManager.Delete(tagId);
                MessageUtilities.UpdateMessage(uxMessage, "Tag deleted.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Tag Id doesn't exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Retrieves the properties of a specific TagData 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. Tag's id to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTagIdLabel" AssociatedControlID="uxTagId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxTagId" 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="uxType" 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;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

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

            TagManager tagManager = new TagManager();
            TagData tagData = tagManager.GetItem(tagId);

            if (tagData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for tag with ID " + tagData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Text : " + tagData.Text ;
                uxType.Text = "Type : " + tagData.Type;
                uxLanguageId.Text = "Language Id : " + tagData.LanguageId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Tag does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Content.TagCriteria)

Retrieves lists of objects.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * Tag Data 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="uxTagDataPropertyLabel" AssociatedControlID="uxTagDataProperty" CssClass="span-4 last" runat="server" Text="* TagDataProperty:" />
        <asp:DropDownList ID="uxTagDataProperty" runat="server">
            <asp:ListItem>Type(0,1,2,4,8)</asp:ListItem>
            <asp:ListItem>Text</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 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-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
           
<asp:ListView ID="uxTagDataListListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        Type
                    </th>
                    <th>
                        Text
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Type")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Text")%>
            </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.Community;

.aspx.cs code-behind method

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

            Ektron.Cms.Community.TagCriteria criteria = new Ektron.Cms.Community.TagCriteria();
            if (uxTagDataProperty.SelectedItem.Text == "Type(0,1,2,4,8)")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(TagProperty.Type, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TagProperty.Text, CriteriaFilterOperator.Contains, Objectvalue);
            }

            TagManager tagManager = new TagManager();
            List<TagData> tagDataList = tagManager.GetList(criteria);

            uxTagDataListListView.Visible = true;
            uxTagDataListListView.DataSource = tagDataList;
            uxTagDataListListView.DataBind();

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

GetTagCloud

GetTagCloud(TagCloudRequestData.Int32)

Retrieves a tag cloud.

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 (default: 1033)
  • * Page Size (default: 50)
  • * Tag Type (default: TagTypes.All)
  • * Order By (default: TagOrderBy.Text)
  • * Order By Direction (default: EkEnumeration.OrderByDirection.Ascending)
  • * Object Type (default: EkEnumeration.CMSObjectTypes.User)

Parameters

  • request. Contains the parameters for the tag cloud to retrieve.
  • totalRecords. Returns the total number of tags available in the requested cloud.

Returns

A tag cloud object representing the request.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectTagDataPropertyLabel" AssociatedControlID="uxObjectTagDataProperty"
            CssClass="span-3 last" runat="server" Text="* Tag ObjectType:" />
        <asp:DropDownList ID="uxObjectTagDataProperty" runat="server">
            <asp:ListItem>Content</asp:ListItem>
            <asp:ListItem>Library</asp:ListItem>
            <asp:ListItem>User</asp:ListItem>
        </asp:DropDownList>
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageIdLabel" AssociatedControlID="uxTagLanguageId" CssClass="span-3 last"
            runat="server" Text="*Tag LanguageId :" />
        <ektronUI:TextField ID="uxTagLanguageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1033" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxTotalPagesLabel" AssociatedControlID="uxTotalPages" CssClass="span-3 last"
            runat="server" Text="* TotalPages :" />
        <ektronUI:TextField ID="uxTotalPages" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="10" />
    </li>
    <div class="ektronTopSpace"></div>
    <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">
    <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
</li>
<asp:ListView ID="uxObjectTagListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
<EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
    <table class="devsite-api-method">
        <thead>
            <tr>
                <th>
                    Id
                </th>
                <th>
                    Language Id
                </th>
                <th>
                    Text
                </th>
                    <th>
                    TotalUsedCount
                </th>
            </tr>
        </thead>
        <tbody>
            <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
        </tbody>
    </table>
</LayoutTemplate>
<ItemTemplate>
    <tr>
        <td class="devsite-method">
            <%# Eval("Id")%>
        </td>
        <td class="devsite-method">
            <%# Eval("LanguageId")%>
        </td>
        <td class="devsite-method">
            <%# Eval("Text")%>
        </td>
        <td class="devsite-method">
            <%# Eval("TotalUsedCount")%>
        </td>
    </tr>
</ItemTemplate>
</asp:ListView>
</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.Community;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Community;
using System.Collections.ObjectModel;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TagManager tagManager = new TagManager();
            int totalPages = int.Parse(uxTotalPages.Text);

            TagCloudRequestData tagCloudRequestData = new TagCloudRequestData();
            tagCloudRequestData.TagTypes = TagTypes.All;
            tagCloudRequestData.PageSize = 50;

            if (uxObjectTagDataProperty.SelectedItem.Text == "Content")
                tagCloudRequestData.ObjectType = Ektron.Cms.Common.EkEnumeration.CMSObjectTypes.Content;
            else if (uxObjectTagDataProperty.SelectedItem.Text == "Library")
                tagCloudRequestData.ObjectType = Ektron.Cms.Common.EkEnumeration.CMSObjectTypes.Library;
            else
                tagCloudRequestData.ObjectType = Ektron.Cms.Common.EkEnumeration.CMSObjectTypes.User;

            tagCloudRequestData.LanguageId = int.Parse(uxTagLanguageId.Text);
           
            TagCloud tagCloud = tagManager.GetTagCloud(tagCloudRequestData, out totalPages);
            Collection<TagCloudItem> tags = tagCloud.Tags;
            List<TagData> tagList = new List<TagData>();
            foreach (TagCloudItem tagItem in tags)
            {
                TagData tag = tagItem.Tag;
                if (tag != null)
                {
                    tagList.Add(tag);
                }
            }

            uxObjectTagListView.Visible = true;
            uxObjectTagListView.DataSource = tagList;
            uxObjectTagListView.DataBind();

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

Tag

Tag(System.String,System.Int64,Ektron.Cms.Common.EkEnumeration.CMSObjectTypes)

Tags content with supplied 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

  • * Tag
  • * Object ID
  • * Tag Type

Parameters

  • tag. The string that contains the tag text.
  • objectId. The object ID to be tagged.
  • objectType. The object type to be tagged.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTagTextLabel" AssociatedControlID="uxTagText" CssClass="span-4 last" runat="server" Text="* Tag:" />
        <ektronUI:TextField ID="uxTagText" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"/>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectIdLabel" AssociatedControlID="uxObjectId" CssClass="span-4 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField ID="uxObjectId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"/>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTagTypeLabel" AssociatedControlID="uxTagType" CssClass="span-4 last" runat="server" Text="* Tag Type:" />
        <asp:DropDownList ID="uxTagType" runat="server">
            <asp:ListItem Value="0">Content</asp:ListItem>
            <asp:ListItem Value="1">Folder</asp:ListItem>
            <asp:ListItem Value="2">User</asp:ListItem>
            <asp:ListItem Value="3">UserGroup</asp:ListItem>
            <asp:ListItem Value="4">Library</asp:ListItem>
            <asp:ListItem Value="5">Collection</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></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;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long objectId = long.Parse(uxObjectId.Text);
            EkEnumeration.CMSObjectTypes cmsObjectTypes = (EkEnumeration.CMSObjectTypes)Convert.ToInt32(uxTagType.SelectedItem.Value);

            TagManager tagManager = new TagManager();
            tagManager.Tag(uxTagText.Text, objectId, cmsObjectTypes);

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

Update

Update(Ektron.Cms.TagData)

Updates an existing TagData item 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
  • * Tag Type

Parameters

  • tagData. The TagData object to update.

Returns

Returns the custom TagData object update

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTagIdLabel" AssociatedControlID="uxTagId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTagId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"/>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTagTypeLabel" AssociatedControlID="uxTagType" CssClass="span-4 last" runat="server" Text="* Tag Type:" />
        <asp:DropDownList ID="uxTagType" runat="server">
            <asp:ListItem>ContentDefault</asp:ListItem>
            <asp:ListItem>UserDefault</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

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

            TagManager tagManager = new TagManager();
            TagData tagData = tagManager.GetItem(tagId);

            if (tagData != null)
            {
                tagData.Type = uxTagType.Text == "ContentDefault" ? TagTypes.ContentDefault : TagTypes.UserDefault;

                tagManager.Update(tagData);

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

Data Classes

TagCriteria

Namespace

Ektron.Cms.Community

Constructors

  • TagCriteria()
    public TagCriteria()
  • TagCriteria(Ektron.Cms.Common.TagProperty, EkEnumeration.OrderByDirection)
    public TagCriteria(Ektron.Cms.Common.TagProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the TagProperty are:

    • Id
    • LanguageId
    • Text
    • Type

TagData

Namespace

Ektron.Cms

Properties

  • Id. ID of tag, which should be set only for existing tags. New tags will be given an ID when they are saved.
    public long Id { set; get; }
  • LanguageId. Language of the tag.
    public int LanguageId { set; get; }
  • TagData(). Constructor.
    public TagData()
  • TagData(string). Constructor.
    public TagData(string text)
  • TagData(string, int). Constructor.
    public TagData(string text, int languageId)
  • TagData(sting, int, long). Constructor.
    public TagData(string text, int languageId, long id)
  • Text. The tag's actual text.
    public string Text { set; get; }
  • TotalUsedCount. Returns the total number of times this tag has been used on an object.
    public int TotalUsedCount { set; get; }
  • Type. The type of tag.
    public Ektron.Cms.TagTypes Type { set; get; }
  • Validate()
    public override ValidationResults Validate()