Class ProductCatalogSettings
- Namespace
- Dynamicweb.Ecommerce.Frontend
- Assembly
- Dynamicweb.Ecommerce.dll
Represents the settings of the product catalog.
public class ProductCatalogSettings
- Inheritance
-
ProductCatalogSettings
- Inherited Members
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
CompareTemplate
Gets or sets the compare template.
public string CompareTemplate { get; set; }
Property Value
DefaultSearchField
Gets the default search field for free-text search functionality.
public string DefaultSearchField { get; }
Property Value
DisableProductDetail
Gets the value indicating whether the product details are disabled.
public bool DisableProductDetail { get; }
Property Value
DynamicFacets
public string DynamicFacets { get; set; }
Property Value
EmailFormTemplate
Gets or sets the email form template.
public string EmailFormTemplate { get; set; }
Property Value
EmailTemplate
Gets or sets the email template.
public string EmailTemplate { get; set; }
Property Value
EnablePagedQueries
Gets value indicating whether paged product list queries are enabled.
public bool EnablePagedQueries { get; }
Property Value
FieldToSpellCheck
Gets or sets name of query field to spell check
public string FieldToSpellCheck { get; set; }
Property Value
FirstPageTemplate
Gets or sets the template for the first page.
public string FirstPageTemplate { get; set; }
Property Value
FooterTemplate
Gets or sets the footer template.
public string FooterTemplate { get; set; }
Property Value
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
FrontendCachingExpiration
Gets the frontend cache expiration.
public int FrontendCachingExpiration { get; }
Property Value
GroupListTemplate
Gets or sets the group list template.
public string GroupListTemplate { get; set; }
Property Value
Groups
Gets the groups.
public string Groups { get; }
Property Value
HeaderTemplate
Gets or sets the header template.
public string HeaderTemplate { get; set; }
Property Value
HideEmptyOptions
Gets value indicating whether to exclude filter options without products from the render pipeline.
public bool HideEmptyOptions { get; }
Property Value
IgnoreUrlParameters
Gets the value indicating whether the URL parameters are ignored.
public bool IgnoreUrlParameters { get; }
Property Value
ImageFolder
Gets or sets the image folder.
public string ImageFolder { get; set; }
Property Value
ImagePatternL
Gets or sets the pattern for the names of the large images.
public string ImagePatternL { get; set; }
Property Value
ImagePatternM
Gets or sets the pattern for the names of the medium images.
public string ImagePatternM { get; set; }
Property Value
ImagePatternS
Gets or sets the pattern for the names of the small images.
public string ImagePatternS { get; set; }
Property Value
ImageSearchInSubfolders
Gets or sets the image folder.
public bool ImageSearchInSubfolders { get; set; }
Property Value
IncludeExtendedVariants
Is the Ecom search should find extended variants.
public bool IncludeExtendedVariants { get; }
Property Value
IncludeSubgroups
Gets the value indicating whether the subgroups are included.
public bool IncludeSubgroups { get; }
Property Value
IndexQuery
Gets the facet.
public string IndexQuery { get; }
Property Value
LastPageTemplate
Gets or sets the template for the last page.
public string LastPageTemplate { get; set; }
Property Value
MaxQuerySuggestions
Gets the maximum number of query suggestions to display when using "Suggested queries" functionality.
public int MaxQuerySuggestions { get; }
Property Value
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
NolistTemplate
Gets or sets the template for nolist views.
public string NolistTemplate { get; set; }
Property Value
NoProductTemplate
Gets or sets the "No products found" template.
public string NoProductTemplate { get; set; }
Property Value
PageSize
Gets or sets the the number of items per page.
public int PageSize { get; set; }
Property Value
PageSizeBack
Gets or sets the number of backward pages.
public int PageSizeBack { get; set; }
Property Value
PageSizeBackPicture
Gets or sets the "Previous page" image.
public string PageSizeBackPicture { get; set; }
Property Value
PageSizeBackText
Gets or sets the "Previous page" text.
public string PageSizeBackText { get; set; }
Property Value
PageSizeForward
Gets or sets the number of forward pages.
public int PageSizeForward { get; set; }
Property Value
PageSizeForwardPicture
Gets or sets the "Next page" picture.
public string PageSizeForwardPicture { get; set; }
Property Value
PageSizeForwardText
Gets or sets the "Next page" text.
public string PageSizeForwardText { get; set; }
Property Value
ParameterToSpellCheck
Gets or sets name of parameter to spell check
public string ParameterToSpellCheck { get; set; }
Property Value
ProductAndGroupsSelector
Gets the groups converted from CVS.
public string ProductAndGroupsSelector { get; }
Property Value
ProductFeedTemplate
Gets or sets the product list feed template.
public string ProductFeedTemplate { get; set; }
Property Value
ProductId
Gets or sets the product id.
public string ProductId { get; set; }
Property Value
ProductListFeedTemplate
Gets or sets the product list feed template.
public string ProductListFeedTemplate { get; set; }
Property Value
ProductListTemplate
Gets or sets the product list template.
public string ProductListTemplate { get; set; }
Property Value
ProductPublishTemplate
Gets or sets the product publish template.
public string ProductPublishTemplate { get; set; }
Property Value
ProductsAndGroups
Gets the products and the groups.
public ProductsAndGroupsHandler ProductsAndGroups { get; }
Property Value
ProductTemplate
Gets or sets the product template.
public string ProductTemplate { get; set; }
Property Value
RegularPageTemplate
Gets or sets the template for the regular page.
public string RegularPageTemplate { get; set; }
Property Value
RelevanceSorting
Gets value indicating whether search result should be sorted by relevance.
public bool RelevanceSorting { get; }
Property Value
RemoveDuplicates
Gets the value indicating whether the duplicate products are removed.
public bool RemoveDuplicates { get; }
Property Value
RetrieveMyListsBasedOnCustomerNumber
public bool RetrieveMyListsBasedOnCustomerNumber { get; }
Property Value
SearchShop
If a shop is selected, limit the search results to that shop.
public string SearchShop { get; }
Property Value
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
SearchTemplate
Gets or sets the search template.
public string SearchTemplate { get; set; }
Property Value
SearchVariants
Gets the variants search mode.
public VariantsSearchMode SearchVariants { get; }
Property Value
ShortDescriptionLength
Gets or sets the length of the short description.
public int ShortDescriptionLength { get; set; }
Property Value
Show
Gets or sets the show type for the product catalog.
public ProductCatalogShowType Show { get; set; }
Property Value
ShowFacetOptionsWithNoResults
Show facet options with no result.
public bool ShowFacetOptionsWithNoResults { get; }
Property Value
ShowGroups
Gets or sets the value indicating whether the groups are shown.
public bool ShowGroups { get; set; }
Property Value
ShowOnParagraph
Gets the value indicating whether the catalog will be shown on the paragraph.
public bool ShowOnParagraph { get; }
Property Value
ShowOnParagraphCatalogUrl
Gets the paragraph catalog URL.
public string ShowOnParagraphCatalogUrl { get; }
Property Value
ShowOnParagraphId
Gets the paragraph id where the catalog will be shown.
public int ShowOnParagraphId { get; }
Property Value
ShowOnParagraphPageId
Gets the paragraph's page id where the catalog will be shown.
public int ShowOnParagraphPageId { get; }
Property Value
SortBy
Gets or sets the sort by.
public string SortBy { get; set; }
Property Value
SortOrder
Gets or sets the sort order.
public string SortOrder { get; set; }
Property Value
TemplateSearchBox
Gets or sets the template search box.
public int TemplateSearchBox { get; set; }
Property Value
TotalProductCount
Gets or sets the total product count.
public int TotalProductCount { get; set; }
Property Value
TrackQueries
Gets or sets a value indicating whether to track the query for statistics or not
public bool TrackQueries { get; set; }
Property Value
UseFrontendCaching
Gets the value indicating whether the frontend caching is using.
public bool UseFrontendCaching { get; }
Property Value
UseGroupSortInGroupContext
public bool UseGroupSortInGroupContext { get; set; }
Property Value
UseOptimizedEcomFrontend
Gets the value indicating whether the optimized frontend is used.
public bool UseOptimizedEcomFrontend { get; }
Property Value
UsePrintPublisher
Gets or sets the value indicating whether the publisher print is using.
public bool UsePrintPublisher { get; set; }
Property Value
VariantId
Gets or sets the variant id.
public string VariantId { get; set; }
Property Value
WildcardSearchOnly
Gets value indicating whether to always perform wildcard searches when using instant search and suggested queries.
public bool WildcardSearchOnly { get; }