HtmlForgeX

API Reference

Class

ImageConfiguration

Namespace HtmlForgeX
Assembly HtmlForgeX

Image processing configuration settings.

Inheritance

  • Object
  • ImageConfiguration

Constructors

public ImageConfiguration() #

Properties

public Boolean AutoOptimize { get; set; } #

Gets or sets whether to automatically optimize images.

public Boolean AutoEmbedImages { get; set; } #

Gets or sets whether to automatically embed images when possible.

public Boolean AutoCopyLocalImagesToAssets { get; set; } #

Gets or sets whether to automatically copy local images (file paths / file:// URLs) into an output assets directory (recommended for OfflineWithFiles).

public Boolean AutoDownloadRemoteImagesToAssets { get; set; } #

Gets or sets whether to automatically download remote images (http/https) into the assets directory when AutoCopyLocalImagesToAssets is enabled.

public String AssetsPath { get; set; } #

Gets or sets the directory (relative to the current document) where copied/downloaded images are stored. Default: assets/img.

public Int32 EmbeddingTimeout { get; set; } #

Gets or sets the timeout in seconds when downloading images for embedding.

public Int32 MaxWidth { get; set; } #

Gets or sets the maximum width for image optimization (in pixels).

public Int32 MaxHeight { get; set; } #

Gets or sets the maximum height for image optimization (in pixels).

public Int32 Quality { get; set; } #

Gets or sets the quality for JPEG compression (0-100).

public String DefaultFormat { get; set; } #

Gets or sets the default image format for optimization.

public Boolean PreserveMetadata { get; set; } #

Gets or sets whether to preserve image metadata during optimization.