ImageResizer  3.4.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
ImageResizer.Plugins.BatchZipper.BatchResizeItem Class Reference

Represents a file to resize/re-encode, the resize/encoding settings More...

Public Member Functions

 BatchResizeItem (string physicalPath, string targetFilename, string resizeQuerystring)
 Represents a file to resize/re-encode, the resize/encoding settings More...
 
BatchResizeItem Copy ()
 Copies the class, useful for preventing threading issues. Lightweight, only 4 pointers plus class instance. More...
 
void SetImmutable ()
 Blocks any future changes to the instance, throwing an InvalidOperationException. More...
 
override string ToString ()
 

Protected Member Functions

void ThowIfInvalid ()
 

Protected Attributes

 bool = true
 

Properties

string PhysicalPath [get, set]
 Filesystem path, such as C:.jpg. Throws an InvalidOperationException if you attempt to modify an immutable instance. More...
 
string ResizeQuerystring [get, set]
 The resize/crop settings applied to the file, ex. ?width=100&height=100&crop=auto&format=png. Throws an InvalidOperationException if you attempt to modify an immutable instance. More...
 
string TargetFilename [get, set]
 The target filename to use in the compressed folder. If left null, the filename of physicalPath will be used. Should not include the file extension, that will be assigned based on resizeQuerystring and the original extension. Throws an InvalidOperationException if you attempt to modify an immutable instance. More...
 

Detailed Description

Represents a file to resize/re-encode, the resize/encoding settings

Definition at line 20 of file BatchJobSettings.cs.

Constructor & Destructor Documentation

ImageResizer.Plugins.BatchZipper.BatchResizeItem.BatchResizeItem ( string  physicalPath,
string  targetFilename,
string  resizeQuerystring 
)
inline

Represents a file to resize/re-encode, the resize/encoding settings

Parameters
physicalPathFilesystem path, such as C:.jpg
targetFilenameThe target filename to use in the compressed folder. If left null, the filename of physicalPath will be used. Should not include the file extension, that will be assigned based on resizeQuerystring and the original extension.
resizeQuerystringThe resize/crop settings applied to the file, ex. ?width=100&height=100&crop=auto&format=png

Definition at line 29 of file BatchJobSettings.cs.

30  {
31  this.physicalPath = physicalPath;
32  this.resizeQuerystring = resizeQuerystring;
33  this.targetFilename = targetFilename;
34  }

Member Function Documentation

BatchResizeItem ImageResizer.Plugins.BatchZipper.BatchResizeItem.Copy ( )
inline

Copies the class, useful for preventing threading issues. Lightweight, only 4 pointers plus class instance.

Returns

Definition at line 96 of file BatchJobSettings.cs.

97  {
99  }
string TargetFilename
The target filename to use in the compressed folder. If left null, the filename of physicalPath will ...
string PhysicalPath
Filesystem path, such as C:.jpg. Throws an InvalidOperationException if you attempt to modify an immu...
string ResizeQuerystring
The resize/crop settings applied to the file, ex. ?width=100&height=100&crop=auto&format=png. Throws an InvalidOperationException if you attempt to modify an immutable instance.
BatchResizeItem(string physicalPath, string targetFilename, string resizeQuerystring)
Represents a file to resize/re-encode, the resize/encoding settings
void ImageResizer.Plugins.BatchZipper.BatchResizeItem.SetImmutable ( )
inline

Blocks any future changes to the instance, throwing an InvalidOperationException.

Definition at line 103 of file BatchJobSettings.cs.

104  {
105  mutable = false;
106  }

Property Documentation

string ImageResizer.Plugins.BatchZipper.BatchResizeItem.PhysicalPath
getset

Filesystem path, such as C:.jpg. Throws an InvalidOperationException if you attempt to modify an immutable instance.

Definition at line 56 of file BatchJobSettings.cs.

string ImageResizer.Plugins.BatchZipper.BatchResizeItem.ResizeQuerystring
getset

The resize/crop settings applied to the file, ex. ?width=100&height=100&crop=auto&format=png. Throws an InvalidOperationException if you attempt to modify an immutable instance.

Definition at line 67 of file BatchJobSettings.cs.

Referenced by ImageResizer.Plugins.BatchZipper.BatchResizeWorker.wouldResize(), and ImageResizer.Plugins.BatchZipper.BatchResizeWorker.WriteItemCallback().

string ImageResizer.Plugins.BatchZipper.BatchResizeItem.TargetFilename
getset

The target filename to use in the compressed folder. If left null, the filename of physicalPath will be used. Should not include the file extension, that will be assigned based on resizeQuerystring and the original extension. Throws an InvalidOperationException if you attempt to modify an immutable instance.

Definition at line 80 of file BatchJobSettings.cs.

Referenced by ImageResizer.Plugins.BatchZipper.BatchResizeSettings.FixDuplicateFilenames().


The documentation for this class was generated from the following file: