ProductHelper Class

Provides advanced manipulation with products and product options.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<ProductHelper>
        CMS.Ecommerce.ProductHelper

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 8.2.23

Syntax

public class ProductHelper : AbstractHelper<ProductHelper>

The ProductHelper type exposes the following members.

Constructors

	Name	Description
Public method	ProductHelper

Methods

	Name	Description
Public method Static member	AllowAllOptions	Makes all options from option category specified by optionCategoryId parameter allowed for product given by skuId parameter.
Protected method	AllowAllOptionsInternal	Makes all options from option category specified by optionCategoryId parameter allowed for product given by skuId parameter.
Public method Static member	AllowOptions	Allows product options from option category to product. Individual options are checked whether they belong to given category.
Protected method	AllowOptionsInternal	Allows product options from option category to product. Individual options are checked whether they belong to given category.
Public method Static member	IsOptionAllowed	Returns true if option specified by optionId is allowed for given product.
Protected method	IsOptionAllowedInternal	Returns true if option specified by optionId is allowed for given product.
Protected method	RemoveAllowedOptionsInternal	Removes all allowed options from given option category from given product.
Public method Static member	RemoveOptionCategory	Removes option category from product. Allowed options are removed too.
Protected method	RemoveOptionCategoryInternal	Removes option category from product. Allowed options are removed too.
Public method Static member	RemoveOptions	Remove product options from option category from product. Individual options are checked whether they belong to given category.
Protected method	RemoveOptionsInternal	Remove product options from option category from product. Individual options are checked whether they belong to given category.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)