Class Media
Defines information about a specific media item for a specific conversion
Implements
Namespace: ImageVault.Common.Data
Assembly: ImageVault.Common.dll
Syntax
[MediaFormatType]
public class Media : Object, IItem<int>Constructors
Media()
Initializes a new instance of the Media class.
Declaration
public Media()Media(Media)
Initializes a new instance of the Media class.
Declaration
public Media(Media mediaInformation)Parameters
| Type | Name | Description |
|---|---|---|
| Media | mediaInformation |
Properties
ContentType
Get/Sets the ContentType of the Media
Declaration
public string ContentType { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
DirectRendererId
Defines a direct renderer id to use to render the media
Declaration
public string DirectRendererId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
For legacy reasons, the RendererIdmight refer to another renderer in order to render a generic embedded iframe/url. The DirectRendererId should be used by the embed renderer to detect what renderer to use
Html
Get/Sets the Html of the Media
Declaration
public string Html { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | If the content has a suggested or required Html, it is supplied here |
Remarks
This property is soon to be marked as obsolete. Recommended action is to move to MediaRenderer handling instead of relying on this property
Id
Get/Sets the Id of the MediaItem that the Media represents
Declaration
public int Id { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
IsFileIcon
Is true if the media is a file icon conversion.
Declaration
public bool IsFileIcon { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
MediaFormatId
Get/Sets the MediaFormatId of the Media
Declaration
public int MediaFormatId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
MediaFormatName
Get/Sets the MediaFormatName of the Media
Declaration
public string MediaFormatName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
Get/Sets the Name of the Media
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RendererData
Values passed to the renderer
Declaration
public string RendererData { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RendererId
Id of renderer to use to render the media
Declaration
public string RendererId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Url
Get/Sets the Url of the Media
Declaration
public string Url { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public virtual Media Clone()Returns
| Type | Description |
|---|---|
| Media | A new object that is a copy of this instance. |