CMSOutputMediaFile Class

Class encapsulating MediaFile.

Inheritance Hierarchy

System.Object
  CMS.Helpers.AbstractOutputFile
    CMS.MediaLibrary.CMSOutputMediaFile

Namespace: CMS.MediaLibrary
Assembly: CMS.MediaLibrary (in CMS.MediaLibrary.dll) Version: 11.0.0

Syntax

public class CMSOutputMediaFile : AbstractOutputFile, 
	IDataContainer, ISimpleDataContainer

The CMSOutputMediaFile type exposes the following members.

Constructors

	Name	Description
Public method	CMSOutputMediaFile()	Constructor.
Public method	CMSOutputMediaFile(MediaFileInfo, Byte[])	Constructor.

Fields

	Name	Description
Protected field	mDataLoaded	Indicates whether data were loaded (Inherited from AbstractOutputFile.)
Protected field	mHeight	Height (Inherited from AbstractOutputFile.)
Protected field	mInstantiated	Initialization time (Inherited from AbstractOutputFile.)
Protected field	mMaxSideSize	Max side size (Inherited from AbstractOutputFile.)
Protected field	mOutputData	Binary output data (Inherited from AbstractOutputFile.)
Protected field	mResized	Indicates whether image was resized (Inherited from AbstractOutputFile.)
Protected field	mUseWatermark	Indicates whether watermark should be used (Inherited from AbstractOutputFile.)
Protected field	mWidth	Width (Inherited from AbstractOutputFile.)

Properties

	Name	Description
Public property	ColumnNames	Column names.
Public property	DataLoaded	Returns true if the data is loaded to the object. (Inherited from AbstractOutputFile.)
Public property	FileExtension	File extension.
Public property	FileName	File extension.
Public property	FilePath	File path.
Public property	Height	Requested output Height. (Inherited from AbstractOutputFile.)
Public property	Item	Gets or sets the value of the column.
Public property	LastModified	Time when the file was last modified.
Public property	MaxSideSize	Requested output MaxSideSize. (Inherited from AbstractOutputFile.)
Public property	MediaFile	Media file info object.
Public property	MimeType	Mime type.
Public property	OriginalFile	Gets physical file path to the original file.
Public property	OutputData	Output file data. (Inherited from AbstractOutputFile.)
Public property	PhysicalFile	Physical file path to the data.
Public property	PreviewFilePath	Preview file path
Public property	Resized	If true, the file is resized version of the file. (Inherited from AbstractOutputFile.)
Public property	SiteName	Media file site name.
Public property	UsePreview	Indicates if file preview should be pused for output file.
Public property	UseWatermark	If true, the watermark is allowed to be used. (Overrides AbstractOutputFile.UseWatermark.)
Public property	Watermark	If set, watermark image is applied to the image. Name of the watermark image from ~/App_Themes/{theme}/Images/Watermarks (Inherited from AbstractOutputFile.)
Public property	WatermarkPosition	Watermark position. (Inherited from AbstractOutputFile.)
Public property	Width	Requested output width. (Inherited from AbstractOutputFile.)

Methods

	Name	Description
Public method	ApplyWatermark	Applies watermark on the given image data. (Inherited from AbstractOutputFile.)
Protected method	CheckUseWatermark	Checks whether the watermark can be used (Inherited from AbstractOutputFile.)
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method	EnsureData	Ensures that the object contains the output data.
Public method	GetValue	Returns value of column.
Public method	LoadData	Loads the data to the object.
Public method	LoadPreview	Loads the preview data to the object.
Protected method	SatisfiesWatermarkDimensions	Checks the minimal (Inherited from AbstractOutputFile.)
Public method	SetValue	Sets value of column.
Public method	TryGetValue	Returns value of column.

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)