IBulkImageOptimizer Interface

Summary

An interface for describing an image optimizer.
Assembly
Cake.ImageOptimizer.dll
Namespace
Cake.ImageOptimizer
Implementing Types
graph BT Type["IBulkImageOptimizer"] class Type type-node Implementing0["BulkImageOptimizer"]-.->Type click Implementing0 "/api/Cake.ImageOptimizer/BulkImageOptimizer"

Syntax

public interface IBulkImageOptimizer

Events

Name Type Summary
Completed EventHandler<OptimizedFileEventArgs>
Triggered when the optimizer finishes processing all images
Progress EventHandler<OptimizedFileEventArgs>
Triggered when the optimizer finishes processing each image

Properties

Name Value Summary
ImagesErrored int
Gets the number of errored images
ImagesOptimized IList<string>
Gets the list of paths to the optimized images
ImagesSkipped int
Gets the number of images skipped
SavedPercent double
Gets the percent in size saved
SavedSize double
Gets the size in bytes saved during optimization
SizeAfter double
Gets the size in bytes after optimization
SizeBefore double
Gets the size in bytes before optimization

Methods

Name Value Summary
Clear() void
Clears all local flags
Optimize(DirectoryPath, DirectoryPath, ImageOptimizerSettings) IList<OptimizedFile>
Optimizes Images from the settings SourceDirectory

Extension Methods

Name Value Summary
Dump<IBulkImageOptimizer>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<IBulkImageOptimizer>(IBulkImageOptimizer[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<IBulkImageOptimizer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<IBulkImageOptimizer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<IBulkImageOptimizer>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<IBulkImageOptimizer>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin