FolderManager

The FolderManager class manages Ektron CMS folders. See also Setting Up Your CMS Folder Structure in the Ektron Reference.

Namespace

Ektron.Cms.Framework.Organization.FolderManager

Methods

CopyFolder(Int64,Int64,Boolean,Boolean). Copy the folder from one parent folder to another parent folder.
GetAssignedFolders(Int64). Retrieves the list of folders assigned to the given taxonomy.
GetAssignedMetadata(Int64). Returns a list of content metadata assigned to a given folder.
GetSitemapPath(Int64). Returns the specified sitemappath object for a given folder. To get sitemappaths in different languages, change the manager's ekRequestInformation Language.
GetTree(Int64).
IsCommunityFolder(Int64). Returns true if the folder is a Community Folder.
MoveFolder(Int64,Int64,Boolean). Move the folder from existing parent folder to another parent folder.
Purge(Int64,DateTime,Boolean,Boolean). Purge the content history values for the folder until the specified date criteria.
UnAssignTemplate(Int64,Int64). UnAssign the template from the folder.
UnlinkTaxonomy(Int64,Int64). Unlink the supplied folder from the supplied taxonomy. All content in the folder is automatically unassigned from the given taxonomy.

Add. Adds a folder.

Add

Add(Ektron.Cms.FolderData)

Adds a folder based on information in an FolderData object.

The method populates the message.Id with the newly created ID.

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

* Name
* Parent Folder ID
Style Sheet
Description

Parameters

folderData. The FolderData object to add.

Returns

Added FolderData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField ID="uxName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxParentFolderIdLabel" AssociatedControlID="uxParentFolderId" CssClass="span-3 last" runat="server" Text="* Parent Folder Id:" />
        <ektronUI:TextField ID="uxParentFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStyleSheetLabel" AssociatedControlID="uxStyleSheet" CssClass="span-3 last" runat="server" Text=" Style Sheet:" />
        <ektronUI:TextField ID="uxStyleSheet" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-3 last" runat="server" Text="Description:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxDescription" 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;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            FolderManager folderManager = new FolderManager();
            FolderData folderData = new FolderData()
            {
                 Name = uxName.Text,
                 ParentId = long.Parse(uxParentFolderId.Text),
                 Description = uxDescription.Text,
                 StyleSheet = uxStyleSheet.Text
            };

            folderManager.Add(folderData);

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

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

AllowTaxonomy. Allows a list of taxonomy data based on IDs to a folder.

AllowTaxonomy

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

Allows a list of taxonomy data based on IDs to a folder.

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
* Taxonomy ID List (comma separated)

Parameters

folderId. Folder ID to which taxonomies are permitted.
taxonomyIdList. List of taxonomy IDs.

.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">
        <ektronUI:Label ID="uxTaxonomyIdListLabel" AssociatedControlID="uxTaxonomyIdList" CssClass="span-3 last"
            runat="server" Text="* Taxonomy Id List: (Comma Separated TaxonomyIds)" />
        <ektronUI:TextField ID="uxTaxonomyIdList" 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="Assign Taxonomy"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3 last" 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;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long folderId = long.Parse(uxFolderId.Text);
            long taxonomyId;
            List<long> taxonomyIdList = new List<long>();

            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderId);
            if (folderData != null)
            {
                foreach (string strId in uxTaxonomyIdList.Text.Split(new char[] { ',' }))
                {
                    taxonomyId = Convert.ToInt64(strId);

                    TaxonomyManager taxonomyManager = new TaxonomyManager();
                    TaxonomyData taxonomyData = taxonomyManager.GetItem(taxonomyId);
                    //Check Whether Entered  TaxonomyId is Valid or Not.
                    if (taxonomyData != null)
                    {
                        taxonomyIdList.Add(taxonomyId);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        uxStatus.Text = "Please Enter Valid TaxonomyId.";
                        return;
                    }
                }
                folderManager.AllowTaxonomy(folderId, taxonomyIdList);
                uxMessage.Text = "Taxonomy ID's assigned to folder with Id  " + folderId;
            }
            else
            {
                uxStatus.Visible = true;
                uxStatus.Text = "Please Enter Valid FolderID.";
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            uxMessage.Text = ex.Message;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

AssignMetadata. Assign a metadata to a folder.

AssignMetadata

AssignMetadata(System.Int64,System.Int64,System.Boolean)

Assign a metadata to a folder.

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
* Metadata Type ID
Is Required

Parameters

folderId. The ID of the folder.
metadataTypeId. The ID of the metadata type.
isRequired. Indicates whether metadata is required.

.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" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMetadataIdLabel" AssociatedControlID="uxMetadataId" CssClass="span-3 last" runat="server" Text="* MetadataType Id:" />
        <ektronUI:TextField ID="uxMetadataId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxIsRequiredLabel" AssociatedControlID="uxIsRequired" CssClass="span-3 last" runat="server" Text=" Is Required:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxIsRequired" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Assign Metadata"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3 last" 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;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long folderId = long.Parse(uxFolderId.Text);
            long metadataTypeId = long.Parse(uxMetadataId.Text);

            FolderManager folderManager = new FolderManager();
            folderManager.AssignMetadata(folderId, metadataTypeId,uxIsRequired.Checked);

            MessageUtilities.UpdateMessage(uxMessage,  "Metadata Type assigned to the folder", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete. Deletes a folder.

Delete

Delete(System.Int64)

Deletes a folder from the CMS.

Authenticated users

CMS Administrators

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

Fields

*=Required

* ID

Parameters

folderId. The ID of the folder to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFolderIdLabel" AssociatedControlID="uxFolderId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long folderID = long.Parse(uxFolderId.Text);
            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderID);
            if (folderData != null)
            {
                folderManager.Delete(folderID);
                MessageUtilities.UpdateMessage(uxMessage, "Folder with Id " + uxFolderId.Text + " deleted", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Folder with Id " + uxFolderId.Text + " is Invalid", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DisableTaxonomy. Disables the supplied taxonomy to be used on content in the folder.

DisableTaxonomy

DisableTaxonomy(System.Int64,System.Int64)

Disables the supplied taxonomy to be used on content in the folder.

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

Parameters

folderId. Folder ID to which taxonomies are permitted.
taxonomyId. Taxonomy ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="Label1" AssociatedControlID="uxFolderId" CssClass="span-3 last"
            runat="server" Text="* Folder Id:" />
        <ektronUI:TextField ID="TextField1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="Label2" AssociatedControlID="uxTaxonomyId"
            CssClass="span-3 last" runat="server" Text="* Taxonomy Id" />
        <ektronUI:TextField ID="TextField2" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="Label3" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="Button1" runat="server" OnClick="uxSubmit_Click" Text="Assign Taxonomy"></ektronUI:Button>
        <ektronUI:Label ID="Label4" CssClass="span-3 last" 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.Organization;
using Ektron.Cms.Framework.Content;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long folderId = long.Parse(uxFolderId.Text);
            long taxonomyId;

            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderId);
            if (folderData != null)
            {
				taxonomyId = Convert.ToInt64(uxTaxonomyId.Text);
				folderManager.DisableTaxonomy(folderId, taxonomyId);
                uxMessage.Text = "Taxonomy ID's is not longer allowed with the folder Id  " + folderId;
            }
            else
            {
                uxStatus.Visible = true;
                uxStatus.Text = "Please Enter Valid FolderID.";
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            uxMessage.Text = ex.Message;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

EnableTaxonomy. Enables these taxonomies to be assigned to content items in the supplied folder.

EnableTaxonomy

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

Enables these taxonomies to be assigned to content items in the supplied folder.

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
* Taxonomy ID List (comma separated)

Parameters

folderId. Folder ID to which taxonomies are permitted.
taxonomyIdList. List of taxonomy IDs.

.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">
        <ektronUI:Label ID="uxTaxonomyIdListLabel" AssociatedControlID="uxTaxonomyIdList" CssClass="span-3 last"
            runat="server" Text="* Taxonomy Id List: (Comma Separated TaxonomyIds)" />
        <ektronUI:TextField ID="uxTaxonomyIdList" 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="Assign Taxonomy"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3 last" 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;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long folderId = long.Parse(uxFolderId.Text);
            long taxonomyId;
            List<long> taxonomyIdList = new List<long>();

            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderId);
            if (folderData != null)
            {
                foreach (string strId in uxTaxonomyIdList.Text.Split(new char[] { ',' }))
                {
                    taxonomyId = Convert.ToInt64(strId);

                    TaxonomyManager taxonomyManager = new TaxonomyManager();
                    TaxonomyData taxonomyData = taxonomyManager.GetItem(taxonomyId);
                    //Check Whether Entered  TaxonomyId is Valid or Not.
                    if (taxonomyData != null)
                    {
                        taxonomyIdList.Add(taxonomyId);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        uxStatus.Text = "Please Enter Valid TaxonomyId.";
                        return;
                    }
                }
                folderManager.EnableTaxonomy(folderId, taxonomyIdList);
                uxMessage.Text = "Taxonomy ID's assigned to folder with Id  " + folderId;
            }
            else
            {
                uxStatus.Visible = true;
                uxStatus.Text = "Please Enter Valid FolderID.";
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            uxMessage.Text = ex.Message;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetAssignedTaxonomy. Retrieves a list of Taxonomy data that is assigned to a folder.

GetAssignedTaxonomy

GetAssignedTaxonomy(System.Int64)

Retrieves a list of Taxonomy data that is assigned to a folder.

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

Parameters

folderId. Folder ID for which to retrieve taxonomy data.

Returns

List of TaxonomyData.

.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" 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="GetAssigned Taxonomy"></ektronUI:Button>
            <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3 last" runat="server" Text="* - Required" />
        </li>
    </ol>
        
    <ol class="formFields">
        <li class="clearfix">
            <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
        </li>
        <asp:ListView ID="uxTaxonomylistView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
            <EmptyDataTemplate >There are No Taxonomy's assigned to Folder.</EmptyDataTemplate>
        <LayoutTemplate>
            <table class="devsite-api-method">
                <thead>
                    <tr>
                        <th>
                            TaxonomyId
                        </th>
                        <th>
                            TaxonomyName
                        </th>
                        <th>
                            TaxonomyPath
                        </th>
                    </tr>
                </thead>
                <tbody>
                    <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
                </tbody>
            </table>
        </LayoutTemplate>
        <ItemTemplate>
            <tr>
                <td class="devsite-method">
                    <%# Eval("TaxonomyId")%>
                </td>
                <td class="devsite-method">
                    <%# Eval("TaxonomyName")%>
                </td>
                <td class="devsite-method">
                    <%# Eval("TaxonomyPath")%>
                </td>
            </tr>
        </ItemTemplate>
    </asp:ListView>
</ol>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

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

            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderId);
            if (folderData != null)
            {
                List<TaxonomyBaseData> taxonomyIds = folderManager.GetAssignedTaxonomy(folderId);
                MessageUtilities.UpdateMessage(uxMessage,  "Taxonomy's assigned to folder with Id  " + folderId + " are below.", Message.DisplayModes.Success);

                uxTaxonomylistView.Visible = true;
                uxTaxonomylistView.DataSource = taxonomyIds;
                uxTaxonomylistView.DataBind();
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid FolderID.", Message.DisplayModes.Error);
                return;
            }

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

GetItem. Retrieves the properties of a specific FolderData Data object.

GetItem

GetItem(Ektron.Cms.FolderData)

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

* ID
* Recursive

Parameters

folderId. The ID of the folder to retrieve.
returnChildProperties. Indicates whether child properties are returned.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFolderIdLabel" AssociatedControlID="uxFolderId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
            <ektronUI:Label ID="uxRecursiveLabel" AssociatedControlID="uxRecursive" CssClass="span-3 last"
                runat="server" Text="* Recursive :" />
            <asp:DropDownList ID="uxRecursive" runat="server">
                <asp:ListItem>false</asp:ListItem>
                <asp:ListItem>true</asp:ListItem>
            </asp:DropDownList>
    </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="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTemplate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTotalContent" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPrivateContent" runat="server"></asp:Literal>
    </li>
</ol>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long folderID = long.Parse(uxFolderId.Text);
            bool recursive = Convert.ToBoolean(uxRecursive.SelectedItem.ToString());
            FolderManager folderManager = new FolderManager();

            FolderData folderData = folderManager.GetItem(folderID, recursive);

            if (folderData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for folder with ID " + folderData.Id.ToString() + " are below", Message.DisplayModes.Success);

                uxName.Text = "Name : " + folderData.Name ;
                uxTemplate.Text = "Template : " + folderData.TemplateFileName;
                uxDescription.Text = "Description :" + folderData.Description;
                uxPrivateContent.Text = "Private Content :" + folderData.PrivateContent.ToString();
                uxTotalContent.Text = "Total Content :" + folderData.TotalContent.ToString();
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Folder does not exist. ", Message.DisplayModes.Error);
                return;               
            }

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

GetList. Retrieves lists of objects.

GetList

GetList(Ektron.Cms.FolderCriteria)

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

Folder Property
* Object Value

Parameters

criteria. FolderCriteria used to retrieve folders.

Returns

List of retrieved FolderData items.

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="uxFolderPropertyLabel" AssociatedControlID="uxFolderProperty" CssClass="span-4 last" runat="server" Text="Folder Property:" />
        <asp:DropDownList ID="uxFolderProperty" runat="server">
            <asp:ListItem>Folder Id</asp:ListItem>
            <asp:ListItem>Folder Name</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* Object Value:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </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="uxFolderlistView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Folder Name
                    </th>
                    <th>
                        Folder Id
                    </th>
                    <th>
                        Folder Path
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("NameWithPath")%>
            </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.Organization;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

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

            FolderCriteria criteria = new FolderCriteria();
            if (uxFolderProperty.SelectedItem.Text == "Folder Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(FolderProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(FolderProperty.FolderName , CriteriaFilterOperator.Contains, Objectvalue);
            }

            FolderManager folderManager = new FolderManager();
            List<FolderData> folderList = folderManager.GetList(criteria);

            uxFolderlistView.Visible = true;
            uxFolderlistView.DataSource = folderList;
            uxFolderlistView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Linktaxonomy. Links the taxonomy to a folder.

LinkTaxonomy

LinkTaxonomy(System.Int64,System.Int64)

Links the taxonomy to a folder.

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

Parameters

criteria. FolderCriteria used to retrieve folders.

Returns

List of retrieved FolderData items.

.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">
        <ektronUI:Label ID="uxTaxonomyIdLabel" AssociatedControlID="uxTaxonomyId" CssClass="span-3 last"
            runat="server" Text="* Taxonomy Id" />
        <ektronUI:TextField ID="uxTaxonomyId" 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="Assign Taxonomy"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3 last" 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;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
		try
        {
            var folderId = long.Parse(uxFolderId.Text);
			var taxonomyId = long.Parse(uxTaxonomyId.Text);

            var folderManager = new FolderManager
                                	{
                                		ContentLanguage = 1033
                                	};
        	var folderData = folderManager.GetItem(folderId);
			var taxonomyManager = new TaxonomyManager();
			var taxonomyData = taxonomyManager.GetItem(taxonomyId);

        	if (folderData == null)
            {
				uxStatus.Visible = true;
				uxStatus.Text = "Please Enter Valid FolderID.";
				return;
            }

			if (taxonomyData == null)
			{
				uxStatus.Visible = true;
				uxStatus.Text = "Please Enter Valid TaxonomyID.";
				return;
			}

			folderManager.LinkTaxonomy(folderId, taxonomyId);

            uxPageMultiView.SetActiveView(uxViewMessage);
        	uxMessage.Text = String.Format("Folder with Id {0} has been linked to taxonomy with id {1}", folderId,
        	                               taxonomyId);
        }
        catch (Exception ex)
        {
            uxMessage.Text = ex.Message;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

UnallowTaxonomy. Disallows a taxonomy for a folder.

UnallowTaxonomy

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

Disallows a taxonomy for a folder.

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
* Taxonomy ID List

Parameters

folderId. The folder ID.
taxonomyId. The taxonomy ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="Label1" AssociatedControlID="uxFolderId" CssClass="span-3 last"
            runat="server" Text="* Folder Id:" />
        <ektronUI:TextField ID="TextField1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="Label2" AssociatedControlID="uxTaxonomyId"
            CssClass="span-3 last" runat="server" Text="* Taxonomy Id" />
        <ektronUI:TextField ID="TextField2" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="Label3" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="Button1" runat="server" OnClick="uxSubmit_Click" Text="Assign Taxonomy"></ektronUI:Button>
        <ektronUI:Label ID="Label4" CssClass="span-3 last" 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;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long folderId = long.Parse(uxFolderId.Text);
            long taxonomyId;

            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderId);
            if (folderData != null)
            {
				taxonomyId = Convert.ToInt64(uxTaxonomyId.Text);
				folderManager.UnallowTaxonomy(folderId, taxonomyId);
                uxMessage.Text = "Taxonomy ID's is not longer allowed with the folder Id  " + folderId;
            }
            else
            {
                uxStatus.Visible = true;
                uxStatus.Text = "Please Enter Valid FolderID.";
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            uxMessage.Text = ex.Message;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

UnassignMetadata. Unassign a metadata from a folder.

UnassignMetadata

UnassignMetadata(System.Int64,System.Int64)

Unassign a metadata from a folder.

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
* Metadata Type ID

Parameters

folderId. The ID of the folder.
metadataTypeId. The ID of the metadata type.

.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" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMetadataIdLabel" AssociatedControlID="uxMetadataId" CssClass="span-3 last" runat="server" Text="* MetadataType Id:" />
        <ektronUI:TextField ID="uxMetadataId" 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="Unassign Metadata"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3 last" 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;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long folderId = long.Parse(uxFolderId.Text);
            long metadataTypeId = long.Parse(uxMetadataId.Text);

            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderId);

            if (folderData != null)
            {
                MetadataTypeManager metadataTypeManager = new MetadataTypeManager();
                ContentMetaData metaData = metadataTypeManager.GetItem(metadataTypeId);

                if (metaData != null)
                {
                    folderManager.UnassignMetadata(folderId, metadataTypeId);
                    MessageUtilities.UpdateMessage(uxMessage, "Metadata Type unassigned from the folder", Message.DisplayModes.Success);
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Metadata type does not exist. ", Message.DisplayModes.Error);
                    return;
                }

            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Folder does not exist. ", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update. Updates an existing folder.

Update

Update(Ektron.Cms.MenuBaseData)

Updates an existing folder 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

* Folder ID
Name
Publish as PDF
Style Sheet
Description

Parameters

folderData. The FolderData object to update.

Returns

Updated FolderData object.

Remarks

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

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

.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-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-3 last" runat="server" Text="  Name:" />
        <ektronUI:TextField  ID="uxName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxPublishPdfLabel" AssociatedControlID="uxPublishPdf" CssClass="span-3 last" runat="server" Text=" Publish As PDF:" />
        <ektronUI:Button  ID="uxPublishPdf" DisplayMode="Checkbox" Text=""  CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStyleSheetLabel" AssociatedControlID="uxStyleSheet" CssClass="span-3 last" runat="server" Text=" Style Sheet:" />
        <ektronUI:TextField ID="uxStyleSheet" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-3 last" runat="server" Text="Description:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxDescription" 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;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long folderID = long.Parse(uxFolderId.Text);
            FolderManager folderManager = new FolderManager();
            FolderData folderData = folderManager.GetItem(folderID);
            if (folderData != null)
            {
                folderData.Name = (uxName.Text != string.Empty ? uxName.Text : folderData.Name);
                folderData.StyleSheet = (uxStyleSheet.Text != string.Empty ? uxStyleSheet.Text : folderData.StyleSheet);
                folderData.Description = (uxDescription.Text != string.Empty ? uxDescription.Text : folderData.Description);
                folderData.PublishPdfActive = uxPublishPdf.Checked;
                folderData.PublishPdfEnabled = uxPublishPdf.Checked;
                folderManager.Update(folderData);
                MessageUtilities.UpdateMessage(uxMessage,  "Folder with Id " + folderData.Id + " updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Folder does not exists.", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Data classes

Data Classes

FolderData

Namespace

Ektron.Cms

Properties

AliasRequired
```
public bool AliasRequired { set; get; }
```
ApprovalMethod
```
public int ApprovalMethod { set; get; }
```

CategoryRequired

public bool CategoryRequired { set; get; }

ChildFolders

public Ektron.Cms.Controls.CmsWebService.FolderData[] ChildFolders { set; get; }

Description
```
public string Description { set; get; }
```

DomainProduction

public string DomainProduction { set; get; }

DomainStaging

public string DomainStaging { set; get; }

FlagInheritedFrom

public long FlagInheritedFrom { set; get; }

FolderFlags

public Ektron.Cms.Controls.CmsWebService.FlagDefData[] FolderFlags { set; get; }

FolderMetadata

public Ektron.Cms.Controls.CmsWebService.ContentMetaData[] FolderMetadata { set; get; }

FolderTemplates

public Ektron.Cms.Controls.CmsWebService.TemplateData[] FolderTemplates { set; get; }

FolderType
```
public int FolderType { set; get; }
```
HasChildren
```
public bool HasChildren { set; get; }
```

IsAliasInherited

public bool IsAliasInherited { set; get; }

IsCommunityFolder

public bool IsCommunityFolder { set; get; }

IsDomainFolder

public bool IsDomainFolder { set; get; }

IsFlagInherited

public bool IsFlagInherited { set; get; }

IsMetaInherited

public bool IsMetaInherited { set; get; }

IsPermissionInherited

public bool IsPermissionsInherited { set; get; }

IsSitemapInherited

public bool IsSitemapInherited { set; get; }

IsStyleSheetInherited

public bool IsStyleSheetInherited { set; get; }

IsTaxonomyInherited

public bool IsTaxonomyInherited { set; get; }

IsTemplateInherited

public bool IsTemplateInherited { set; get; }

IsXmlInherited

public bool IsXmlInherited { set; get; }

Name
```
public string Name { set; get; }
```

NameWithPath

public string NameWithPath { set; get; }

ParentId
```
public long ParentId { set; get; }
```

Permissions

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

PrivateContent

public bool PrivateContent { set; get; }

PublishHtmlActive

public bool PublishHtmlActive { set; get; }

PublishPdfActive

public bool PublishPdfActive { set; get; }

PublishPdfEnabled

public bool PublishPdfEnabled { set; get; }

ReplicationMethod

public int ReplicationMethod { set; get; }

SitemapPath

public Ektron.Cms.Controls.CmsWebService.SitemapPath[] SitemapPath { set; get; }

StyleSheet
```
public string StyleSheet { set; get; }
```

TemplateFileName

public string TemplateFileName { set; get; }

TemplateId
```
public long TemplateId { set; get; }
```
TotalContent
```
public int TotalContent { set; get; }
```

XmlConfiguration

public Ektron.Cms.Controls.CmsWebService.XmlConfigData[] XmlConfiguration { set; get; }

FolderManager

Namespace

Constructors

Properties

Methods

Add

Authenticated users

Fields

Parameters

Returns

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

AllowTaxonomy

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

AssignMetadata

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Delete

Authenticated users

Fields

Parameters

Remarks

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

DisableTaxonomy

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

EnableTaxonomy

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetAssignedTaxonomy

Authenticated users

Fields

Parameters

Returns

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetItem

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetList

Authenticated users

Fields

Parameters

Returns

Criteria use

Criteria objects

Constructor(property, orderbyDirection)

AddFilter(property, operator, value)

LogicalOperation Condition

List<CriteriaFilterGroup> FilterGroups

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

LinkTaxonomy

Authenticated users