Class MediaFormatBase

Defines the base class for a conversion format

Inheritance
System.Object
MediaFormatBase
OriginalFormat
TransformableFormat
Implements
IItem<System.Int32>
System.ICloneable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ImageVault.Common.Data
Assembly: ImageVault.Common.dll
Syntax
public class MediaFormatBase : IMediaFormat, IItem<int>, ICloneable

Constructors

MediaFormatBase()

Initializes a new instance of the MediaFormatBase class.

Declaration
public MediaFormatBase()

MediaFormatBase(MediaFormatBase)

Initializes a new instance of the MediaFormatBase class.

Declaration
public MediaFormatBase(MediaFormatBase mediaFormatBase)
Parameters
Type Name Description
MediaFormatBase mediaFormatBase

Properties

Id

Get/Sets the Id of the MediaFormatBase

Declaration
public int Id { get; set; }
Property Value
Type Description
System.Int32

IsEmpty

Checks if the Format is an empty format

Declaration
public virtual bool IsEmpty { get; }
Property Value
Type Description
System.Boolean

IsInUse

If the conversion format is used by any published files this property is not populated by default

Declaration
public bool? IsInUse { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

MediaFormatOutputType

Get/Sets the MediaFormatOutputType of the MediaFormatBase

Declaration
public MediaFormatOutputTypes MediaFormatOutputType { get; set; }
Property Value
Type Description
MediaFormatOutputTypes

Defaults to configured value in DefaultMediaFormatOutputType

Name

Get/Sets the Name of the MediaFormatBase

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

SystemFormat

Get/Sets the SystemFormat of the MediaFormatBase

Declaration
public bool? SystemFormat { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

True if the format is a system format, false if it is a user defined format

Methods

Clone()

Creates a new object that is a copy of the current instance.

Declaration
public virtual MediaFormatBase Clone()
Returns
Type Description
MediaFormatBase

A new object that is a copy of this instance.

CopyFrom(MediaFormatBase)

Copies the values from the supplied format to the current instance

Declaration
protected void CopyFrom(MediaFormatBase format)
Parameters
Type Name Description
MediaFormatBase format

The MediaFormatBase to copy from.
Exceptions
Type Condition
System.ArgumentNullException

If format is null.

Equals(MediaFormatBase)

Determines whether the specified MediaFormatBase is equal to the current MediaFormatBase.

Declaration
public bool Equals(MediaFormatBase other)
Parameters
Type Name Description
MediaFormatBase other

The MediaFormatBase to compare with the current MediaFormatBase.
Returns
Type Description
System.Boolean

true if the specified MediaFormatBase is equal to the current MediaFormatBase; 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
System.Object.Equals(System.Object)

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.
Overrides
System.Object.GetHashCode()

Explicit Interface Implementations

ICloneable.Clone()

Creates a new object that is a copy of the current instance.

Declaration
object ICloneable.Clone()
Returns
Type Description
System.Object

A new object that is a copy of this instance.

Implements

System.ICloneable

Extension Methods