CategoryPageViewModel

Overview

The CategoryPageViewModel is the primary model used to render the Category Viewer view to customers. This article will help you understand what's available to you in the view model.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of template engines
  • Understanding HTML, CSS, JavaScript
  • Familiarity with template languages
  • Familiarity with ASP.NET MVC Razor

Getting Started

There are no tasks needed to get started with understanding this object. 

CategoryPageViewModel

The CategoryPageViewModel object will contain all of the details of a single instance of a product in your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the CategoryPageViewModel object.  The descriptions are based on default functionality and the default Viewset included with Hotcakes.

Member Type Description
AuthorizedToEditCatalog Bool

If true, the current request (end-user) is authorized to edit the catalog.

CategoriesManagementUrl String The administration URL for viewing and editing all categories. If empty, the current visitor does not have permission to view the page.
CategoryAnalyticsUrl Bool

This URL can be used to directly navigate to the category performance view. If empty, the current end-user is not authorized to see and use this view.

CategoryEditUrl Bool This URL can be used to directly navigate to the category editing view. If empty, the current end-user is not authorized to see and use this view.
DrillDownJsonModel String, of Type <DrillDownJsonModel>

Contains the drill-down sub-categories and/or products JSON string for the current category. It contains all information like vendors, manufacturers, and products related to the category.

LeftColumn String This value is a legacy property that will always be an empty string and is never used by Hotcakes.
LocalCategory Category

Represents the standard Category object that is used to populate all category-based views and contains all of the information about the current category.

Manufacturers List<VendorManufacturer> A list of manufacturers for the different products found in the current category.
PagerData PagerViewModel

A model used to render the paging control on page.

PostColumn String This value is a legacy property that will always be an empty string and is never used by Hotcakes.
PreColumn String

This value is a legacy property that will always be an empty string and is never used by Hotcakes.

Products List<SingleProductViewModel> A list of the products that are associated with the current category.
ProductsManagementUrl String

The administration URL for viewing and editing all products. If empty, the current end-user is not authorized to see and use this view.

SortSelectList List<SelectListItem> A list of the selected items which is used to power the sorting features in the view.
StoreAdminUrl String

The store administration URL for the dashboard. If empty, the current end-user is not authorized to see and use this view.

SubCategories List<SingleCategoryViewModel> If there are any sub-categories for the current category, this object will contain that list.
Types List<ProductType>

If there are any product types associated with the products that are found in this category, they will be in this list object.

Vendors List<VendorManufacturer> A list of vendors for the different products found in the current category.

 

Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.