Class ProductCatalogSettings

Namespace

Dynamicweb.Ecommerce.Frontend

Assembly

Dynamicweb.Ecommerce.dll

Represents the settings of the product catalog.

public class ProductCatalogSettings

Inheritance

object

ProductCatalogSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProductCatalogSettings()

Initializes a new instance of the class.

public ProductCatalogSettings()

ProductCatalogSettings(Properties)

Initializes a new instance of the class.

public ProductCatalogSettings(Properties properties)

Parameters

properties Properties

The properties.

ProductCatalogSettings(int)

Initializes a new instance of the class.

public ProductCatalogSettings(int paragraphId)

Parameters

paragraphId int

The paragraph id.

Properties

AlternativePictureBox

Gets or sets the alternative picture box.

public int AlternativePictureBox { get; set; }

Property Value

int

CompareTemplate

Gets or sets the compare template.

public string CompareTemplate { get; set; }

Property Value

string

DefaultSearchField

Gets the default search field for free-text search functionality.

public string DefaultSearchField { get; }

Property Value

string

DisableProductDetail

Gets the value indicating whether the product details are disabled.

public bool DisableProductDetail { get; }

Property Value

bool

DynamicFacets

public string DynamicFacets { get; set; }

Property Value

string

EmailFormTemplate

Gets or sets the email form template.

public string EmailFormTemplate { get; set; }

Property Value

string

EmailTemplate

Gets or sets the email template.

public string EmailTemplate { get; set; }

Property Value

string

EnablePagedQueries

Gets value indicating whether paged product list queries are enabled.

public bool EnablePagedQueries { get; }

Property Value

bool

FieldToSpellCheck

Gets or sets name of query field to spell check

public string FieldToSpellCheck { get; set; }

Property Value

string

FirstPageTemplate

Gets or sets the template for the first page.

public string FirstPageTemplate { get; set; }

Property Value

string

FooterTemplate

Gets or sets the footer template.

public string FooterTemplate { get; set; }

Property Value

string

ForcePagedQueries

Gets value indicating whether to force paged queries even if there's custom code that can rely on the entire product collection.

public bool ForcePagedQueries { get; }

Property Value

bool

FrontendCachingExpiration

Gets the frontend cache expiration.

public int FrontendCachingExpiration { get; }

Property Value

int

GroupListTemplate

Gets or sets the group list template.

public string GroupListTemplate { get; set; }

Property Value

string

Groups

Gets the groups.

public string Groups { get; }

Property Value

string

HeaderTemplate

Gets or sets the header template.

public string HeaderTemplate { get; set; }

Property Value

string

HideEmptyOptions

Gets value indicating whether to exclude filter options without products from the render pipeline.

public bool HideEmptyOptions { get; }

Property Value

bool

IgnoreUrlParameters

Gets the value indicating whether the URL parameters are ignored.

public bool IgnoreUrlParameters { get; }

Property Value

bool

ImageFolder

Gets or sets the image folder.

public string ImageFolder { get; set; }

Property Value

string

ImagePatternL

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

public string ImagePatternL { get; set; }

Property Value

string

ImagePatternM

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

public string ImagePatternM { get; set; }

Property Value

string

ImagePatternS

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

public string ImagePatternS { get; set; }

Property Value

string

ImageSearchInSubfolders

Gets or sets the image folder.

public bool ImageSearchInSubfolders { get; set; }

Property Value

bool

IncludeExtendedVariants

Is the Ecom search should find extended variants.

public bool IncludeExtendedVariants { get; }

Property Value

bool

IncludeSubgroups

Gets the value indicating whether the subgroups are included.

public bool IncludeSubgroups { get; }

Property Value

bool

IndexQuery

Gets the facet.

public string IndexQuery { get; }

Property Value

string

LastPageTemplate

Gets or sets the template for the last page.

public string LastPageTemplate { get; set; }

Property Value

string

MaxQuerySuggestions

Gets the maximum number of query suggestions to display when using "Suggested queries" functionality.

public int MaxQuerySuggestions { get; }

Property Value

int

Remarks

The default value is "5". The maximum allowed value is "20" (any number greater than 20 will be silently discarded).

MetaFirstPageAsCanonical

Gets or sets the value indicating whether the meta of the first page used as canonical.

public bool MetaFirstPageAsCanonical { get; set; }

Property Value

bool

NoProductTemplate

Gets or sets the "No products found" template.

public string NoProductTemplate { get; set; }

Property Value

string

NolistTemplate

Gets or sets the template for nolist views.

public string NolistTemplate { get; set; }

Property Value

string

PageSize

Gets or sets the the number of items per page.

public int PageSize { get; set; }

Property Value

int

PageSizeBack

Gets or sets the number of backward pages.

public int PageSizeBack { get; set; }

Property Value

int

PageSizeBackPicture

Gets or sets the "Previous page" image.

public string PageSizeBackPicture { get; set; }

Property Value

string

PageSizeBackText

Gets or sets the "Previous page" text.

public string PageSizeBackText { get; set; }

Property Value

string

PageSizeForward

Gets or sets the number of forward pages.

public int PageSizeForward { get; set; }

Property Value

int

PageSizeForwardPicture

Gets or sets the "Next page" picture.

public string PageSizeForwardPicture { get; set; }

Property Value

string

PageSizeForwardText

Gets or sets the "Next page" text.

public string PageSizeForwardText { get; set; }

Property Value

string

ParameterToSpellCheck

Gets or sets name of parameter to spell check

public string ParameterToSpellCheck { get; set; }

Property Value

string

ProductAndGroupsSelector

Gets the groups converted from CVS.

public string ProductAndGroupsSelector { get; }

Property Value

string

ProductFeedTemplate

Gets or sets the product list feed template.

public string ProductFeedTemplate { get; set; }

Property Value

string

ProductId

Gets or sets the product id.

public string ProductId { get; set; }

Property Value

string

ProductListFeedTemplate

Gets or sets the product list feed template.

public string ProductListFeedTemplate { get; set; }

Property Value

string

ProductListTemplate

Gets or sets the product list template.

public string ProductListTemplate { get; set; }

Property Value

string

ProductPublishTemplate

Gets or sets the product publish template.

public string ProductPublishTemplate { get; set; }

Property Value

string

ProductTemplate

Gets or sets the product template.

public string ProductTemplate { get; set; }

Property Value

string

ProductsAndGroups

Gets the products and the groups.

public ProductsAndGroupsHandler ProductsAndGroups { get; }

Property Value

ProductsAndGroupsHandler

RegularPageTemplate

Gets or sets the template for the regular page.

public string RegularPageTemplate { get; set; }

Property Value

string

RelevanceSorting

Gets value indicating whether search result should be sorted by relevance.

public bool RelevanceSorting { get; }

Property Value

bool

RemoveDuplicates

Gets the value indicating whether the duplicate products are removed.

public bool RemoveDuplicates { get; }

Property Value

bool

RetrieveMyListsBasedOnCustomerNumber

public bool RetrieveMyListsBasedOnCustomerNumber { get; }

Property Value

bool

SearchShop

If a shop is selected, limit the search results to that shop.

public string SearchShop { get; }

Property Value

string

SearchSubGroups

Gets value indicating whether to include products from child groups when in the context of a group (contains "GroupID" query-string parameter).

public bool SearchSubGroups { get; }

Property Value

bool

SearchTemplate

Gets or sets the search template.

public string SearchTemplate { get; set; }

Property Value

string

SearchVariants

Gets the variants search mode.

public VariantsSearchMode SearchVariants { get; }

Property Value

VariantsSearchMode

ShortDescriptionLength

Gets or sets the length of the short description.

public int ShortDescriptionLength { get; set; }

Property Value

int

Show

Gets or sets the show type for the product catalog.

public ProductCatalogShowType Show { get; set; }

Property Value

ProductCatalogShowType

ShowFacetOptionsWithNoResults

Show facet options with no result.

public bool ShowFacetOptionsWithNoResults { get; }

Property Value

bool

ShowGroups

Gets or sets the value indicating whether the groups are shown.

public bool ShowGroups { get; set; }

Property Value

bool

ShowOnParagraph

Gets the value indicating whether the catalog will be shown on the paragraph.

public bool ShowOnParagraph { get; }

Property Value

bool

ShowOnParagraphCatalogUrl

Gets the paragraph catalog URL.

public string ShowOnParagraphCatalogUrl { get; }

Property Value

string

ShowOnParagraphId

Gets the paragraph id where the catalog will be shown.

public int ShowOnParagraphId { get; }

Property Value

int

ShowOnParagraphPageId

Gets the paragraph's page id where the catalog will be shown.

public int ShowOnParagraphPageId { get; }

Property Value

int

SortBy

Gets or sets the sort by.

public string SortBy { get; set; }

Property Value

string

SortOrder

Gets or sets the sort order.

public string SortOrder { get; set; }

Property Value

string

TemplateSearchBox

Gets or sets the template search box.

public int TemplateSearchBox { get; set; }

Property Value

int

TotalProductCount

Gets or sets the total product count.

public int TotalProductCount { get; set; }

Property Value

int

TrackQueries

Gets or sets a value indicating whether to track the query for statistics or not

public bool TrackQueries { get; set; }

Property Value

bool

UseFrontendCaching

Gets the value indicating whether the frontend caching is using.

public bool UseFrontendCaching { get; }

Property Value

bool

UseGroupSortInGroupContext

public bool UseGroupSortInGroupContext { get; set; }

Property Value

bool

UseOptimizedEcomFrontend

Gets the value indicating whether the optimized frontend is used.

public bool UseOptimizedEcomFrontend { get; }

Property Value

bool

UsePrintPublisher

Gets or sets the value indicating whether the publisher print is using.

public bool UsePrintPublisher { get; set; }

Property Value

bool

VariantId

Gets or sets the variant id.

public string VariantId { get; set; }

Property Value

string

WildcardSearchOnly

Gets value indicating whether to always perform wildcard searches when using instant search and suggested queries.

public bool WildcardSearchOnly { get; }

Property Value

bool