ImageProcessingSettings Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

This base class contains image processing settings used by BinaryUpload.
Inheritance Hierarchy

SystemObject
  ContentStudio.Site.ControlsImageProcessingSettings
    ContentStudio.Site.ControlsCustomImageProcessingSettings
    ContentStudio.Site.ControlsHighResImageProcessingSettings
    ContentStudio.Site.ControlsThumbnailImageProcessingSettings
    ContentStudio.Site.ControlsWebImageProcessingSettings

Namespace: ContentStudio.Site.Controls
Assembly: ContentStudio.Site.Controls (in ContentStudio.Site.Controls.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public abstract class ImageProcessingSettings : IStateManager

The ImageProcessingSettings type exposes the following members.

Constructors

  NameDescription
Protected methodImageProcessingSettings
Initializes a new instance of the ImageProcessingSettings class
Top
Properties

  NameDescription
Public propertyDestinationFormat
Gets or sets the destination format of the image. Set to null to use the same format as the originally uploaded file.
Public propertyFileNameFormat
Gets or sets the file name format wheares the {FileName} is file name of the uploaded file without the extension and the {Extension} is the extension of the uploaded file.
Public propertyImageFilter
Image filters are used to interpolate new pixel values when the size of an image changes. The purpose is to maintain the image quality as good as possible. All image filters work in similar ways, but they differ in the priorities and weight of the surrounding pixels. There is no filter that is optimal for all scenarios. Therefore, it may be necessary to test different filter to fins the one that is best suited for each category.
Public propertyIsDefaultFileNameFormat
Gets a value indicating whether this instance is default file name format.
Public propertyMaxHeight
If a maximum size is given (value greater then zero), the images are scaled to fit within the limits, provided that the original image is larger than the maximum size. If the image format does not support resizing, the meta data is change to reflect 72 dpi resolution. If no maximum size is given, the image resolution is read from its meta data. If the resolution is higher than 72 dpi, it will be scaled (sampled) to 72 dpi.
Public propertyMaxWidth
If a maximum size is given (value greater then zero), the images are scaled to fit within the limits, provided that the original image is larger than the maximum size. If the image format does not support resizing, the meta data is change to reflect 72 dpi resolution. If no maximum size is given, the image resolution is read from its meta data. If the resolution is higher than 72 dpi, it will be scaled (sampled) to 72 dpi.
Public propertyQuality
The Quality level is only used for compression if the image format allows it. Currently, compression is only used for JPEG images. Low quality numbers indicate high compression with low picture quality and small file size.
Public propertyUseSmartResizing
With smart resizing, the picture orientation is investigated. If the image uses portrait orientation, the given values for maximum with and height will change place.
Protected propertyViewState
Gets the state of the view.
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetFilePath
Gets the file path.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
See Also

Reference