Class ProductListViewModelSettings

Namespace

Dynamicweb.Ecommerce.ProductCatalog

Assembly

Dynamicweb.Ecommerce.dll

public class ProductListViewModelSettings : ViewSettingsBaseCurrencyBase<ProductListViewModel>

Inheritance

object

ViewSettingsBase<ProductListViewModel>

ViewSettingsLanguageBase<ProductListViewModel>

ViewSettingsBaseCurrencyBase<ProductListViewModel>

ProductListViewModelSettings

Inherited Members

ViewSettingsBaseCurrencyBase<ProductListViewModel>.UserId

ViewSettingsBaseCurrencyBase<ProductListViewModel>.ShowPricesWithVat

ViewSettingsBaseCurrencyBase<ProductListViewModel>.ReverseChargeForVat

ViewSettingsBaseCurrencyBase<ProductListViewModel>.StockLocationId

ViewSettingsBaseCurrencyBase<ProductListViewModel>.CurrencyCode

ViewSettingsBaseCurrencyBase<ProductListViewModel>.CountryCode

ViewSettingsBaseCurrencyBase<ProductListViewModel>.ShopId

ViewSettingsBaseCurrencyBase<ProductListViewModel>.Time

ViewSettingsBaseCurrencyBase<ProductListViewModel>.EnsureContext<TS>(ViewSettingsBase<TS>)

ViewSettingsLanguageBase<ProductListViewModel>.LanguageId

ViewSettingsBase<ProductListViewModel>.FilledProperties

ViewSettingsBase<ProductListViewModel>.AddProperties(params string[])

ViewSettingsBase<ProductListViewModel>.AddProperties(ICollection<string>)

ViewSettingsBase<ProductListViewModel>.RemoveProperties(params string[])

ViewSettingsBase<ProductListViewModel>.FillAllValidProperties()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProductListViewModelSettings()

Empty constructor for webapi

public ProductListViewModelSettings()

ProductListViewModelSettings(string, string, string, string, int)

Creates a configuration for constructing product view models.

public ProductListViewModelSettings(string languageId, string currencyCode, string countryCode, string shopId, int userId)

Parameters

languageId string

Id of language

currencyCode string

CurrencyCode

countryCode string

Country code2

shopId string

Shop ID.

userId int

User id

ProductListViewModelSettings(string, string, string, string, int, bool, DateTime?, long)

Creates a configuration for constructing product viewmodels.

public ProductListViewModelSettings(string languageId, string currencyCode, string countryCode, string shopId, int userId, bool showPricesWithVat, DateTime? time, long stockLocationId)

Parameters

languageId string

Id of language

currencyCode string

CurrencyCode

countryCode string

Country code2

shopId string

Shop ID.

userId int

User id

showPricesWithVat bool

Show prices with VAT

time DateTime?

Ordertime for price calculation

stockLocationId long

Stocklocation for price

ProductListViewModelSettings(string, string, string, string, int, bool, DateTime?, long, bool)

Creates a configuration for constructing product viewmodels.

public ProductListViewModelSettings(string languageId, string currencyCode, string countryCode, string shopId, int userId, bool showPricesWithVat, DateTime? time, long stockLocationId, bool reverseChargeForVat)

Parameters

languageId string

Id of language

currencyCode string

CurrencyCode

countryCode string

Country code2

shopId string

Shop ID.

userId int

User id

showPricesWithVat bool

Show prices with VAT

time DateTime?

Ordertime for price calculation

stockLocationId long

Stocklocation for price

reverseChargeForVat bool

Reverse charge for Vat

Properties

CurrentPage

Defines which page of the paginated result set to return. Eg. PageSize of 10 and CurrentPage of 2 in a resultset of 30, returns result item #11 to #20.

public int CurrentPage { get; set; }

Property Value

int

FacetGroupSettings

Configures how the facet groups view should be configured, if they are used to fill the list.

public FacetGroupViewModelSettings FacetGroupSettings { get; set; }

Property Value

FacetGroupViewModelSettings

configurationOfFacetGroups

FieldToSpellCheck

Defines which field use to spell check

public string FieldToSpellCheck { get; set; }

Property Value

string

GroupSettings

Configures how the price view should be configured, if price is filled.

public ProductGroupViewModelSettings GroupSettings { get; set; }

Property Value

ProductGroupViewModelSettings

configurationOfPriceViewModel

MediaSettings

Configures how multimedia content is handled.

public MediaViewModelSettings MediaSettings { get; set; }

Property Value

MediaViewModelSettings

mediaSettings

PageSize

Limits the number of products in the returned view

public int PageSize { get; set; }

Property Value

int

ParameterToSpellCheck

Defines which query parameter use to spell check

public string ParameterToSpellCheck { get; set; }

Property Value

string

Parameters

Additional parameters to be used for the creation of the product list.

public Dictionary<string, string> Parameters { get; set; }

Property Value

Dictionary<string, string>

parameters

ProductSettings

Configures how the price view should be configured, if price is filled.

public ProductViewModelSettings ProductSettings { get; set; }

Property Value

ProductViewModelSettings

configurationOfPriceViewModel

Methods

EnsureFilledPropertiesExist()

If filled properties are empty, this method will add ALL valid property names.

public override void EnsureFilledPropertiesExist()