AbstractOutputFile Class

Abstract output file with the base functionality.

Inheritance Hierarchy

System.Object
  CMS.Helpers.AbstractOutputFile
    CMS.DataEngine.CMSOutputMetaFile
    CMS.DocumentEngine.CMSOutputAttachment
    CMS.MediaLibrary.CMSOutputMediaFile

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 8.2.23

Syntax

public abstract class AbstractOutputFile

The AbstractOutputFile type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractOutputFile

Methods

	Name	Description
Public method	ApplyWatermark	Applies watermark on the given image data.
Protected method	CheckUseWatermark	Checks whether the watermark can be used
Protected method	SatisfiesWatermarkDimensions	Checks the minimal

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

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

Properties

	Name	Description
Public property	DataLoaded	Returns true if the data is loaded to the object.
Public property	Height	Requested output Height.
Public property	MaxSideSize	Requested output MaxSideSize.
Public property	OutputData	Output file data.
Public property	Resized	If true, the file is resized version of the file.
Public property	UseWatermark	If true, the watermark is allowed to be used.
Public property	Watermark	If set, watermark image is applied to the image. Name of the watermark image from ~/App_Themes/{theme}/Images/Watermarks
Public property	WatermarkPosition	Watermark position.
Public property	Width	Requested output width.