CurrencyManager

The class manages commerce currencies in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.CurrencyManager

Constructors

  • CurrencyManager()
  • CurrencyManager(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.
  • 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.Commerce.CurrencyData)

Adds a new currency to the CMS. The Currency.Id property is populated with the new Currency's 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

  • * ID
  • * Alpha ISO Code
  • Name
  • Culture Code
  • Enabled

Parameters

  • currencyData. CurrencyData object to be added.

Returns

Returns the CurrencyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIDLabel" AssociatedControlID="uxCurrencyId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyNameLabel" AssociatedControlID="uxCurrencyName" CssClass="span-3 last" runat="server" Text=" Name:" />
        <ektronUI:TextField  ID="uxCurrencyName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyAlbhaLabel" AssociatedControlID="uxCurrencyAlphaCode" CssClass="span-3 last" runat="server" Text="* AlphaIsoCode:" />
        <ektronUI:TextField  ID="uxCurrencyAlphaCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyCultureCodeLabel" AssociatedControlID="uxCurrencyCultureCode" CssClass="span-3 last" runat="server" Text=" Culture Code:" />
        <ektronUI:TextField  ID="uxCurrencyCultureCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyEnabledLabel" AssociatedControlID="uxCurrencyEnabled" CssClass="span-3 last" runat="server" Text=" Enabled:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxCurrencyEnabled" CssClass="span-6" 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-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.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CurrencyManager currencyManager = new CurrencyManager();
            bool isEnabled = false;
            if (uxCurrencyEnabled.Checked)
            {
                isEnabled = true;
            }
            CurrencyData currencyData = new CurrencyData()
            {
                AlphaIsoCode = uxCurrencyAlphaCode.Text,
                CultureCode = uxCurrencyCultureCode.Text, 
                Id = int.Parse(uxCurrencyId.Text),
                Name = uxCurrencyName.Text,
                Enabled = isEnabled
            };

            currencyData = currencyManager.Add(currencyData);
            if (currencyData.Id > 0)
            {                
                MessageUtilities.UpdateMessage(uxMessage,  "Currency Added with Id " + currencyData.Id , Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Currency adding process is failed", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

CanDelete

CanDelete(System.Int32)

Checks to see if a currency can be deleted.

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

  • * Currency ID

Parameters

  • currencyData. Currency data object to be added.

Returns

CurrencyData object.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIdLabel" AssociatedControlID="uxCurrencyId" CssClass="span-3 last" runat="server" Text="* Currency Id:" />
        <ektronUI:TextField  ID="uxCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="CanDelete"></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 Microsoft.Practices.EnterpriseLibrary.Validation; 
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CurrencyManager currencyManager = new CurrencyManager();
            int CurrencyId = int.Parse(uxCurrencyId.Text);


            bool delete = currencyManager.CanDelete(CurrencyId);
            if (delete)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Currency " + CurrencyId + " can be deleted", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Currency " + CurrencyId + " cannot be deleted",  Message.DisplayModes.Information);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Delete

Delete(System.Int32)

Deletes a currency 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

  • * Currency ID

Parameters

  • currencyId. ID of currency to be deleted.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIdLabel" AssociatedControlID="uxCurrencyId" CssClass="span-3 last" runat="server" Text="* Currency Id:" />
        <ektronUI:TextField  ID="uxCurrencyId" 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;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CurrencyManager currencyManager = new CurrencyManager();
            int currencyId = int.Parse(uxCurrencyId.Text);

            currencyManager.Delete(currencyId);
            MessageUtilities.UpdateMessage(uxMessage, "Currency " + currencyId + " is deleted", Message.DisplayModes.Success );

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

GetActiveCurrencyList

GetActiveCurrencyList()

Gets active currency List

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.

Returns

List of active currencies.

.aspx code snippet

<ol class="formFields">   
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Active Currency"></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="uxCouponEntryListView" 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>
                        AlphaIsoCode
                    </th>
                    <th>
                        Culture Code
                    </th>
                    <th>
                        Enabled
                    </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("AlphaIsoCode")%>
            </td>
            <td class="devsite-method">
                <%# Eval("CultureCode")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Enabled")%>
            </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.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {           
            CurrencyManager currencyManger = new CurrencyManager();
            List<CurrencyData> currencyDataList = currencyManger.GetActiveCurrencyList();

            uxCurrencyListView.Visible = true;
            uxCurrencyListView.DataSource = currencyDataList;
            uxCurrencyListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetCurrentCurrency

GetCurrentCurrency()

Gets current currency.

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.

Returns

Current CurrencyData object.

.aspx code snippet

<ol class="formFields">   
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Current Currency"></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="uxAlpha" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCultureCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEnabled" 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.User;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CurrencyManager currencyManager = new CurrencyManager();
            CurrencyData currencyData = currencyManager.GetCurrentCurrency();

            if (currencyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Current  Currency with ID " + currencyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxAlpha.Text = "AlphaIsoCode : " + currencyData.AlphaIsoCode;
                uxCultureCode.Text = "Culture Code : " + currencyData.CultureCode;
                uxName.Text = "Name : " + currencyData.Name;
                uxEnabled.Text = "Enabled : " + currencyData.Enabled;
            }            
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetDefaultCurrency

GetDefaultCurrency()

Gets default currency.

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.

Returns

Default CurrencyData object.

.aspx code snippet

<ol class="formFields">   
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Default Currency"></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="uxAlpha" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCultureCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEnabled" 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.User;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CurrencyManager currencyManager = new CurrencyManager();
            CurrencyData currencyData = currencyManager.GetDefaultCurrency();

            if (currencyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Default  Currency with ID " + currencyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxAlpha.Text = "AlphaIsoCode : " + currencyData.AlphaIsoCode;
                uxCultureCode.Text = "Culture Code : " + currencyData.CultureCode;
                uxName.Text = "Name : " + currencyData.Name;
                uxEnabled.Text = "Enabled : " + currencyData.Enabled;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetItem

GetItem(System.Int32)

Retrieves a currency by currency 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

  • * Currency ID

Parameters

currencyId. ID of currency to be retrieved.

Returns

CurrencyData object.

.aspx code snippet

<ol class="formFields">
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIDLabel" AssociatedControlID="uxCurrencyId" CssClass="span-3 last" runat="server" Text="* Currency Id :" />
        <ektronUI:TextField ID="uxCurrencyId" 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="uxAlpha" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCultureCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEnabled" 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.User;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CurrencyManager currencyManager = new CurrencyManager();
            int CurrencyId=int.Parse(uxCurrencyId.Text);
            CurrencyData currencyData = currencyManager.GetItem(CurrencyId);

            if (currencyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Currency with ID " + currencyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxAlpha.Text = "AlphaIsoCode : " + currencyData.AlphaIsoCode;
                uxCultureCode.Text = "Culture Code : " + currencyData.CultureCode;
                uxName.Text = "Name : " + currencyData.Name;
                uxEnabled.Text = "Enabled : " + currencyData.Enabled;                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Currency "+CurrencyId + " does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetList

GetList(Ektron.Cms.Commerce.CurrencyCriteria)

Retrieves a list of currencies.

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

  • * Object Value

Parameters

  • criteria. Criteria by which to filter currency being retrieved.

Returns

List of currencies meeting criteria filters.

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="uxCurrencyPropertyLabel" AssociatedControlID="uxCurrencyProperty" CssClass="span-4 last" runat="server" Text="Currency Property:" />
        <asp:DropDownList ID="uxCurrencyProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>AlphaIsoCode </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="1" />
    </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="uxCouponListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Name
                    </th>
                    <th>
                        AlphaIsoCode
                    </th>
                    <th>
                        Culture Code
                    </th>
                    <th>
                        Enabled
                    </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("AlphaIsoCode")%>
            </td>
            <td class="devsite-method">
                <%# Eval("CultureCode")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Enabled")%>
            </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.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            object Objectvalue;
            CurrencyCriteria criteria = new CurrencyCriteria();

            if (uxCurrencyProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = Convert.ToInt32 (uxObjectValue.Text);
                criteria.AddFilter(CurrencyProperty.Id, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxCurrencyProperty.SelectedItem.Text == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CurrencyProperty.Name, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CurrencyProperty.AlphaIsoCode , Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            CurrencyManager currencyManger = new CurrencyManager();
            List<CurrencyData> currencyList = currencyManger.GetList(criteria);

            uxCurrencyListView.Visible = true;
            uxCurrencyListView.DataSource = currencyList;
            uxCurrencyListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Update

Update(Ektron.Cms.Commerce.CurrencyData)

Updates an existing currency in 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

  • * ID
  • Name
  • * Alpha ISO Code
  • Culture Code

Parameters

  • currencyData. Currency data object to be updated.

Returns

CurrencyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIDLabel" AssociatedControlID="uxCurrencyId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField  ID="uxCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyNameLabel" AssociatedControlID="uxCurrencyName" CssClass="span-3 last" runat="server" Text=" Name:" />
        <ektronUI:TextField  ID="uxCurrencyName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyAlbhaLabel" AssociatedControlID="uxCurrencyAlphaCode" CssClass="span-3 last" runat="server" Text="* AlphaIsoCode:" />
        <ektronUI:TextField  ID="uxCurrencyAlphaCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyCultureCodeLabel" AssociatedControlID="uxCurrencyCultureCode" CssClass="span-3 last" runat="server" Text=" Culture Code:" />
        <ektronUI:TextField  ID="uxCurrencyCultureCode" CssClass="span-6" 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-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.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CurrencyManager currencyManager = new CurrencyManager();
            int currencyId=int.Parse(uxCurrencyId.Text);
            CurrencyData currencyData = currencyManager.GetItem(currencyId);
            if (currencyData != null)
            {
                currencyData.AlphaIsoCode = uxCurrencyAlphaCode.Text;
                currencyData.CultureCode = uxCurrencyCultureCode.Text;
                currencyData.Name = uxCurrencyName.Text;
                currencyData = currencyManager.Update(currencyData);
                
                MessageUtilities.UpdateMessage(uxMessage, "Currency updated with Id " + currencyData.Id, Message.DisplayModes.Success);                
            }
            uxPageMultiView.SetActiveView(uxViewMessage);


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

Data Classes

CurrencyCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • CurrencyCriteria()
    public CurrencyCriteria()
  • CurrencyCriteria(Ektron.Cms.Commerce.CurrencyProperty, EkEnumeration.OrderByDirection)
    public CurrencyCriteria(Ektron.Cms.Commerce.CurrencyProperty 
  orderByField, EkEnumeration.OrderByDirection orderByDirection)							orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the CurrencyProperty are:

    • AlphaIsoCode
    • CultureCode
    • Enabled
    • Id
    • Name

CurrencyData

Namespace

Ektron.Cms.Commerce

Properties

  • AlphaIsoCode. Gets or sets the 3 letter ISO code of the currency.
    public string AlphaIsoCode { set; get; }
  • CultureCode. Gets or sets the culture code associated with this currency. This is used for formatting currency values for this currency.
    public string CultureCode { set; get; }
  • CurrencySymbol. Read only function that gets the symbol for this currency. Example: $
    public string CurrencySymbol { get; }
  • Enabled. Gets or sets whether or not the currency is enabled for use.
    public bool Enabled { set; get; }
  • Id. Gets or sets the Id of the currency. The Id is the ISO numeric code of the currency.
    public int Id { set; get; }
  • ISOCurrencySymbol. Read only function that gets the ISO symbol for this currency. Example: USD
    public string ISOCurrencySymbol { get; }
  • Name. Gets or sets the name of the currency.
    public string Name { set; get; }