Table of Contents

Class Shop

Namespace
Dynamicweb.Ecommerce.Shops
Assembly
Dynamicweb.Ecommerce.dll

Represents the Ecommerce shop.

[Serializable]
[PermissionEntity("Shop")]
public class Shop : ICloneable, IDisplayName, IPermissionEntity, IPermissionEntityLookup
Inheritance
Shop
Implements
Inherited Members
Extension Methods

Constructors

Shop()

Initializes a new instance of the class.

public Shop()

Properties

AlternativeImagePatterns

Gets or sets the alternative patterns for images.

public List<ImagePattern> AlternativeImagePatterns { get; set; }

Property Value

List<ImagePattern>

AutoBuildIndex

Gets or sets the possibility automatically build index during shop products update.

public bool AutoBuildIndex { get; set; }

Property Value

bool
See Also

CompletionLanguages

Gets Language collection used for calculating the shop product completeness value.

public IEnumerable<Language> CompletionLanguages { get; set; }

Property Value

IEnumerable<Language>

Return Language collection

CompletionRules

Get collection of rules used for calculating the shop product completeness value.

public IEnumerable<CompletionRule> CompletionRules { get; }

Property Value

IEnumerable<CompletionRule>

Return CompletionRule collection

Remarks

To assign rules to a shop use AssignRulesToShop(Shop, IEnumerable<CompletionRule>)

Created

Gets or sets creation date.

public DateTime Created { get; set; }

Property Value

DateTime

DefaultLanguageId

Gets or sets the ID of the default language.

public string DefaultLanguageId { get; set; }

Property Value

string

DefaultPrintTemplate

Gets or sets the path for the default print template.

public string DefaultPrintTemplate { get; set; }

Property Value

string

Icon

Gets or sets the icon.

public string Icon { get; set; }

Property Value

string

Id

Gets or sets the ID of the shop.

public string Id { get; set; }

Property Value

string

ImageFolder

Gets or sets the image folder.

public string ImageFolder { get; set; }

Property Value

string

ImagePatternLarge

Gets or sets the pattern for the names of the large images.

public string ImagePatternLarge { get; set; }

Property Value

string

ImagePatternMain

Gets or sets the main product pattern.

public string ImagePatternMain { get; set; }

Property Value

string

ImagePatternMedium

Gets or sets the pattern for the names of the medium images.

public string ImagePatternMedium { get; set; }

Property Value

string

ImagePatternSmall

Gets or sets the pattern for the names of the small images.

public string ImagePatternSmall { get; set; }

Property Value

string

ImagePatternVariant

Gets or sets the variant product pattern.

public string ImagePatternVariant { get; set; }

Property Value

string

ImageSearchInSubfolders

Gets or sets the image folder.

public bool ImageSearchInSubfolders { get; set; }

Property Value

bool

IndexName

Gets or sets the index name.

public string IndexName { get; set; }

Property Value

string
See Also

IndexRepository

Gets or sets the index repository.

public string IndexRepository { get; set; }

Property Value

string
See Also

IsDefault

Gets or sets the value indicating whether shop is used as default.

public bool IsDefault { get; set; }

Property Value

bool

Name

Gets or sets the name of the shop.

public string Name { get; set; }

Property Value

string

OrderContextId

Gets or sets the ID of the order context.

public string OrderContextId { get; set; }

Property Value

string

OrderFlowId

Gets or sets the ID of the order flow.

public int OrderFlowId { get; set; }

Property Value

int

OrderLineFields

Gets order line fields collection.

public OrderLineFieldCollection OrderLineFields { get; }

Property Value

OrderLineFieldCollection

PermissionName

The permission entity identifier name supported by this implementation of IPermissionEntityLookup.

public string PermissionName { get; }

Property Value

string
See Also

ProductPrimaryPageId

Gets or sets the product primary page ID.

public int ProductPrimaryPageId { get; set; }

Property Value

int

RelatedLanguages

Gets or sets the related languages.

public ICollection<Language> RelatedLanguages { get; set; }

Property Value

ICollection<Language>

StockLocationID

Gets or sets the stock location ID.

public long StockLocationID { get; set; }

Property Value

long

StockStateId

Gets or sets the ID of the stock state.

public string StockStateId { get; set; }

Property Value

string

UsageType

Gets or sets ShopType for the shop

public ShopType UsageType { get; set; }

Property Value

ShopType

UseAlternativeImages

Gets or sets the value indicating whether shop has alternative images.

public bool UseAlternativeImages { get; set; }

Property Value

bool

Methods

ClearTopLevelGroupsCache()

Reset top groups cache.

public void ClearTopLevelGroupsCache()

Clone()

Clones the shop.

public object Clone()

Returns

object

A new instance of the Shop.

GetDisplayName()

Yields a human-readable name for rendering.

public string GetDisplayName()

Returns

string

name

GetGroups(string)

Gets the collection of the groups.

public GroupCollection GetGroups(string languageId)

Parameters

languageId string

The language ID.

Returns

GroupCollection

GetPermissionEntityByKey(string)

Attempts to resolve a concrete instance of IPermissionEntity based on a key.

public IPermissionEntity GetPermissionEntityByKey(string key)

Parameters

key string

The key used for looking up an instance of IPermissionEntity

Returns

IPermissionEntity

An instance of IPermissionEntity, if found; otherwise, null.

See Also

GetPermissionKey()

Gets the unique key for this permission entity.

public string GetPermissionKey()

Returns

string

Permission key

GetPermissionParents()

Gets the parents of this permission entity, for the purposes of inherited permissions.

public IEnumerable<IPermissionEntity> GetPermissionParents()

Returns

IEnumerable<IPermissionEntity>

A sequence of direct parents to this entity

GetTopLevelGroups(string)

Gets the collection of the top level groups.

public GroupCollection GetTopLevelGroups(string languageId)

Parameters

languageId string

The language ID.

Returns

GroupCollection
Improve this doc
To top