Class ImageFormat
Formats a media to an image.
Inheritance
Inherited Members
Namespace: ImageVault.Common.Data
Assembly: ImageVault.Common.dll
Syntax
public class ImageFormat : ThumbnailFormat, IMediaFormat, IItem<int>, IResizeFormatConstructors
ImageFormat()
Initializes a new instance of the ImageFormat class.
Declaration
public ImageFormat()ImageFormat(ImageFormat)
Initializes a new instance of the ImageFormat class.
Declaration
public ImageFormat(ImageFormat format)Parameters
| Type | Name | Description |
|---|---|---|
| ImageFormat | format |
Properties
CompressionQuality
Get/Sets the CompressionQuality of the MediaConversion
Declaration
public Nullable<byte> CompressionQuality { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Byte> | A value from 0 to 100 where 0 is minimum quality and 100 is maximum quality |
Dpi
Get/Sets the Dpi of the MediaConversion
Declaration
public Nullable<int> Dpi { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
IccProfile
Get/Sets the IccProfile of the MediaConversion
Declaration
public string IccProfile { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
IsEmpty
Checks if this is an empty format or not
Declaration
public override bool IsEmpty { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
Methods
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public override MediaFormatBase Clone()Returns
| Type | Description |
|---|---|
| MediaFormatBase | A new object that is a copy of this instance. |
Overrides
CopyFrom(ImageFormat)
Copies the values from the supplied format to the current instance
Declaration
protected void CopyFrom(ImageFormat format)Parameters
| Type | Name | Description |
|---|---|---|
| ImageFormat | format | The ImageFormat to copy from. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | If |
Equals(ImageFormat)
Determines whether the specified ImageFormat is equal to the current ImageFormat.
Declaration
public bool Equals(ImageFormat other)Parameters
| Type | Name | Description |
|---|---|---|
| ImageFormat | other | The ImageFormat to compare with the current ImageFormat. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the specified ImageFormat is equal to the current ImageFormat; otherwise, false. |
Equals(Object)
Determines whether the specified System.Object is equal to the current System.Object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The System.Object to compare with the current System.Object. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if the specified System.Object is equal to the current System.Object; otherwise, false. |
Overrides
GetHashCode()
Serves as a hash function for a particular type.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | A hash code for the current System.Object. |