CustomPropertyManager

The CustomPropertyManager class manages user-specified properties to create custom fields. See Managing Users and User Groups in the Ektron Reference for information about custom user properties.

Namespace

Ektron.Cms.Framework.Settings.CustomPropertyManager

Constructors

  • CustomPropertyManager()
  • CustomPropertyManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • CustomPropertyManagerService. Returns an instance of the business objects CustomPropertyManager service.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Messaging.UserCustomPropertyData)

Adds a UserCustomProperty, with details from the supplied UserCustomPropertyData object.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * Name
  • * Input Type
  • * Type
  • * Validation Type
  • Message

Parameters

  • UCPData

Returns

Returns the custom CmsData object added.

.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="uxInputTypeLabel" AssociatedControlID="uxInputType" CssClass="span-3 last" runat="server" Text="* Input Type:" />
        <asp:DropDownList ID="uxInputType" runat="server">
            <asp:ListItem>TextBox</asp:ListItem>
            <asp:ListItem>TextArea</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTypeLabel" AssociatedControlID="uxType" CssClass="span-3 last" runat="server" Text="* Type:" />
        <asp:DropDownList ID="uxType" runat="server">
            <asp:ListItem>String</asp:ListItem>
            <asp:ListItem>Numeric</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxValidationTypeLabel" AssociatedControlID="uxValidationType" CssClass="span-3 last" runat="server" Text="* Validation Type:" />
        <asp:DropDownList ID="uxValidationType" runat="server">
            <asp:ListItem>No Validation</asp:ListItem>
            <asp:ListItem>Cannot Be Blank</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxValMessageLabel" AssociatedControlID="uxValMessage" CssClass="span-3 last" runat="server" Text=" Message:" />
        <ektronUI:TextField  ID="uxValMessage" 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.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CustomPropertyManager customPropertyManager = new CustomPropertyManager();
           
            UserCustomPropertyData userCustomPropertyData = new UserCustomPropertyData()
            {
                  Name = uxName.Text ,
                  PropertyDisplayValueType = (uxInputType.SelectedItem.Value == "TextBox" ? Ektron.Cms.Common.EkEnumeration.ObjectPropertyDisplayTypes.TextBox : Ektron.Cms.Common.EkEnumeration.ObjectPropertyDisplayTypes.TextArea),
                  PropertyValueType = (uxType.SelectedItem.Value =="String"? Ektron.Cms.Common.EkEnumeration.ObjectPropertyValueTypes.String : Ektron.Cms.Common.EkEnumeration.ObjectPropertyValueTypes.Numeric),
                  PropertyValidationMessage = uxValMessage.Text ,
                  PropertyValidationType = (uxValidationType.SelectedItem.Value == "No Validation" ? 0 : 1)
            };

            customPropertyManager.Add(userCustomPropertyData);

            MessageUtilities.UpdateMessage(uxMessage, "User custom property added with Id " + userCustomPropertyData.Id, Message.DisplayModes.Success);

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

Delete

Delete(System.Int64)

Deletes a UserCustomPropertyData object 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

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomUserPropertyIdLabel" AssociatedControlID="uxCustomUserPropertyId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxCustomUserPropertyId" 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-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

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

            CustomPropertyManager customPropertyManager = new CustomPropertyManager();
            UserCustomPropertyData userCustomPropertyData = customPropertyManager.GetItem(customUserPropertyId);

            if (userCustomPropertyData != null)
            {
                customPropertyManager.Delete(customUserPropertyId);
                MessageUtilities.UpdateMessage(uxMessage, "Custom property deleted.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Custom property does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.UserCustomPropertyData)

Retrieves the properties of a specific UserCustomPropertyData object.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * ID

Parameters

  • id. ID of the UserCustomProperty to get.

Returns

UserCustomProperty details in a UserCustomPropertyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserCustomPropertyIdLabel" AssociatedControlID="uxUserCustomPropertyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxUserCustomPropertyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayValueType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxValueType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxValidationType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLanguageId" runat="server"></asp:Literal> 
    </li>
</ol>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

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

            CustomPropertyManager customPropertyManager = new CustomPropertyManager();
            UserCustomPropertyData userCustomPropertyData = customPropertyManager.GetItem(userCustomPropertyId);

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

                uxName.Text = "Name : " + userCustomPropertyData.Name;
                uxDisplayValueType.Text = "Display Value Type : " + userCustomPropertyData.PropertyDisplayValueType;
                uxValueType.Text = "Value Type : " + userCustomPropertyData.PropertyValueType;
                uxValidationType.Text = "Validation Type : " + userCustomPropertyData.PropertyValidationType;
                uxLanguageId.Text = "Language Id : " + userCustomPropertyData.ContentLanguage;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "User custom property does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(CustomPropertyCriteria)

Retrieves lists of objects.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • User Customer Property
  • * Object Value

Parameters

Returns

A list of UserCustomPropertyData objects.

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="uxUserCustomPropertyLabel" AssociatedControlID="uxUserCustomProperty" CssClass="span-6 last" runat="server" Text="UserCustomProperty:" />
        <asp:DropDownList ID="uxUserCustomProperty" 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-6 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxUserCustomPropertyDataListView" 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>
                        Name
                    </th>
                    <th>
                        Property Display Value Type
                    </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("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("PropertyDisplayValueType")%>
            </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.User;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

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

            CustomPropertyCriteria criteria = new CustomPropertyCriteria();
            if (uxUserCustomProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = int.Parse(uxObjectValue.Text);
                criteria.AddFilter(UserCustomProperty.Id , CriteriaFilterOperator.EqualTo  , Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(UserCustomProperty.Name, CriteriaFilterOperator.Contains, Objectvalue);
            }

            CustomPropertyManager customPropertyManager = new CustomPropertyManager();
            List<UserCustomPropertyData> userCustomPropertyDataList = customPropertyManager.GetList(criteria);

            uxUserCustomPropertyDataListView.Visible = true;
            uxUserCustomPropertyDataListView.DataSource = userCustomPropertyDataList;
            uxUserCustomPropertyDataListView.DataBind();

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

Update

Update(Ektron.Cms.UserCustomPropertyData)

Updates a UserCustomProperty, with details from the supplied UserCustomPropertyData object.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * ID
  • Name
  • Input Type
  • Validation Type
  • Message

Parameters

  • UCPData

Returns

Returns the custom CmsData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserCustomPropertyIdLabel" AssociatedControlID="uxUserCustomPropertyId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxUserCustomPropertyId" 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="uxInputTypeLabel" AssociatedControlID="uxInputType" CssClass="span-3 last" runat="server" Text=" Input Type:" />
        <asp:DropDownList ID="uxInputType" runat="server">
            <asp:ListItem>TextBox</asp:ListItem>
            <asp:ListItem>TextArea</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxValidationTypeLabel" AssociatedControlID="uxValidationType" CssClass="span-3 last" runat="server" Text=" Validation Type:" />
        <asp:DropDownList ID="uxValidationType" runat="server">
            <asp:ListItem>No Validation</asp:ListItem>
            <asp:ListItem>Cannot Be Blank</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxValMessageLabel" AssociatedControlID="uxValMessage" CssClass="span-3 last" runat="server" Text=" Message:" />
        <ektronUI:TextField  ID="uxValMessage" 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.Settings;

.aspx.cs code-behind method

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

            CustomPropertyManager customPropertyManager = new CustomPropertyManager();
            UserCustomPropertyData userCustomPropertyData = customPropertyManager.GetItem(userCustomPropertyId);

            if (userCustomPropertyData != null)
            {
                userCustomPropertyData.Name = (uxName.Text != string.Empty ? uxName.Text : userCustomPropertyData.Name);
                userCustomPropertyData.PropertyDisplayValueType = (uxInputType.SelectedItem.Value == "TextBox" ? Ektron.Cms.Common.EkEnumeration.ObjectPropertyDisplayTypes.TextBox : Ektron.Cms.Common.EkEnumeration.ObjectPropertyDisplayTypes.TextArea);
                userCustomPropertyData.PropertyValidationMessage = (uxValMessage.Text != string.Empty ? uxValMessage.Text :   userCustomPropertyData.PropertyValidationMessage);
                userCustomPropertyData.PropertyValidationType = (uxValidationType.SelectedItem.Value == "No Validation" ? 0 : 1);
                customPropertyManager.Update(userCustomPropertyData);

                MessageUtilities.UpdateMessage(uxMessage, "User custom property updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "User custom property 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

CustomPropertyCriteria

Namespace

Ektron.Cms.User

Constructors

  • CustomPropertyCriteria()
    public CustomPropertyCriteria()
  • CustomPropertyCriteria(Ektron.Cms.Framework.Settings.CustomPropertyProperty, EkEnumeration.OrderByDirection)
    public CustomPropertyCriteria(Ektron.Cms.Framework.Settings.CustomPropertyProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the CustomPropertyProperty are:

    • Id

UserCustomPropertyData

Namespace

Ektron.Cms

Properties

  • ContentLanguage
    public int ContentLanguage { set; get; }
  • ID
    public long ID { set; get; }
  • Name
    public string Name { set; get; }
  • ObjectType
    public EkEnumeration.CMSObjectTypes ObjectType { get; }
  • PropertyDisplayValueType
    public EkEnumeration.ObjectPropertyDisplayTypes
  PropertyDisplayValueType { set; get; }
  • PropertyValidationJSCall
    public string PropertyValidationJSCall { set; get; }
  • PropertyValidationMaxVal
    public object PropertyValidationMaxVal { set; get; }
  • PropertyValidationMessage
    public string PropertyValidationMessage { set; get; }
  • PropertyValidationMinVal
    public object PropertyValidationMinVal { set; get; }
  • PropertyValidationSelectList
    public string PropertyValidationSelectList { set; get; }
  • PropertyValidationType
    public int PropertyValidationType { set; get; }
  • PropertyValueType
    public EkEnumeration.ObjectPropertyValueTypes
  PropertyValueType { set; get; }
  • Required
    public bool Required { set; get; }