CollectionManager

Add

Add(Ektron.Cms.ContentCollectionData)

Adds a content collection based on information in an ContentCollectionData object.

Authenticated users

• CMS Administrators
• Collection 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

• * Title
• * Folder ID
• Recursive
• Summary

Parameters

• contentCollectionData. The ContentCollectionData object to add.

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCollectionTitleLabel" AssociatedControlID="uxCollectionTitle" CssClass="span-3 last" runat="server" Text="* Title:" />
        <ektronUI:TextField  ID="uxCollectionTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxFolderIdLabel" AssociatedControlID="uxFolderId" CssClass="span-3 last" runat="server" Text="* Folder Id:" />
        <ektronUI:TextField ID="uxFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRecursiveLabel" AssociatedControlID="uxRecursive" CssClass="span-3 last" runat="server" Text="Recursive:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxRecursive" CssClass="span-6" runat="server"  ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxCollectionDescriptionLabel" AssociatedControlID="uxCollectionDescription" CssClass="span-3 last" runat="server" Text="Summary:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxCollectionDescription" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CollectionManager collectionManager = new CollectionManager();
            ContentCollectionData contentcollData = new ContentCollectionData()
                {
                    FolderId = long.Parse(uxFolderId.Text),
                    Title = uxCollectionTitle.Text ,
                    Description = uxCollectionDescription.Text,
                    Recursive = uxRecursive.Checked
                };

            collectionManager.Add(contentcollData);

            MessageUtilities.UpdateMessage(uxMessage, "Collection Added with Id " + contentcollData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

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

AddContent

AddContent(System.Int64,System.Int64)

Adds a content item to a collection.

Authenticated users

• CMS Administrators
• Collection 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

• * Collection ID
• * Content ID

Parameters

• collectionId. The ID of the content collection.
• contentId. The ID of the content.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCollectionIdLabel" AssociatedControlID="uxCollectionId" CssClass="span-3 last" runat="server" Text="* Collection Id:" />
        <ektronUI:TextField  ID="uxCollectionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0"  />    
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-3 last" runat="server" Text="* Content Id:" />
        <ektronUI:TextField ID="uxContentId" 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="Add Content"></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;
using Ektron.Cms.Framework.Content;
using Ektron.Cms;
using Ektron.Cms.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long collectionId = long.Parse(uxCollectionId.Text);
            long contentId = long.Parse(uxContentId.Text);

            CollectionManager collectionManager = new CollectionManager();
            ContentCollectionData collectionData = collectionManager.GetItem(collectionId);

            if (collectionData != null)
            {
                ContentManager contentManager = new ContentManager();
                ContentData cData = contentManager.GetItem(contentId, false);
                if (cData != null && cData.Id > 0)
                {
                    collectionManager.AddContent(collectionId, contentId);
                    MessageUtilities.UpdateMessage(uxMessage, "Content Added to collection", Message.DisplayModes.Success);
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Content Id.", Message.DisplayModes.Error);
                    return;
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Collection Id.", Message.DisplayModes.Error);
                return;
            }

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

Delete

Delete(System.Int64)

Deletes a content collection from the CMS.

Authenticated users

• CMS Administrators
• Collection 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. The ID of the content collection to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCollectionIdLabel" AssociatedControlID="uxCollectionId" CssClass="span-3 last" runat="server" Text="* Collection Id:" />
        <ektronUI:TextField  ID="uxCollectionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-3 last" runat="server" Text="* Content Id:" />
        <ektronUI:TextField ID="uxContentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
                <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                    Text="Status:" />
    </li>                            
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete Content"></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;
using Ektron.Cms.Organization;
using Ektron.Cms.Framework.Content;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {

            long collectionID = long.Parse(uxCollectionId.Text);

            CollectionManager collectionManager = new CollectionManager();
            ContentCollectionData collectionData = collectionManager.GetItem(collectionID);
            //Check Whether Entered  CollectionId is Valid or Not.
            if (collectionData != null)
            {
                collectionManager.Delete(collectionID);
                MessageUtilities.UpdateMessage(uxMessage, "Collection with Id " + uxCollectionId.Text + " deleted", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Collection does not exist.", Message.DisplayModes.Error);
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

DeleteContent

DeleteContent(System.Int64,System.Int64)

Deletes a content item from a collection.

Authenticated users

• CMS Administrators
• Collection 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

• * Collection ID
• * Content ID

Parameters

• collectionId. The ID of the content collection.
• contentId. The ID of the content.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCollectionIdLabel" AssociatedControlID="uxCollectionId" CssClass="span-3 last" runat="server" Text="* Collection Id:" />
        <ektronUI:TextField  ID="uxCollectionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-3 last" runat="server" Text="* Content Id:" />
        <ektronUI:TextField ID="uxContentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
                <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                    Text="Status:" />
    </li>                            
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete Content"></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;
using Ektron.Cms.Organization;
using Ektron.Cms.Framework.Content;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {

            long collectionId = long.Parse(uxCollectionId.Text);
            long contentId = long.Parse(uxContentId.Text);

            CollectionManager collectionManager = new CollectionManager();
            ContentCollectionData collectionData = collectionManager.GetItem(collectionId);
            //Check Whether Entered  CollectionId is Valid or Not.
            if (collectionData != null)
            {
                ContentManager contentManager = new ContentManager();
                ContentData cData = new ContentData();
                cData = contentManager.GetItem(contentId, false);
                //Check Whether Entered  ContentId is Valid or Not.
                if (cData != null)
                {
                    collectionManager.DeleteContent(collectionId, contentId);
                    MessageUtilities.UpdateMessage(uxMessage, "Content Id deleted from collection", Message.DisplayModes.Success);
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid ContentID.", Message.DisplayModes.Error);
                    return;
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Collection does not exist.", Message.DisplayModes.Error);
                return;
            }


            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetItem

GetItem(Ektron.Cms.ContentCollectionData)

Retrieves the properties of a specific ContentCollectionData object.

Authenticated users

• CMS Administrators
• Collection 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. The ID of the content collection to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCollectionIdLabel" AssociatedControlID="uxCollectionId" CssClass="span-4 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxCollectionId" 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-4" 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="uxTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFolderId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxRecursive" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTemplate" 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.Framework.Organization;
using Ektron.Cms.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long collectionID = long.Parse(uxCollectionId.Text);

            CollectionManager collectionManager = new CollectionManager();
            ContentCollectionData collectionData = collectionManager.GetItem(collectionID);

            if (collectionData != null)
            {
                
                MessageUtilities.UpdateMessage(uxMessage, "Details for Collection with ID " + collectionData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxTitle.Text = "Title : " + collectionData.Title;
                uxTemplate.Text = "Template : " + collectionData.Template;
                uxFolderId.Text = "Folder ID : " + collectionData.FolderId;
                uxRecursive.Text = "Recursive : " + collectionData.Recursive;
                uxDescription.Text = "Description :" + collectionData.Description;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Collection 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(Ektron.Cms.CollectionCriteria)

Retrieves lists of objects.

Authenticated users

• CMS Administrators
• Collection 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

• Content Collection Property
• * Object Value

Parameters

• criteria. CollectionCriteria used to retrieve content collections.

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="uxContentCollectionPropertyLabel" AssociatedControlID="uxContentCollectionProperty" CssClass="span-5 last" runat="server" Text="ContentCollectionProperty:" />
        <asp:DropDownList ID="uxContentCollectionProperty" runat="server">
            <asp:ListItem>Collection Id</asp:ListItem>
            <asp:ListItem>Collection Name</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-5 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-5" runat="server" ValidationGroup="RegisterValidationGroup" Text="7" />
    </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="uxCollectionlistView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
        <LayoutTemplate>
            <table class="devsite-api-method">
                <thead>
                    <tr>
                        <th>
                            Title
                        </th>
                        <th>
                            Folder Id
                        </th>
                        <th>
                            Last Edit Date
                        </th>
                    </tr>
                </thead>
                <tbody>
                    <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
                </tbody>
            </table>
        </LayoutTemplate>
        <ItemTemplate>
            <tr>
                <td class="devsite-method">
                    <%# Eval("Title")%>
                </td>
                <td class="devsite-method">
                    <%# Eval("FolderId")%>
                </td>
                <td class="devsite-method">
                    <%# Eval("LastEditDate")%>
                </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.Organization;
using Ektron.Cms.Organization;

.aspx.cs code-behind method

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

            CollectionCriteria criteria = new CollectionCriteria();
            if (uxContentCollectionProperty.SelectedItem.Text == "Collection Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(ContentCollectionProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(ContentCollectionProperty.Title, CriteriaFilterOperator.Contains, Objectvalue);
            }

            CollectionManager collectionManager = new CollectionManager();
            List<ContentCollectionData> collectionList = collectionManager.GetList(criteria);

            uxCollectionlistView.Visible = true;
            uxCollectionlistView.DataSource = collectionList;
            uxCollectionlistView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Update

Update(Ektron.Cms.ContentCollectionData)

Updates an existing Content Collection item in the CMS.

Authenticated users

• CMS Administrators
• Collection 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
• Title
• * Recursive
• Summary

Parameters

• contentCollectionData. The ContentCollectionData object to update.

Returns

Returns the custom CmsData object update.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="Label1" AssociatedControlID="uxCollectionId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxCollectionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCollectionTitleLabel" AssociatedControlID="uxCollectionTitle" CssClass="span-3 last" runat="server" Text="Title:" />
        <ektronUI:TextField  ID="uxCollectionTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRecursiveLabel" AssociatedControlID="uxRecursive" CssClass="span-3 last" runat="server" Text="* Recursive:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxRecursive" CssClass="span-6" runat="server"  ValidationGroup="RegisterValidationGroup" />
    </li>
           
        <li class="clearfix">
        <ektronUI:Label ID="uxCollectionDescriptionLabel" AssociatedControlID="uxCollectionDescription" CssClass="span-3 last" runat="server" Text="Summary:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxCollectionDescription" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long collectionId = long.Parse(uxCollectionId.Text);

            CollectionManager collectionManager = new CollectionManager();
            ContentCollectionData contentcollData = collectionManager.GetItem(collectionId);


            if (contentcollData != null)
            {
                contentcollData.Title = uxCollectionTitle.Text != string.Empty ? uxCollectionTitle.Text : contentcollData.Title;
                contentcollData.Recursive = uxRecursive.Checked;
                contentcollData.Description = uxCollectionDescription.Text != string.Empty ? uxCollectionDescription.Text : contentcollData.Description;
                collectionManager.Update(contentcollData);
                
                MessageUtilities.UpdateMessage(uxMessage, "Collection with Id " + contentcollData.Id + " updated.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Collection does not exist", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

UpdateItemOrder

UpdateItemOrder(System.Int64,System.Collections.Generic.IEnumerable)

Updates the contents of a collection.

Authenticated users

• CMS Administrators
• Collection 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

• * Collection ID
• * Content ID List (comma separated collection's content IDs)

Parameters

• collectionId. The ID of the content collection.
• contentIdlist. The IDs of the contents.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCollectionIdLabel" AssociatedControlID="uxCollectionId" CssClass="span-3 last" runat="server" Text="* Collection Id:" />
        <ektronUI:TextField  ID="uxCollectionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIdListLabel" AssociatedControlID="uxContentIdList" CssClass="span-3 last" runat="server" Text="* Content Id List: (Comma Separated collection's content Ids)" />
        <ektronUI:TextField  ID="uxContentIdList" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix" style="color: red;">
                <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                    Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update Item Order"></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;
using Ektron.Cms.Organization;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long collectionId = long.Parse(uxCollectionId.Text);
            long contentId;

            CollectionManager collectionManager = new CollectionManager();
            ContentCollectionData collectionData = collectionManager.GetItem(collectionId);

            //Check Whether Entered  CollectionId is Valid or Not.
            if (collectionData != null)
            {
                List<long> contentIdList = new List<long>();

                foreach (string strId in uxContentIdList.Text.Split(new char[] { ',' }))
                {
                    contentId = Convert.ToInt64(strId);

                    ContentManager contentManager = new ContentManager();
                    ContentData cData = new ContentData();
                    cData = contentManager.GetItem(contentId, false);
                    //Check Whether Entered  ContentId is Valid or Not.
                    if (cData != null)
                    {
                        contentIdList.Add(contentId);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid ContentID.", Message.DisplayModes.Error);
                        return;
                    }
                }
                collectionManager.UpdateItemOrder(collectionId, contentIdList);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Collection does not exist.", Message.DisplayModes.Error);
                return;
            }

            MessageUtilities.UpdateMessage(uxMessage, "Item Order Updated", Message.DisplayModes.Success);

            uxPageMultiView.SetActiveView(uxViewMessage);

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

CollectionCriteria

Namespace

Ektron.Cms

Properties

• CollectionCriteria()

  public CollectionCriteria()

• CollectionCriteria(Ektron.Cms.Common.CollectionProperty, EkEnumeration.OrderByDirection)

  public CollectionCriteria(Ektron.Cms.Common.CollectionProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the CollectionProperty are:

  • DateCreated
  • Description
  • FolderId
  • HasBeenPublished
  • Id
  • IsApprovalRequired
  • IsPublished
  • LastEditDate
  • Status
  • Template
  • Title
  • UserId

ContentCollectionData

Namespace

Ektron.Cms.Organization

Properties

• DateCreated. Gets or sets the date thiscCollection was created.

  public System.DateTime DateCreated { set; get; }

• Description. Gets or sets the collection's description.

  public string Description { set; get; }

• DynamicReplicationMethod. Gets or sets a value representing the dynamic replication method to utilize.

  public bool DynamicReplicationMethod { set; get; }

• EditorFName. Gets ot sets the Editor's First Name.

  public string EditorFName { set; get; }

• EditorLName. Gets or sets the Editor's Last Name.

  public string EditorLName { set; get; }

• EnableReplication. Gets or sets a value indicating whether replication is enabled on this item (1=Enabled, 0=Disabled).

  public int EnableReplication { set; get; }

• FolderId. Path Folder Id.

  public long FolderId { set; get; }

• Id. Gets or sets the ID that identified this object uniquely.

  public long Id { set; get; }

• IsApprovalRequired. Gets or sets a true or false value indicating whether approval is required for this Collection.

  public bool IsApprovalRequired { set; get; }

• LastEditDate. Gets or sets the last Edit Date.

  public System.DateTime LastEditDate { set; get; }

• Published. Gets or sets a integer value that indicates whether the Collection is published or not (1=Published, 0=Not Published).

  public bool Published { set; get; }

• Recursive. Gets or sets a true or false value indicating whether to include subfolders.

  public bool Recursive { set; get; }

• Status. Content Status:
  • A-Approved
  • D-Pending deletion
  • I-Checked in
  • M-Marked for deletion
  • O-Checked out
  • P-Pending go live date
  • S-Submitted for approval
  • T-Awaiting completion of associated tasks

  public string Status { set; get; }

• Template. Gets or sets a template URL for the items in the collection, leave blank to use the item's quicklinks.

  public string Template { set; get; }

• Title. Gets or sets the collection's title.

  public string Title { set; get; }

• UserId. Gets or sets the user id that represents the author of this collection.

  public long UserId { set; get; }

• Validate(). Validate this collection. Returns true for valid data, false for invalid data.

  public override ValidationResults Validate()