ContentManager

Add

Add(Ektron.Cms.ContentData)

Adds content to the CMS.

Authenticated users

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

• * Folder ID
• * Title
• Keywords (separate with a semicolon (;))
• Summary
• Private
• * HTML

Parameters

• contentData. The ContentData object to add to the CMS.

Returns

Returns the custom ContentData object added.

Remarks

When you add the content, the method returns a new Content ID. When you add content using this method, Web alerts are not sent.

.aspx code snippet

<ol class="formFields">
    <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">
        <asp:Label ID="uxContentTitleLabel" AssociatedControlID="uxContentTitle" CssClass="span-3 last" runat="server" Text="* Title:" />
        <ektronUI:TextField  ID="uxContentTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxContentKeywordsLabel" AssociatedControlID="uxContentKeywords" CssClass="span-3 last" runat="server" Text="Keywords(;):" />
        <ektronUI:TextField  ID="uxContentKeywords" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxContentSummaryLabel" AssociatedControlID="uxContentSummary" CssClass="span-3 last" runat="server" Text="Summary:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxContentSummary" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxPrivateLabel" AssociatedControlID="uxPrivate" CssClass="span-3 last" runat="server" Text=" Private:" />
        <ektronUI:Button DisplayMode="Checkbox"  ID="uxPrivate" Text="" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxContentHtmlLabel" AssociatedControlID="uxContentHtml" CssClass="span-3 last" runat="server" Text="* Html:" />
        <asp:TextBox TextMode="MultiLine" Rows="4"  ID="uxContentHtml" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentManager contentManager = new ContentManager();
            ContentData contentData = new ContentData()
            {
                FolderId = long.Parse(uxFolderId.Text),
                Title = uxContentTitle.Text,
                Teaser = uxContentSummary.Text,
                Html = uxContentHtml.Text,
                IsPrivate = uxPrivate.Checked,
                IsPermissionsInherited = true
            };

            contentManager.Add(contentData);

            MessageUtilities.UpdateMessage(uxMessage, "Content Saved with Id " + contentData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

            contentManager.AssignTaxonomy(contentData.Id, 68);
            contentManager.AssignTaxonomy(contentData.Id, 189);
            contentManager.AssignTaxonomy(contentData.Id, 190);
            contentManager.AssignTaxonomy(contentData.Id, 192);

            UserPermissionData permission = new UserPermissionData()
            {
                CanAdd = true,
                CanApprove = true,
                CanDelete = true,
                CanEdit = true,
                CanPublish = true,
                IsAdmin = true,  
                ContentId = contentData.Id,
                UserId = 8,
                FolderId = contentData.FolderId,
                IsInherited = true
            };

            Ektron.Cms.Framework.Settings.PermissionManager perManager = new Ektron.Cms.Framework.Settings.PermissionManager(Ektron.Cms.Framework.ApiAccessMode.Admin);
            perManager.Add(permission);

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

AssignTaxonomy

AssignTaxonomy(System.Int64,System.Int64)

Assigns a content item from a taxonomy category.

Authenticated users

• CMS 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 ID
• * Taxonomy ID

Parameters

• contentId. ID of the content item to assign to a category.
• categoryId. ID of the taxonomy category to assign content to.

.aspx code snippet

<ol class="formFields">
    <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="30" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIDLabel" AssociatedControlID="uxTaxonomyID" CssClass="span-3 last" runat="server" Text="* Taxonomy Id:" />
        <ektronUI:TextField ID="uxTaxonomyID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentStatus" Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </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="Assign"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            long contentID = long.Parse(uxContentId.Text);
            long TaxonomyID = long.Parse(uxTaxonomyID.Text);
            bool result = Information.IsNumeric(uxContentId.Text);
            cData = contentManager.GetItem(contentID, false);
            if (!((result) && cData != null))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid Content ID", Message.DisplayModes.Error);
                return;
            }
            TaxonomyManager taxonomyManager = new TaxonomyManager();
            TaxonomyData taxonomyData = taxonomyManager.GetItem(TaxonomyID);

            if (taxonomyData != null && taxonomyData.Id > 0)
            {
                //Assign content taxonomy to a category 
                contentManager.AssignTaxonomy(contentID, TaxonomyID);
                MessageUtilities.UpdateMessage(uxMessage,  " Content Id : " + contentID + " has been Assigned to Taxonomy ID : " + TaxonomyID, Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Taxonomy Id.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Cancel

Cancel(System.Int64)

Undo the last changes of the content.

Authenticated Users

• CMS Administrators

Fields

*=Required

• * Content ID

Parameters

• contentId. ID of the content item.

.aspx code snippet

<ol class="formFields">
    <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="30" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Cancel"></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 Ektron.Cms.Framework.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentManager contentManager = new ContentManager();
            long contentID = long.Parse(uxContentId.Text);
            contentManager.Cancel(contentID);
            MessageUtilities.UpdateMessage(uxMessage, contentID + " content undo the last changes", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);  
            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

CheckIn

CheckIn(System.Int64)

Checks in a content item to the CMS.

Authenticated users

• CMS 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 ID

Parameters

• contentId. ID of the content item to be checked in.

.aspx code snippet

<ol class="formFields">
    <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">
        <ektronUI:Label ID="uxContentStatus" Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Check In"></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.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        { 
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            long contentID = long.Parse(uxContentId.Text);
            bool result = Information.IsNumeric(uxContentId.Text);
            cData = contentManager.GetItem(contentID, false);
            if (!((result) && cData != null && cData.IsPublished))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid Content ID", Message.DisplayModes.Error);
                return;
            }
            contentManager.CheckIn(contentID);
            MessageUtilities.UpdateMessage(uxMessage,  "Content successfully checked-in and  its content id is : " + contentID, Message.DisplayModes.Success);

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

CheckOut

CheckOut(System.Int64)

Checks out a content item from the CMS.

Authenticated Users

• CMS Administrators

NOTE: Any user can use the Update method to update content on folders to which the user has permission.

Fields

*=Required

• * Content ID

Parameters

• contentId. ID of the content item to be checked out.

.aspx code snippet

<ol class="formFields">
    <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">
        <ektronUI:TextField ID="uxContentStatus" Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Check Out"></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.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            long contentID = long.Parse(uxContentId.Text);
            bool result = Information.IsNumeric(uxContentId.Text);
            cData = contentManager.GetItem(contentID, false);
            if (!((result) && cData != null && cData.IsPublished))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid Content ID", Message.DisplayModes.Error);
                return;
            }
            contentManager.CheckOut(contentID);
            MessageUtilities.UpdateMessage(uxMessage,"Content successfully checked-out and  its content id is : " + contentID, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);           
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

CopyContent

CopyContent(System.Int64,System.Int64,System.Int64,System.Boolean)

Copy content from one folder to another folder that specified as a folder ID.

Authenticated Users

• CMS Administrators

Fields

*=Required

• * Content ID
• * Folder ID
• * Language ID
• * Is Published

Parameters

• contentId. ID of the content item to be copied.
• folderId. ID of the folder into which the content is copied.
• languageId. ID of the language of the content item.
• isPublish. Determines whether the content is to be published.

.aspx code snippet

<ol class="formFields">
    <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="30" />
    </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="uxLanguageIDLabel" AssociatedControlID="uxLanguageID" CssClass="span-3 last" runat="server" Text="* Language Id:" />
        <ektronUI:TextField ID="uxLanguageID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1033" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsPublishLabel" AssociatedControlID="uxIsPublish" CssClass="span-3 last" runat="server" Text="* IsPublish:" />
        <ektronUI:TextField ID="uxIsPublish" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="True" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentStatus" Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Copy"></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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
           
            long folderId,contentId,languageId;
            contentId=Convert.ToInt64(uxContentId.Text);
            languageId=Convert.ToInt64(uxLanguageID.Text);
            bool publish=Convert.ToBoolean(uxIsPublish.Text);
            folderId = Convert.ToInt64(uxFolderID.Text);
            ContentManager contentManager = new ContentManager();
            contentManager.ContentLanguage = (int)languageId;
            contentManager.CopyContent(contentId, folderId, languageId, publish);
            MessageUtilities.UpdateMessage(uxMessage, contentId+" Content copy to folder " + folderId.ToString(), 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 content item from the CMS.

Authenticated users

• CMS 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 ID

Parameters

• contentId. ID of the content item to be deleted.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <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">
        <ektronUI:Label ID="uxContentStatus"  Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </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.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            long contentID = long.Parse(uxContentId.Text);
            bool result = Information.IsNumeric(uxContentId.Text);
            cData = contentManager.GetItem(contentID, false);
            if (!((result) && cData != null && cData.IsPublished))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus,  "Invalid Content ID", Message.DisplayModes.Error);
                return;
            }
            contentManager.Delete(contentID);
            MessageUtilities.UpdateMessage(uxMessage, "Content successfully deleted and  its content id was : " + contentID, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64,System.Boolean)

Retrieves the properties of a specific ContentData object.

Authenticated users

• CMS 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 ID

Parameters

• id. ID of the content to retrieve.
• returnMetadata. Flag indicating whether or not ContentMetadata should also be retrieved with the content item.

.aspx code snippet

<ol class="formFields">
    <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="30" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentStatus" Visible="false" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDetails"></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="uxContID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentLanguage" 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.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            Boolean returnMetadata = false;
            long contentID = long.Parse(uxContentId.Text);
            bool result = Information.IsNumeric(uxContentId.Text);
            cData = contentManager.GetItem(contentID,returnMetadata);
            if (!((result) && cData != null))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid content ID ", Message.DisplayModes.Error);
                return;
            }
            uxContID.Text = "Content ID : " + cData.Id;
            uxContentTitle.Text = "Content Title : " + cData.Title;
            uxContentLanguage.Text = "ContentLanguage Id : " + cData.LanguageId;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList (content collection criteria)

GetList(Ektron.Cms.Content.ContentCollectionCriteria)

Retrieves lists of objects.

Authenticated users

• CMS 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 Property
• * Object Value
• In Preview Mode

Parameters

• criteria. ContentCollectionCriteria used to retrieve content by collections.

Returns

List of ContentData objects matching the supplied criteria.

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.

NOTE: If the content you request does not exist in the current language, content is returned in fallback languages according to the fallback locale chain. However, if you request content in a specific language using a CriteriaFilter, the fallback languages are not returned because you are overriding the default language functionality and looking for specific content. For information about setting the fallback locale, see Setting the Fallback Locale.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentPropertyLabel" AssociatedControlID="uxContentProperty" CssClass="span-4 last"
            runat="server" Text="* Collection Property :" />
        <asp:DropDownList ID="uxContentProperty" 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" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxInPreviewModeLabel" AssociatedControlID="uxInPreviewMode" CssClass="span-4 last"
            runat="server" Text=" InPreviewMode :" />
        <asp:CheckBox ID="uxInPreviewMode" runat="server" Checked="false" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></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="uxContentlist" runat="server" ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate>Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Content Id
                    </th>
                    <th>
                        Title
                    </th>
                    <th>
                        Status
                    </th>
                    <th>
                        Date Modified
                    </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("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Status")%>
            </td>
            <td class="devsite-method">
                <%# Eval("DateModified")%>
            </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.Site;
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
        {
            string Objectvalue;
            string Property = uxContentProperty.SelectedItem.Text;

            ContentManager contentManager = new ContentManager();

            if(uxInPreviewMode.Checked)
                contentManager.InPreviewMode = uxInPreviewMode.Checked;

            ContentCollectionCriteria criteria = new ContentCollectionCriteria(ContentProperty.Id, EkEnumeration.OrderByDirection.Ascending);

            Objectvalue = uxObjectValue.Text;

            if (Property == "Id")
            {
                criteria.AddFilter(Convert.ToInt64(uxObjectValue.Text));
            }
            else 
            {
                criteria.AddFilter(Objectvalue);
            }

            List<ContentData> contentList = contentManager.GetList(criteria);

            uxContentlist.Visible = true;
            uxContentlist.DataSource = contentList;
            uxContentlist.DataBind();

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

GetList (content criteria)

GetList(Ektron.Cms.Content.ContentCriteria)

Retrieves lists of objects.

Authenticated users

• CMS 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 Property
• * Object Value

Parameters

• criteria. ContentCriteria used to retrieve content.

Returns

List of ContentData objects matching the supplied criteria.

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.

NOTE: If the content you request does not exist in the current language, content is returned in fallback languages according to the fallback locale chain. However, if you request content in a specific language using a CriteriaFilter, the fallback languages are not returned because you are overriding the default language functionality and looking for specific content. For information about setting the fallback locale, see Setting the Fallback Locale in the Ektron Reference.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentPropertyLabel" AssociatedControlID="uxContentProperty" CssClass="span-4 last"
            runat="server" Text="* Collection Property :" />
        <asp:DropDownList ID="uxContentProperty" 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" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxInPreviewModeLabel" AssociatedControlID="uxInPreviewMode" CssClass="span-4 last"
            runat="server" Text=" InPreviewMode :" />
        <asp:CheckBox ID="uxInPreviewMode" runat="server" Checked="false" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></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="uxContentlist" runat="server" ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate>Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Content Id
                    </th>
                    <th>
                        Title
                    </th>
                    <th>
                        Status
                    </th>
                    <th>
                        Date Modified
                    </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("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Status")%>
            </td>
            <td class="devsite-method">
                <%# Eval("DateModified")%>
            </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.Site;
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;
            string Property = uxContentProperty.SelectedItem.Text;

            ContentManager contentManager = new ContentManager();
            ContentCriteria criteria = new ContentCriteria(ContentProperty.Id, EkEnumeration.OrderByDirection.Ascending);

            Objectvalue = Convert.ToInt64(uxObjectValue.Text);

            if (Property == "Id")
            {                
                criteria.AddFilter(ContentProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "FolderID")
            {                
                criteria.AddFilter(ContentProperty.FolderId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {                
                criteria.AddFilter(ContentProperty.LanguageId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<ContentData> contentList = contentManager.GetList(criteria);

            uxContentlist.Visible = true;
            uxContentlist.DataSource = contentList;
            uxContentlist.DataBind();

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

GetList (metadata criteria)

GetList(Ektron.Cms.Content.ContentMetadataCriteria)

Retrieves lists of objects.

Authenticated users

• CMS 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 Property
• * Metadata ID
• * Value

Parameters

• criteria. ContentMetadataCriteria used to retrieve content.

Returns

List of ContentData objects matching the supplied criteria.

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.

NOTE: If the content you request does not exist in the current language, content is returned in fallback languages according to the fallback locale chain. However, if you request content in a specific language using a CriteriaFilter, the fallback languages are not returned because you are overriding the default language functionality and looking for specific content. For information about setting the fallback locale, see Setting the Fallback Locale in the Ektron Reference.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentPropertyLabel" AssociatedControlID="uxContentProperty" CssClass="span-4 last" runat="server" Text="* ContentProperty :" />
        <asp:DropDownList ID="uxContentProperty" runat="server" >
            <asp:ListItem>Metadata ID</asp:ListItem>
                  
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMetadataIDLabel" AssociatedControlID="uxMetadataID" CssClass="span-4 last" runat="server" Text="* Metadata ID :" />
        <ektronUI:TextField ID="uxMetadataID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="117" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMetaValueLabel" AssociatedControlID="uxMetaValue" CssClass="span-4 last" runat="server" Text="* Value :" />
        <ektronUI:TextField ID="uxMetaValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="SampleMeta" />
    </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="uxContentlist" 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>
                        Title
                    </th>
                    <th>
                        LanguageId
                    </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("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("LanguageId")%>
            </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Content;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;
            string Property = uxContentProperty.SelectedItem.Text;
            ContentManager contentManager = new ContentManager();
            ContentMetadataCriteria criteria = new ContentMetadataCriteria(ContentProperty.Id, EkEnumeration.OrderByDirection.Ascending);


            Objectvalue = Convert.ToString(uxMetaValue.Text);
            criteria.AddFilter(long.Parse(uxMetadataID.Text), CriteriaFilterOperator.EqualTo, Objectvalue);

            List<ContentData> contentList = contentManager.GetList(criteria);

            uxContentlist.Visible = true;
            uxContentlist.DataSource = contentList;
            uxContentlist.DataBind();

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

GetList (content taxonomy)

GetList(Ektron.Cms.Content.ContentTaxonomyCriteria)

Retrieves lists of objects.

Authenticated users

• CMS 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 Property
• * Taxonomy ID
• * Recursive

Parameters

• criteria. ContentTaxonomyCriteria used to retrieve content.

Returns

List of ContentData objects matching the supplied criteria.

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.

NOTE: If the content you request does not exist in the current language, content is returned in fallback languages according to the fallback locale chain. However, if you request content in a specific language using a CriteriaFilter, the fallback languages are not returned because you are overriding the default language functionality and looking for specific content. For information about setting the fallback locale, see Setting the Fallback Locale in the Ektron Reference.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentTaxonomyPropertyLabel" AssociatedControlID="uxContenttaxonomyProperty" CssClass="span-4 last" runat="server" Text="* ContentProperty :" />
        <asp:DropDownList ID="uxContentTaxonomyProperty" runat="server" AutoPostBack="true" OnSelectedIndexChanged="uxContentTaxonomyProperty_SelectedIndexChanged">
            <asp:ListItem>Taxonomy ID</asp:ListItem>
            <asp:ListItem>Taxonomy Path</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIDLabel" AssociatedControlID="uxTaxonomyID" CssClass="span-4 last" runat="server" Text="* Taxonomy ID :" />
        <ektronUI:TextField ID="uxTaxonomyID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="189" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyPathLabel" Visible="false" AssociatedControlID="uxTaxonomyPath" CssClass="span-4 last" runat="server" Text="* Taxonomy Path(start with  '\' and separate by '\'):"  />
        <ektronUI:TextField ID="uxTaxonomyPath" Visible="false" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  Text="\OnTrek Site Navigation" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxRecursiveLabel" AssociatedControlID="uxTaxRecursiveValue" CssClass="span-4 last" runat="server" Text="* Recursive :" />
        <asp:DropDownList ID="uxTaxRecursiveValue" runat="server">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></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="uxContentlist" runat="server" ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate>Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Content ID
                    </th>
                    <th>
                        Title
                    </th>
                    <th>
                        LanguageId
                    </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("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("LanguageId")%>
            </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Content;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            bool recursive =  Convert.ToBoolean(uxTaxRecursiveValue.SelectedValue);
            string Property = uxContentTaxonomyProperty.SelectedItem.Text;
            ContentManager contentManager = new ContentManager();
            ContentTaxonomyCriteria criteria = new ContentTaxonomyCriteria(ContentProperty.Id, EkEnumeration.OrderByDirection.Ascending);

            if (Property == "Taxonomy ID")
            {
                
                criteria.AddFilter(long.Parse(uxTaxonomyID.Text), recursive);
            }
            else if (Property == "Taxonomy Path") 
            {

                criteria.AddFilter(uxTaxonomyPath.Text, recursive);
            }
            List<ContentData> contentList = contentManager.GetList(criteria);

            uxContentlist.Visible = true;
            uxContentlist.DataSource = contentList;
            uxContentlist.DataBind();

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

MoveContent

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

Move content from one folder to another folder that specified as a folder ID.

Authenticated Users

• CMS Administrators

Fields

*=Required

• * Content IDs
• * Folder ID

Parameters

• contentIds. ID of the content items to be move.
• folderId. ID of the folder into which the content is moved.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-3 last" runat="server" Text="* Content Ids:" />
        <ektronUI:TextField ID="uxContentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30" />
    </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="uxContentStatus" Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Move"></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 Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            String[] idList;
            
            List<long> Ids = new List<long>();
            long folderId;
            string idStr;
            idStr = uxContentId.Text.Trim();
            idList = idStr.Split(',');

            foreach (string id in idList)
            {
                Ids.Add(Convert.ToInt64(id.Trim()));
            }

            folderId = Convert.ToInt64(uxFolderID.Text);
            ContentManager contentManager = new ContentManager();
            contentManager.MoveContent(Ids, folderId);
            MessageUtilities.UpdateMessage(uxMessage, "Content moved to folder " + folderId.ToString(), Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

           

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

RemoveTaxonomy

RemoveTaxonomy(System.Int64,System.Int64)

Removes a content item from a taxonomy category.

Authenticated users

• CMS 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 ID
• * Taxonomy ID

Parameters

• contentId. ID of the content item to remove from category.
• categoryId. ID of the taxonomy category to remove content from.

.aspx code snippet

<ol class="formFields">
    <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="30" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIDLabel" AssociatedControlID="uxTaxonomyID" CssClass="span-3 last" runat="server" Text="* Taxonomy Id:" />
        <ektronUI:TextField ID="uxTaxonomyID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentStatus" Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Remove"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            long contentID = long.Parse(uxContentId.Text);
            long TaxonomyID = long.Parse(uxTaxonomyID.Text);
            bool result = Information.IsNumeric(uxContentId.Text);
            cData = contentManager.GetItem(contentID, false);
            if (!((result) && cData != null))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid Content ID", Message.DisplayModes.Error);
                return;
            }
            //Remove content taxonomy to a category 
            contentManager.RemoveTaxonomy(contentID, TaxonomyID);
            MessageUtilities.UpdateMessage(uxMessage, " Content Id : " + contentID + " has been removed to Taxonomy ID : " + TaxonomyID, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Submit

Submit(System.Int64)

Submits a content item to be published.

Authenticated users

• CMS 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 ID

Parameters

• contentId. ID of the content item to be submitted.

.aspx code snippet

<ol class="formFields">
    <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="30" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentStatus" Visible="false" AssociatedControlID="uxContentStatus" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Submit"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </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.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            long contentID = long.Parse(uxContentId.Text);
            bool result = Information.IsNumeric(uxContentId.Text);
            if (!((result))) 
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid Content ID", Message.DisplayModes.Error);
                return;
            }
            contentManager.Submit(contentID);
            cData = contentManager.GetItem(contentID, false);
            if (cData.Status == "S")
            {
                MessageUtilities.UpdateMessage(uxMessage, "Content successfully submitted and  its content id is : " + contentID + "and content Status is :" + cData.Status, Message.DisplayModes.Success);
            }
            else { 
            MessageUtilities.UpdateMessage(uxMessage,  "Content successfully published and  its content id is : " + contentID + "and content Status is :" + cData.Status, Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    } 

Update

Update(Ektron.Cms.ContentData)

Updates an existing content item in the CMS.

Authenticated users

• CMS 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 ID
• Title
• Keywords
• Summary
• HTML

Parameters

• contentData. The ContentData object to update.

Returns

Returns the custom ContentData object update.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <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">
        <asp:Label ID="uxContentTitleLabel" AssociatedControlID="uxContentTitle" CssClass="span-3 last" runat="server" Text="Title:" />
        <ektronUI:TextField  ID="uxContentTitle" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <asp:Label ID="Label1" AssociatedControlID="uxContentKeywords" CssClass="span-3 last" runat="server" Text="Keywords:" />
        <ektronUI:TextField  ID="uxContentKeywords" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxContentSummaryLabel" AssociatedControlID="uxContentSummary" CssClass="span-3 last" runat="server" Text="Summary:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxContentSummary" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <asp:Label ID="uxContentHtmlLabel" AssociatedControlID="uxContentHtml" CssClass="span-3 last" runat="server" Text="Html:" />
        <asp:TextBox TextMode="MultiLine" Rows="4"  ID="uxContentHtml" 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"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>          
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Content;
using Ektron.Cms;
using Microsoft.VisualBasic;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long contentID = long.Parse(uxContentId.Text);
            ContentManager contentManager = new ContentManager();
            ContentData cData = contentManager.GetItem(contentID);

            if (cData != null && cData.Id > 0)
            {
                if (!string.IsNullOrEmpty(uxContentKeywords.Text))
                {
                    cData.MetaData = new ContentMetaData[1];
                    cData.MetaData[0] = new ContentMetaData()
                    {
                        Id = 116,
                        Text = uxContentKeywords.Text
                    };
                }

                cData.Title = uxContentTitle.Text != string.Empty ? uxContentTitle.Text : cData.Title;
                cData.Teaser = uxContentSummary.Text != string.Empty ? uxContentSummary.Text : cData.Teaser;
                cData.Html = uxContentHtml.Text != string.Empty ? uxContentHtml.Text : cData.Html;
                cData.UserId = contentManager.UserId;
                contentManager.Update(cData);
                MessageUtilities.UpdateMessage(uxMessage, "Content with ID : " + cData.Id + " has been updated.", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid content ID ", Message.DisplayModes.Error);
                return;
            }

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

ContentCollectionCriteria

Namespace

Ektron.Cms.Content

Constructors

• ContentCollectionCriteria()

  public ContentCollectionCriteria()

• ContentCollectionCriteria(Ektron.Cms.Common.ContentProperty, EkEnumeration.OrderByDirection)

  public ContentCollectionCriteria(Ektron.Cms.Common.ContentProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the ContentProperty are:

  • ContentPath
  • DateCreated
  • DateModified
  • EndDate
  • EndDateActionType
  • ExpireDate
  • ExternalTypeId
  • FolderId
  • FolderName
  • GoLivedate
  • Id
  • InheritedFromId
  • IsArchived
  • IsPublished
  • IsSearchable
  • LanguageId
  • LastEditorFirstName
  • LastEditorLastName
  • Path
  • Status
  • SubType
  • Title
  • Type
  • UserId
  • XmlConfigurationId

Methods

• AddFilter(Ektron.Cms.Common.ContentCollectionProperty, Ektron.Cms.Common.CriteriaFilterOperator, object). Adds a Filter to the criteria for filtering based upon a content collection.

  public Ektron.Cms.Content.ContentCollectionFilterGroup AddFilter(Ektron.Cms.Common.ContentCollectionProperty field, Ektron.Cms.Common.CriteriaFilterOperator operator, object value)

• AddFilter(string). Adds a Filter to the criteria for filtering based upon a content collection.

  public Ektron.Cms.Content.ContentCollectionFilterGroup AddFilter(string collectionName)

• AddFilter(long). Adds a Filter to the criteria for filtering based upon a content collection.

  public Ektron.Cms.Content.ContentCollectionFilterGroup AddFilter(long collectionId)

• CollectionGroupFilters

  public System.Collections.Generic.List<ContentCollectionFilterGroup> CollectionGroupFilters { set; get; }

• GenerateSql(System.Data.Common.DbCommand, System.Collections.Generic.Dictionary<Ektron.Cms.Common.ContentProperty,string>, out string, out string)

  public override void
    GenerateSql(System.Data.Common.DbCommand command,
    System.Collections.Generic.Dictionary<ContentProperty,string>
    columnMap, out string whereClause, out string orderByClause)

• OrderByCollectionOrder. If true, will disregard OrderBy property and instead use predetermined content collection order.

  public bool OrderByCollectionOrder { set; get; }

• ToCacheKey()

  public override string ToCacheKey()

ContentCriteria

Namespace

Ektron.Cms.Content

Constructors

• ContentCriteria()

  public ContentCriteria()

• ContentCriteria(Ektron.Cms.Common.ContentProperty, EkEnumeration.OrderByDirection)

  public ContentCriteria(Ektron.Cms.Common.ContentProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the ContentProperty are:

  • ContentPath
  • DateCreated
  • DateModified
  • EndDate
  • EndDateActionType
  • ExpireDate
  • ExternalTypeId
  • FolderId
  • FolderName
  • GoLivedate
  • Id
  • InheritedFromId
  • IsArchived
  • IsPublished
  • IsSearchable
  • LanguageId
  • LastEditorFirstName
  • LastEditorLastName
  • Path
  • Status
  • SubType
  • Title
  • Type
  • UserId
  • XmlConfigurationId

ContentData

Namespace

Ektron.Cms

Properties

• ApprovalMethod. Gets or sets the approval method of a content item for the ContentData object. Returns an integer value representing the type of approval method. If the content is inheriting the approval method from the folder, the IsInherited property must be false to change this property. Choices are:
  • 1 = Force All Approvers. Content checked-out during the approval process will force the approval chain to reset to the beginning.
  • 0 = Do Not Force All Approvers. Content checked-out during the approval process will continue through the approval chain.

  public int ApprovalMethod { set; get; }

• Approver. Gets or sets the approvers of a content item for the ContentData object. Returns a string value representing the approvers of a content item.

  public string Approver { set; get; }

• Comment. Gets or sets comment information associated with a content item for the ContentData object. Returns comment information associated with a content item.

  public string Comment { set; get; }

• ContentPath. Gets or sets the Ektron CMS path to content item for theContentData object, which includes the content title. For example, folder1/Content Title. Returns a string value representing the Ektron CMS path to the content item, including the content's title.

  public string ContentPath { set; get; }

• ContType. Gets or sets the content type as an integer, should be 1 for content Returns an integer representing the content type.

  public int ContType { set; get; }

• DateCreated. Gets or sets the creation date of a content item for the ContentData object. Returns a creation date of a content item as DateTime.

  public System.DateTime DateCreated { set; get; }

• DateModified. Gets or sets the content's last edit date for the ContentData object. Returns a content's last edit date as a DateTime.

  public System.DateTime DateModified { set; get; }

• DisplayDateCreated. Gets or sets the creation date of a content item formatted for display for the ContentData object. For example, June 11, 2014. Returns a creation date of a content item formatted for display.

  public string DisplayDateCreated { set; get; }

• DisplayEndDate. Gets or sets the end date of a content item formatted for display. This is for the ContentData object. For example, June 11, 2014. Returns an end date of a content item formatted for display.

  public string DisplayEndDate { set; get; }

• DisplayGoLive. Gets or sets the start date a content item goes live on the site formatted for display. This is for the ContentData object. For example, June 11, 2014. Returns a start date a content item goes live on the site formatted for display.

  public string DisplayGoLive { set; get; }

• DisplayLastEditDate. Gets or sets the content's last edit date formatted for display for the ContentData object. For example, June 11, 2014. Returns a content's last edit date formatted for display.

  public string DisplayLastEditDate { set; get; }

• EditorFirstName. Gets the content editor's first name for the ContentData object. This property is populated on retrieval, but is not persisted when saving ContentData. Returns an editor's first name as a string.

  public string EditorFirstName { set; get; }

• EditorLastName. Gets the content editor's last name for the ContentData object. This property is populated on retrieval, but is not persisted when saving ContentData. Returns an editor's last name as a string.

  public string EditorLastName { set; get; }

• EditorUserNames. Gets the username of the last editor of the content item for the ContentData object. This property is populated on retrieval, but is not persisted when saving ContentData. Returns a username of the last editor of the content item.

  public string EditorUserNames { set; get; }

• EndDate. Gets or sets the end date of a content item. This is for the ContentData object. Returns a string value that represents the end date of a content item.

  public string EndDate { set; get; }

• EndDateAction. Gets or sets the action to perform on a content item once the End Date has been reached. This is for the ContentData object. Returns an integer value representing one of the above end date action choices. Choices are:
  • 1 = Archive and remove from site (expire)
  • 2 = Archive and remain on site
  • 3 = Add to the CMS Refresh Report.

  public int EndDateAction { set; get; }

• EndDateActionType. Gets or sets the End Action type.

  public EkEnumeration.CMSEndDateAction EndDateActionType { set; get; }

• ExpireDate. Gets or sets the expire date of a content item. This is for the ContentData object. Returns a string value that represents the expire date of a content item.

  public System.DateTime ExpireDate { set; get; }

• FlagDefId. Gets or sets the content item's Flag Defition Id for the ContentData object. Returns a content item's Flag Definition Id as long for the ContentData object.

  public long FlagDefId { set; get; }

• FolderId. Gets or sets the content item's folder ID for the ContentData object. Reutns a folder ID as a long.

  public long FolderId { set; get; }

• FolderName. Gets or sets the content item's folder name for the ContentData object. Returns the content item's folder name.

  public string FolderName { set; get; }

• GoLive. Gets or sets the start date a content item goes live on the site. This is for the ContentData object. Returns a string value that represents the date a content item goes live.

  public string GoLive { set; get; }

• GoLiveDate. Gets or sets the Golive date a content item goes live on the site. This is for the ContentData object. Returns a string value that represents the date a content item goes live.

  public System.DateTime? GoLiveDate { set; get; }

• HistoryId. Gets or sets the content item's history ID for the ContentData object. Returns the numeric ID (Long) of the content item's history.

  public long HistoryId { set; get; }

• HyperLink. Gets or sets the content item's Hyperlink in the Ektron CMS for theContentData object. Returns a content item's Hyperlink information.

  public string HyperLink { set; get; }

• InheritedFrom. Gets or sets the folder ID from which to inherit permissions for the ContentDataobject. Returns a numeric ID representing the folder from which permissions are inherited.

  public long InheritedFrom { set; get; }

• IsInherited. Gets or sets whether the content item inherits permissions from the folder settings for the ContentData object. Returns a boolean that returns true when the content item inherits permissions from the folder settings.

  public bool IsInherited { set; get; }

• IsMetaComplete. This property is deprecatedfunctionality that was improved upon by other functionality. If you are already using a deprecated item, you can continue to do so, but Ektron recommends using current versions of functionality..

  public bool IsMetaComplete { set; get; }

• IsPermissionsInherited. Gets or sets whether the content item inherits permissions from the folder settings for the ContentData object. Returns a boolean that returns true when the content item inherits permissions from the folder settings.

  public bool IsPermissionsInherited { set; get; }

• IsPublished. Gets or sets whether the content is published before for the ContentData object. Returns a boolean based on whether the content is published before. True = Published

  public bool IsPublished { set; get; }

• IsSearchable. Gets or sets whether the content is searchable for the ContentData object. Returns a boolean based on whether the content is searchable.
  • True = content is searchable.
  • False = content is not searchable.

  public bool? IsSearchable { set; get; }

• IsSearchableAsBool. XML comment contains invalid XML: End tag 'returns' does not match the start tag 'summary'.

  public bool IsSearchableAsBool { set; get; }

• IsXmlInherited. Gets or sets whether the XML Smart Form configuration is inherited from the folder. This is for the ContentData object. Returns a boolean based on whether the XML Smart Form configuration is inherited from the folder.
  • True = content XML Smart Form configuration is inherited from the folder.
  • False = content XML Smart Form configuration is not inherited from the folder.

  public bool IsXmlInherited { set; get; }

• LanguageDescription

  public string LanguageDescription { set; get; }

• LastEditDate. This property is deprecatedfunctionality that was improved upon by other functionality. If you are already using a deprecated item, you can continue to do so, but Ektron recommends using current versions of functionality.: Use DateModified, which returns a DateTime rather than a string. Gets or sets the content's last edit date for the ContentData object. Returns a content's last edit date as a string.

  public string LastEditDate { set; get; }

• LegacyData. Gets or sets the Legacy Data of a content item as an Object of ContentMetadata. This is for the ContentData object. Returns Legacy Data as an Object of ContentMetaData.

  public object LegacyData { set; get; }

• ManualAlias. Gets or sets the manual alias by its name for the ContentData object. For example, /~YourSite~/text.aspx. Returns a string value representing the name of a manual alias.

  public string ManualAlias { set; get; }

• ManualAliasId. Gets or sets the ID of the of a manual alias for the ContentData object. Returns a numeric value (Long) representing a manual alias ID.

  public long ManualAliasId { set; get; }

• MediaText. Gets or sets any MediaText associated with the ContentData object. Returns Media Text associated with ContentData object item.

  public string MediaText { set; get; }

• MetaData. Gets or sets the Metadata of a content item as an array of ContentMetadata. This is for the ContentData object. Returns metadata as an array of ContentMetaData.

  public Ektron.Cms.ContentMetaData[] MetaData { set; get; }

• Path. Gets or sets the Ektron CMS path to content item for theContentDataobject. Returns a string value representing the Ektron CMS path to the content item.

  public string Path { set; get; }

• PermissionInheritedFrom. Gets or sets the folder ID from which to inherit permissions for the ContentData object. Returns a numeric ID representing the folder from which permissions are inherited.

  public long PermissionInheritedFrom { set; get; }

• Permissions. Gets or sets permission data for the ContentData object. Permissions as a PermissionData object.

  public Ektron.Cms.PermissionData Permissions { set; get; }

• Status. This property should be considered read-only. This value is managed by the Ektron approval workflow (if any) attached to the item. Gets the letter value representing the status of a content item for the ContentData object. Returns a letter value representing the status of a content item.
  • 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; }

• StyleSheet. Gets or sets the style sheet to use with a content item for the ContentData object. Returns a string value representing the style sheet to use with a content item.

  public string StyleSheet { set; get; }

• TemplateCnfiguration. Gets or sets the content item's template configuration for the ContentData object. Returns a content item's template configuration as TemplateData.

  public Ektron.Cms.TemplateData TemplateConfiguration { set; get; }

• Text. Gets or sets a string value representing the Ektron CMSContentDataobject. Returns a string value representing the Ektron CMSContentData object.

  public string Text { set; get; }

• Updates. Gets or sets the updates information associated with the ContentData object. Returns updates of type Integer.

  public int Updates { set; get; }

• UserId. Gets or sets the ID of the user for the ContentData object. Returns a User ID as a Long.

  public long UserId { set; get; }

• UserName. This property is obsolete. To retrieve the user name, call EkUser GetActiveUserbyID with the correct User ID. Returns the content's username. Gets or sets the content's username for the ContentData object.

• public string UserName { set; get; }

• Validate(). Validation method for this object; returns a ValidationResults instance.

  public override ValidationResults Validate()

• XmlConfiguration. Gets or sets the content item's XML configuration for the ContentData object. Returns a content item's XML configuration as XmlConfigData.

  public XmlConfigData XmlConfiguration { set; get; }

• XmlInheritedFrom. Gets or sets the ID of the folder from which the XML Smart Form configuration is inherited. This is for the ContentData object. Returns a numeric ID (Long) of the folder from which the XML Smart Form configuration is inherited.

  public long XmlInheritedFrom { set; get; }

ContentMetadataCriteria

Namespace

Ektron.Cms.Content

Constructors

• ContentMetadataCriteria()

  public ContentMetadataCriteria()

• ContentMetadataCriteria(Ektron.Cms.Common.ContentProperty, EkEnumeration.OrderByDirection)

  public ContentMetadataCriteria(Ektron.Cms.Common.ContentProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the ContentProperty are:

  • ContentPath
  • DateCreated
  • DateModified
  • EndDate
  • EndDateActionType
  • ExpireDate
  • ExternalTypeId
  • FolderId
  • FolderName
  • GoLivedate
  • Id
  • InheritedFromId
  • IsArchived
  • IsPublished
  • IsSearchable
  • LanguageId
  • LastEditorFirstName
  • LastEditorLastName
  • Path
  • Status
  • SubType
  • Title
  • Type
  • UserId
  • XmlConfigurationId

Methods

• AddFilter(ContentMetadatatProperty, operator, value). Filters the results based on the condition defined in this method.

  criteria.addFilter(ContentMetadataProperty field, CriteriaFilterOperator filterOperator , object value );

• GenerateSql(System.Data.Common.DbCommand, System.Collections.Generic.Dictionary<Ektron.Cms.Common.ContentProperty,string>, out string, out string)

  public override void
    GenerateSql(System.Data.Common.DbCommand command,
    System.Collections.Generic.Dictionary<ContentProperty,string>
    columnMap, out string whereClause, out string orderByClause)

• ToCacheKey()

  public override string ToCacheKey()

• MetadataFilterGroups

  public System.Collections.Generic.List<ContentMetadataFilterGroup>
    MetadataFilterGroups { set; get; }

ContentTaxonomyCriteria

Namespace

Ektron.Cms.Content

Constructors

• ContentTaxonomyCriteria()

  public ContentTaxonomyCriteria()

• ContentTaxonomyCriteria(Ektron.Cms.Common.ContentProperty, EkEnumeration.OrderByDirection)

  public ContentTaxonomyCriteria(Ektron.Cms.Common.ContentProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the ContentProperty are:

  • ContentPath
  • DateCreated
  • DateModified
  • EndDate
  • EndDateActionType
  • ExpireDate
  • ExternalTypeId
  • FolderId
  • FolderName
  • GoLivedate
  • Id
  • InheritedFromId
  • IsArchived
  • IsPublished
  • IsSearchable
  • LanguageId
  • LastEditorFirstName
  • LastEditorLastName
  • Path
  • Status
  • SubType
  • Title
  • Type
  • UserId
  • XmlConfigurationId

Methods

• AddFilter(string, [bool])

  public Ektron.Cms.Content.ContentTaxonomyFilterGroup
   AddFilter(string taxonomyPath, [bool recursive = false])

• AddFilter(long, [bool])

  public Ektron.Cms.Content.ContentTaxonomyFilterGroup
   AddFilter(long taxonomyId, [bool recursive = false])

• GenerateSql(System.Data.Common.DbCommand, System.Collections.Generic.Dictionary<Ektron.Cms.Common.ContentProperty,string>, out string, out string)

  public override void
   GenerateSql(System.Data.Common.DbCommand command,
   System.Collections.Generic.Dictionary<ContentProperty,string>
   columnMap, out string whereClause, out string orderByClause)

• TaxonomyGroupFilters

  public System.Collections.Generic.List<ContentTaxonomyFilterGroup>
   TaxonomyGroupFilters { set; get; }

• ToCacheKey()

  public override string ToCacheKey()