Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.ImageProcessor.Modules Namespace > ImageModule Class > ImageModule Properties
This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code 
                                  public class ImageModule
Visual Basic (Declaration) Copy imageCopy Code 
                                  Public Class ImageModule

The type exposes the following properties.

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.)
Public property AccessDeniedReturnValue
Gets or sets the value that is returned when the site visitor has insufficient access.
(Inherited from Module.)
Public property AddStyle
Gets or sets a value indicating whether to add a style attribute to the output.
Public property AIMMode
Gets or sets the AIM scanning mode of the macro.
(Inherited from Module.)
Public property AIMOrigin
Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item.
(Inherited from Module.)
Public property AltText
Gets or sets the alt text property for the image.
Public property AspectRatio
Gets or sets a value indicating whether to keep the aspect ratio when the image is resized.
Public property AutoTitle
Gets or sets a value indicating whether to automatically copy a title attribute from the AltText, if not specified.
Public property BufferNames
Gets or sets the buffer names.
(Inherited from Module.)
Public property ClassName
Gets or sets the class name attribute of the image.
Public property CommandOrder
Gets or sets the order in which the image commands are being applied.
Public property Condition
Gets or sets the Viper expression to evaluate before actually executing the macro.
If the expression returns false, the execution of the module and its child modules is skipped.
(Inherited from Module.)
Public property ConditionMatched
Must return true if TestCondition() matched.
(Inherited from Module.)
Public property CropBottom
Gets or sets the crop bottom.
Public property CropHeight
Gets or sets the height of the crop.
Public property CropLeft
Gets or sets the crop left.
Public property CropRight
Gets or sets the crop right.
Public property CropTop
Gets or sets the crop top.
Public property CropWidth
Gets or sets the width of the crop.
Public property CurrentCacheModule
Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block.
(Inherited from Module.)
Public property CurrentProperty
Gets the property currently being set on the module.
(Inherited from BaseModule.)
Public property DefaultValue
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.)
Public property DuoToneTint
Gets or sets the tint color of the duo tone effect.
Public property FallbackImage
Sets the location for the image to be used when the image specified in the Location parameter cannot be found.
Public property FileType
Gets or sets the file type of the image. Possible values are define in the imageFileTypes collection in the Smartsite.ImageProcessor.config file.
Public property Formatting
Gets the formatting options.
(Inherited from Module.)
Public property Grayscale
Gets or sets a value indicating whether this generated image is grayscale.
Public property HasParameterSection
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.)
Public property Height
Gets or sets the image height.
Public property Id
Gets or sets the unique id of the module instance during the current processing.
Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method.
(Inherited from BaseModule.)
Public property ImageId
Gets or sets the id attribute of the image.
Public property InputData
Gets or sets the input data. This must be a datatable containing the image.
Public property IsCancelled
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.)
Public property IsSelfClosing
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.)
Public property JpgQuality
Sets the JPG quality.
Public property LocalId
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.)
Public property Location
Sets the location of the image. This can be either a smartsite item or a site file.
Public property MaxHeight
Gets or sets the maximum height.
Public property MaxWidth
Gets or sets the maximum width.
Public property MinHeight
Gets or sets the minimum height.
Public property MinimumAccessTypeLevel
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.)
Public property MinWidth
Gets or set the minimum width.
Public property Mirror
Gets or sets the mirror type.
Public property ModuleInfo
Gets the module info.
(Inherited from BaseModule.)
Public property OilPaint
Gets or sets a value indicating whether to apply the oil paint effect.
Public property OnClick
Gets or sets the onclick attribute of the image.
Public property OnErrorReturnValue
Gets or sets the value to return in case on error occurs during execution.
The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
(Inherited from Module.)
Public property Properties
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.)
Public property Remarks
Gets or sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
(Inherited from BaseModule.)
Public property ResizeMode
Gets or sets the resize mode.
Public property Result
Returns a reference to the module result
(Inherited from BaseModule.)
Public property ResultFormat
Gets or sets the resultformat.
(Inherited from Module.)
Public property ResultType
Gets or sets the type of the result.
(Inherited from BaseModule.)
Public property Rotate
Gets or sets the rotation angle in degrees.
Public property RotateBackColor
Gets or sets the background color after a rotation has occurred.
Public property State
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.)
Public property Status
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.)
Public property Style
Gets or sets the style attribute of the image.
Public property SXMLPath
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.)
Public property TimeoutSeconds
Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
(Inherited from BaseModule.)
Public property Title
Gets or sets the title property for the image.
Public property Trim
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.)
Public property TypeName
Gets the name of the Module type.
(Inherited from BaseModule.)
Public property UseFallbackImage
Gets or sets a value indicating whether to use a fallback image if the given location proves to be invalid.
Public property UserSetPropertyList
Gets the user-set property list.
(Inherited from BaseModule.)
Public property Whitespace
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.)
Public property Width
Gets or sets the image width.

Protected Properties

  Name Description
Protected property IContext
Gets a reference to the IContext interface.
(Inherited from BaseModule.)

Explicit Interface Implementations

See Also

Advanced