Click or drag to resize
CMSOutputMediaFile Class
Class encapsulating MediaFile.
Inheritance Hierarchy

Namespace: CMS.MediaLibrary
Assembly: CMS.MediaLibrary (in CMS.MediaLibrary.dll) Version: 12.0.0
Syntax
C#
public class CMSOutputMediaFile : AbstractOutputFile, 
	IDataContainer, ISimpleDataContainer

The CMSOutputMediaFile type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldmDataLoaded
Indicates whether data were loaded
(Inherited from AbstractOutputFile.)
Protected fieldmHeight
Height
(Inherited from AbstractOutputFile.)
Protected fieldmInstantiated
Initialization time
(Inherited from AbstractOutputFile.)
Protected fieldmMaxSideSize
Max side size
(Inherited from AbstractOutputFile.)
Protected fieldmOutputData
Binary output data
(Inherited from AbstractOutputFile.)
Protected fieldmResized
Indicates whether image was resized
(Inherited from AbstractOutputFile.)
Protected fieldmUseWatermark
Indicates whether watermark should be used
(Inherited from AbstractOutputFile.)
Protected fieldmWidth
Width
(Inherited from AbstractOutputFile.)
Top
Properties
  NameDescription
Public propertyColumnNames
Column names.
Public propertyDataLoaded
Returns true if the data is loaded to the object.
(Inherited from AbstractOutputFile.)
Public propertyFileExtension
File extension.
Public propertyFileName
File extension.
Public propertyFilePath
File path.
Public propertyHeight
Requested output Height.
(Inherited from AbstractOutputFile.)
Public propertyItem
Gets or sets the value of the column.
Public propertyLastModified
Time when the file was last modified.
Public propertyMaxSideSize
Requested output MaxSideSize.
(Inherited from AbstractOutputFile.)
Public propertyMediaFile
Media file info object.
Public propertyMimeType
Mime type.
Public propertyOriginalFile
Gets physical file path to the original file.
Public propertyOutputData
Output file data.
(Inherited from AbstractOutputFile.)
Public propertyPhysicalFile
Physical file path to the data.
Public propertyPreviewFilePath
Preview file path
Public propertyResized
If true, the file is resized version of the file.
(Inherited from AbstractOutputFile.)
Public propertySiteName
Media file site name.
Public propertyUsePreview
Indicates if file preview should be pused for output file.
Public propertyUseWatermark
If true, the watermark is allowed to be used.
(Overrides AbstractOutputFileUseWatermark.)
Public propertyWatermark
If set, watermark image is applied to the image. Name of the watermark image from ~/App_Themes/{theme}/Images/Watermarks
(Inherited from AbstractOutputFile.)
Public propertyWatermarkPosition
Watermark position.
(Inherited from AbstractOutputFile.)
Public propertyWidth
Requested output width.
(Inherited from AbstractOutputFile.)
Top
Methods
  NameDescription
Public methodApplyWatermark
Applies watermark on the given image data.
(Inherited from AbstractOutputFile.)
Protected methodCheckUseWatermark
Checks whether the watermark can be used
(Inherited from AbstractOutputFile.)
Public methodContainsColumn
Returns true if the object contains specified column.
Public methodEnsureData
Ensures that the object contains the output data.
Public methodGetValue
Returns value of column.
Public methodLoadData
Loads the data to the object.
Public methodLoadPreview
Loads the preview data to the object.
Protected methodSatisfiesWatermarkDimensions
Checks the minimal
(Inherited from AbstractOutputFile.)
Public methodSetValue
Sets value of column.
Public methodTryGetValue
Returns value of column.
Top
Extension Methods
  NameDescription
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, Boolean)Overloaded.
Writes XML representation of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Public Extension MethodToXML(String, Boolean)Overloaded.
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, ListString, Boolean)Overloaded.
Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Top
See Also