Table of Contents

Class ProductImageService

Namespace
Dynamicweb.Ecommerce.Products
Assembly
Dynamicweb.Ecommerce.dll
public class ProductImageService
Inheritance
ProductImageService
Inherited Members

Properties

IsOldImagesDeprecated

public bool IsOldImagesDeprecated { get; }

Property Value

bool

UseImprovedPatterns

public bool UseImprovedPatterns { get; }

Property Value

bool

Methods

CheckPhysicalPath(string, bool)

public string CheckPhysicalPath(string image, bool saveWildCards = false)

Parameters

image string
saveWildCards bool

Returns

string

CompileProductImagePath(string, Product)

Compiles product image path with replacing product related placeholders with product values
public string CompileProductImagePath(string image, Product product)

Parameters

image string
The image path
product Product
The product

Returns

string
Compiled image path.

CompileProductImagePath(string, string, string, string, string, string, string, string)

Compiles product image path with replacing product related placeholders with product values
public string CompileProductImagePath(string image, string productId, string productNumber, string productName, string productPrimaryGroupId, string productVariantId, string productManufacturerName, string variantOptionName)

Parameters

image string
Image pattern
productId string
Product id
productNumber string
Product number
productName string
Product name
productPrimaryGroupId string
Product primary group id
productVariantId string
Product variant id
productManufacturerName string
Product manufacturer name
variantOptionName string
variantOptionName

Returns

string

FileExists(string)

public bool FileExists(string filePath)

Parameters

filePath string

Returns

bool

FindFilesByImagePattern(string, string, bool, bool)

public IEnumerable<string> FindFilesByImagePattern(string imageCompiled, string imageFolder, bool searchSubfolders, bool onlyExisting)

Parameters

imageCompiled string
imageFolder string
searchSubfolders bool
onlyExisting bool

Returns

IEnumerable<string>

FixImagePath(string)

public string FixImagePath(string path)

Parameters

path string

Returns

string

GetDefaultDetailImagePath(Product)

public string GetDefaultDetailImagePath(Product product)

Parameters

product Product

Returns

string

GetDefaultImageFromShop(Product, Shop)

public string GetDefaultImageFromShop(Product product, Shop shop)

Parameters

product Product
shop Shop

Returns

string

GetDefaultImageFromShop(Product, string)

public string GetDefaultImageFromShop(Product product, string groupId)

Parameters

product Product
groupId string

Returns

string

GetDefaultImagePath()

public string GetDefaultImagePath()

Returns

string

GetImageFromProduct(Product)

Gets the primary image for the product
public string GetImageFromProduct(Product product)

Parameters

product Product
The product

Returns

string
The image path of existing image with following the hierarchy: image set on ImageSmall Property image set on ImageMedium Property image set on ImageLarge Property

GetImagePath(Product)

Gets the primary image for the product
public string GetImagePath(Product product)

Parameters

product Product
The product

Returns

string
The image path of existing image with following the hierarchy: default detail image set on ImageSmall Property image set on ImageMedium Property image set on ImageLarge Property image from shop pattern image from global pattern image from global setting for small default image image from global setting for medium default image image from global setting for large default image

GetImagePath(Product, string)

Gets the primary image for the product
public string GetImagePath(Product product, string groupId)

Parameters

product Product
The product
groupId string
The product group id

Returns

string
The image path of existing image with following the hierarchy: default detail image set on ImageSmall Property image set on ImageMedium Property image set on ImageLarge Property image from shop pattern image from global pattern image from global setting for small default image image from global setting for medium default image image from global setting for large default image

GetImagePath(Product, string, List<Detail>, bool)

Gets the primary image for the product
public string GetImagePath(Product product, string groupId, List<Detail> details, bool ignoreNoPictureSetting)

Parameters

product Product
The product
groupId string
The product group id
details List<Detail>
ignoreNoPictureSetting bool

Returns

string
The image path of existing image with following the hierarchy: default detail image set on ImageSmall Property image set on ImageMedium Property image set on ImageLarge Property image from shop pattern image from global pattern image from global setting for small default image image from global setting for medium default image image from global setting for large default image

GetImagesFromPatterns(Product, Shop)

public IEnumerable<string> GetImagesFromPatterns(Product product, Shop shop)

Parameters

product Product
shop Shop

Returns

IEnumerable<string>

GetImagesFromPatterns(Product, string)

public IEnumerable<string> GetImagesFromPatterns(Product product, string groupId = "")

Parameters

product Product
groupId string

Returns

IEnumerable<string>

GetProductImage(string, string)

public string GetProductImage(string imagePath, string imageSize)

Parameters

imagePath string
imageSize string

Returns

string

IsUrl(string)

public bool IsUrl(string path)

Parameters

path string

Returns

bool
To top