Class ImageExportSettings

Namespace

Dynamicweb.Ecommerce.ProductCatalog

Assembly

Dynamicweb.Ecommerce.dll

Specifies image rendering options for product image export operations.

public sealed class ImageExportSettings

Inheritance

object

ImageExportSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AssetCategories

Gets or sets the asset category system names whose images should be included in the export. Only images belonging to a listed category are exported. An empty or null collection exports images from all asset categories.

public IEnumerable<string> AssetCategories { get; set; }

Property Value

IEnumerable<string>

Dpi

Gets or sets the output resolution in dots per inch. Defaults to 72 DPI when set to 0 or not specified.

public int Dpi { get; set; }

Property Value

int

EmbedProfile

Reserved for future use. Currently has no effect on export output.

public bool EmbedProfile { get; set; }

Property Value

bool

Height

Gets or sets the maximum output height in pixels. Defaults to 10000 (or the image's actual height if smaller) when set to 0 or not specified.

public int Height { get; set; }

Property Value

int

ImageFormat

Gets or sets the output image format (e.g. "Jpg", "Png"). Defaults to "Jpg" when not specified.

public string ImageFormat { get; set; }

Property Value

string

IncludeImagePatternImages

Gets or sets a value indicating whether images defined by the product image pattern are included in the export.

public bool IncludeImagePatternImages { get; set; }

Property Value

bool

IncludePrimaryImage

Gets or sets a value indicating whether the product's primary image is included in the export.

public bool IncludePrimaryImage { get; set; }

Property Value

bool

Width

Gets or sets the maximum output width in pixels. Defaults to 10000 (or the image's actual width if smaller) when set to 0 or not specified.

public int Width { get; set; }

Property Value

int