MetadataTypeManager

Add

Add(Ektron.Cms.ContentMetaData)

Adds a new metadata type.

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

• Title
• Editable
• Search Allowed
• Default Text
• Seperator

Parameters

• metadata. The ContentMetaData object.

Returns

Returns the custom ContentMetaData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTitleLabel" AssociatedControlID="uxMetaTitle" CssClass="span-3 last" runat="server" Text="Title:" />
        <ektronUI:TextField ID="uxMetaTitle" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEditableLabel" AssociatedControlID="uxMetaEditable" CssClass="span-3 last" runat="server" Text="Editable :" />
        <ektronUI:Button DisplayMode="Checkbox" ID="uxMetaEditable" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSearchLabel" AssociatedControlID="uxSearchAllowed" CssClass="span-3 last" runat="server" Text="Search Allowed :" />
        <ektronUI:Button DisplayMode="Checkbox" ID="uxSearchAllowed" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDefaultTextLabel" AssociatedControlID="uxDefault" CssClass="span-3 last" runat="server" Text="Default Text :" />
        <ektronUI:TextField ID="uxDefault" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxSeperatorLabel" AssociatedControlID="uxSeperator" CssClass="span-3 last" runat="server" Text="Seperator :" />
        <ektronUI:TextField ID="uxSeperator" CssClass="span-1" runat="server" ValidationGroup="RegisterValidationGroup" Text=";" />
    </li>
                        
    <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
</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.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            MetadataTypeManager metaTypeManager = new MetadataTypeManager();
            ContentMetaData cMetaTypeData = new ContentMetaData()
            {
                Name = uxMetaTitle.Text,
                DataType  = Ektron.Cms.Common.EkEnumeration.ContentMetadataDataType.Text,
                IsSearchAllowed = uxSearchAllowed.Checked,
                Separator =  uxSeperator.Text ,
                Type = Ektron.Cms.Common.EkEnumeration.ContentMetadataType.SearchableProperty,
                IsEditable = uxMetaEditable.Checked,
                DefaultValue = uxDefault.Text
            };

            
            metaTypeManager.Add(cMetaTypeData);

            MessageUtilities.UpdateMessage(uxMessage, "Metadata type Added with Id " + cMetaTypeData.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 metadata type 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

• * Metadata Type ID

Parameters

• metadataTypeId. The ID of the metadata type to be deleted.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxMetaTypeIdLabel" AssociatedControlID="uxMetaTypeId" CssClass="span-6 last" runat="server" Text="Metadata Type Id:" />
            <ektronUI:TextField ID="uxMetaTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
        </li>
                        
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
</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.Content;

.aspx.cs code-behind method

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

            MetadataTypeManager metaTypeManager = new MetadataTypeManager();
            metaTypeManager.Delete(metaTypeID);

            MessageUtilities.UpdateMessage(uxMessage,  "Metadata Type with Id " + uxMetaTypeId.Text + " deleted", Message.DisplayModes.Success);
   
            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetItem

GetItem(Ektron.Cms.ContentData)

Retrieves the properties of a specific MetadataType 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

• * Metadata Type ID

Parameters

• metadataTypeId. The ID of the metadata type to get.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMetaTypeIdLabel" AssociatedControlID="uxMetaTypeId" CssClass="span-6 last" runat="server" Text="Metadate Type Id :" />
        <ektronUI:TextField ID="uxMetaTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
                   
    <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxTypeName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSearchable" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSeperator" 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.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long metaDataTypeID = long.Parse(uxMetaTypeId.Text);   

            MetadataTypeManager metadataTypeManager = new MetadataTypeManager();
            ContentMetaData metaData = metadataTypeManager.GetItem(metaDataTypeID);

            if (metaData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Metadata type with ID " + metaData.Id.ToString() + " are below", Message.DisplayModes.Success);   
                uxTypeName.Text = "Type Name : " + metaData.Name;
                uxSeperator.Text = "Separator : " + metaData.Separator;
                uxSearchable.Text = "Searchable : " + metaData.IsSearchAllowed;
                uxDefault.Text = "Default Text : " + metaData.DefaultValue;
            }
            else
            {
                uxMessage.Text = "Metadata type does not exist. ";
                MessageUtilities.UpdateMessage(uxMessage, "Activity", Message.DisplayModes.Error);
   
            }

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

GetList

GetList(Ektron.Cms.Content.MetadataTypeCriteria)

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

• * Metadata Type Property
• * Object Value

Parameters

• criteria. MetadataTypeCriteria used to retrieve content.

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="uxMetadataTypePropertyLabel" AssociatedControlID="uxMetadataTypeProperty" CssClass="span-4 last" runat="server" Text="* MetadataTypeProperty:" />
        <asp:DropDownList ID="uxMetadataTypeProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</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="uxContentMetaDataListView" 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 Name
                    </th>
                    <th>
                        Language
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("TypeId")%>
            </td>
                <td class="devsite-method">
                <%# Eval("TypeName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Language")%>
            </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.Content;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;
            MetadataTypeManager metadataTypeManager = new MetadataTypeManager();

            MetadataTypeCriteria criteria = new MetadataTypeCriteria();
            if (uxMetadataTypeProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(MetadataTypeProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(MetadataTypeProperty.Name, CriteriaFilterOperator.Contains, Objectvalue);
            }

            List<ContentMetaData> contentMetaDataList = metadataTypeManager.GetList(criteria);

            uxContentMetaDataListView.Visible = true;
            uxContentMetaDataListView.DataSource = contentMetaDataList;
            uxContentMetaDataListView.DataBind();

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

Update

Update(Ektron.Cms.ContentMetaData)

Updates an existing content metadata 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

• * Metadata Type ID
• Title
• * Editable
• * Search Allowed
• Default Text
• Separator

Parameters

• metadata. The ContentMetaData object.

Returns

Returns the custom ContentMetaData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMetaTypeIDLabel" AssociatedControlID="uxMetaTypeID" CssClass="span-5 last" runat="server" Text="* Metadata Type ID :" />
        <ektronUI:TextField ID="uxMetaTypeID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTitleLabel" AssociatedControlID="uxMetaTitle" CssClass="span-5 last" runat="server" Text="Title :" />
        <ektronUI:TextField ID="uxMetaTitle" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEditableLabel" AssociatedControlID="uxMetaEditable" CssClass="span-5 last" runat="server" Text="* Editable :" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxMetaEditable" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSearchLabel" AssociatedControlID="uxSearchAllowed" CssClass="span-5 last" runat="server" Text="* Search Allowed :" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxSearchAllowed" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDefaultTextLabel" AssociatedControlID="uxDefault" CssClass="span-5 last" runat="server" Text="Default Text :" />
        <ektronUI:TextField ID="uxDefault" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSeperatorLabel" AssociatedControlID="uxSeperator" CssClass="span-5 last" runat="server" Text="Seperator :" />
        <ektronUI:TextField ID="uxSeperator" CssClass="span-1" 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-5" 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.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long metaDataTypeID = long.Parse(uxMetaTypeID.Text);
            MetadataTypeManager metaTypeManager = new MetadataTypeManager();

            ContentMetaData cMetaTypeData = metaTypeManager.GetItem(metaDataTypeID);

            if (cMetaTypeData != null)
            {
                cMetaTypeData.Name = (uxMetaTitle.Text != string.Empty ? uxMetaTitle.Text :cMetaTypeData.Name) ;
                cMetaTypeData.IsSearchAllowed = uxSearchAllowed.Checked;
                cMetaTypeData.Separator = (uxSeperator.Text != string.Empty ? uxSeperator.Text : cMetaTypeData.Separator);
                cMetaTypeData.IsEditable = uxMetaEditable.Checked;
                cMetaTypeData.DefaultValue = (uxDefault.Text != string.Empty ? uxDefault.Text : cMetaTypeData.DefaultValue);

                metaTypeManager.Update(cMetaTypeData);

                MessageUtilities.UpdateMessage(uxMessage,  "Metadata type with Id " + cMetaTypeData.Id + " updated", Message.DisplayModes.Success);
   
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Metadata type does not exist.", Message.DisplayModes.Error);
   
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

ContentMetaData

Namespace

Ektron.Cms

Properties

• AllowMulti

  public bool AllowMulti { set; get; }

• AllowMultiple

  public bool AllowMultiple { set; get; }

• BlogMetaType

  public int BlogMetaType { set; get; }

• CaseSensitive

  public bool CaseSensitive { set; get; }

• DataType. Gets or sets the DataType used by this metadata definition.

  public EkEnumeration.ContentMetadataDataType DataType { set; get; }

• DefaultText

  public string DefaultText { set; get; }

• DefaultValue. Gets or sets the default value for this metadata definition.

  public string DefaultValue { set; get; }

• Editable

  public bool Editable { set; get; }

• IsDisplayable. Gets or sets the Displayable flag.

  public bool IsDisplayable { set; get; }

• IsEditable. Gets or sets the Editable flag.

  public bool IsEditable { set; get; }

• IsMetadataBlog

  public bool IsMetadataBlog { get; }

• IsSearchAllowed. Gets or sets the SearchAllowed flag.

  public bool IsSearchAllowed { set; get; }

• IsSelectableOnly

  public bool IsSelectableOnly { set; get; }

• Language

  public int Language { set; get; }

• MetaDataObjectType. Type of object to which this metadata applies.

  public EkEnumeration.MetaDataType MetaDataObjectType { set; get; }

• MetaDisplay

  public bool MetaDisplay { set; get; }

• MetaDisplayEE

  public bool MetaDisplayEE { set; get; }

• Name

  public string Name { set; get; }

• ObjectType

  public int ObjectType { set; get; }

• RemoveDuplicate

  public bool RemoveDuplicate { set; get; }

• Required

  public bool Required { set; get; }

• SearchAllowed

  public bool SearchAllowed { set; get; }

• SelectableText

  public string SelectableText { set; get; }

• Separater

  public string Separater { set; get; }

• Separator

  public string Separator { set; get; }

• TagType. Tag Type:
  • 0=EkConstants.MetaTagType_Html
  • 1=EkConstants.MetaTagType_Meta
  • 2=EkConstants.MetaTagType_Collection
  • 3=EkConstants.MetaTagType_ListSummary
  • 4=EkContansts.MetaTagType_Content
  • 5=EkConstants.MetaTagType_Image
  • 6=EkConstants.MetaTagType_HyperLink
  • 7=EkConstants.MetaTagType_File
  • 8=EkConstants.MetaTagType_Menu
  • 9=EkConstants.MetaTagType_User
  • 100=EkConstants.MetaTagType_Searchable

  public int TagType { set; get; }

• Text

  public string Text { set; get; }

• Title

  public string Title { set; get; }

• Type. The type of the metadata definition

  public EkEnumeration.ContentMetadataType Type { set; get; }

• TypeId

  public long TypeId { set; get; }

• TypeName

  public string TypeName { set; get; }

• Validate(). Validate this instance.

  public override ValidationResults Validate()

MetadataTypeCriteria

Namespace

Ektron.Cms.Content

Properties

• MetadataTypeCriteria()

  public MetadataTypeCriteria()

• MetadataTypeCriteria(Ektron.Cms.Content.MetadataTypeProperty, EkEnumeration.OrderByDirection)

  public MetadataTypeCriteria(Ektron.Cms.Content.MetadataTypeProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the MetadataTypeProperty are:

  • Id
  • Language
  • Name
  • ObjectType
  • Required