Class ResizeEffect
An effect that resizes a media
Implements
Inherited Members
Namespace: ImageVault.Common.Data.Effects
Assembly: ImageVault.Common.dll
Syntax
public class ResizeEffect : Effect, ICloneable
  Constructors
ResizeEffect()
Initializes a new instance of the ResizeEffect class.
Declaration
public ResizeEffect()
  ResizeEffect(Size, ResizeMode)
Initializes a new instance of the ResizeEffect class.
Declaration
public ResizeEffect(Size size, ResizeMode resizeMode = ResizeMode.ScaleToFit)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Drawing.Size | size | |
| ResizeMode | resizeMode | 
ResizeEffect(Int32, Int32, ResizeMode)
Initializes a new instance of the ResizeEffect class.
Declaration
public ResizeEffect(int width, int height, ResizeMode resizeMode = ResizeMode.ScaleToFit)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Int32 | width | The width of the resizeEffect.  | 
      
| System.Int32 | height | The height of the resizeEffect.  | 
      
| ResizeMode | resizeMode | The ResizeMode. Default is ScaleToFit.  | 
      
Properties
AspectRatio
Gets the AspectRatio of the ResizeEffect
Declaration
public double AspectRatio { get; }
  Property Value
| Type | Description | 
|---|---|
| System.Double | 
Height
Get/Sets the Height of the ResizeEffect
Declaration
public int Height { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Int32 | 
IgnoreAreaOfInterest
If set to true, area of interest will be disregarded when auto-crop is needed.
Declaration
public bool IgnoreAreaOfInterest { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Boolean | 
ResizeMode
Get/Sets the ResizeMode of the ResizeEffect
Declaration
public ResizeMode ResizeMode { get; set; }
  Property Value
| Type | Description | 
|---|---|
| ResizeMode | 
Width
Get/Sets the Width of the ResizeEffect
Declaration
public int Width { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Int32 | 
Methods
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public override object Clone()
  Returns
| Type | Description | 
|---|---|
| System.Object | A new object that is a copy of this instance.  | 
      
Overrides
Equals(ResizeEffect)
Determines whether the specified ResizeEffect is equal to the current ResizeEffect.
Declaration
public bool Equals(ResizeEffect other)
  Parameters
| Type | Name | Description | 
|---|---|---|
| ResizeEffect | other | The ResizeEffect to compare with the current ResizeEffect.  | 
      
Returns
| Type | Description | 
|---|---|
| System.Boolean | true if the specified ResizeEffect is equal to the current ResizeEffect; otherwise, false.  | 
      
Equals(Object)
Determines whether the specified System.Object is equal to the current ResizeEffect.
Declaration
public override bool Equals(object obj)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Object | obj | The System.Object to compare with the current ResizeEffect.  | 
      
Returns
| Type | Description | 
|---|---|
| System.Boolean | true if the specified System.Object is equal to the current ResizeEffect; otherwise, false.  | 
      
Overrides
GetHashCode()
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
Declaration
public override int GetHashCode()
  Returns
| Type | Description | 
|---|---|
| System.Int32 | A hash code for the current ResizeEffect.  | 
      
Overrides
ToString()
Returns a System.String that represents the current ResizeEffect.
Declaration
public override string ToString()
  Returns
| Type | Description | 
|---|---|
| System.String | A System.String that represents the current ResizeEffect.  |