Renders an HTML image tag including ImageProcessor parameters.Renders an HTML image tag including ImageProcessor parameters.

Syntax

Smartsite SXML CopyCode image Copy Code
<se:image />

Parameters

Name Data Type Properties Description
AddStyle Boolean - Sets a value indicating whether to add a style attribute to the output.
AltText String - Sets the alt text property for the image.
AspectRatio Boolean - Sets a value indicating whether to keep the aspect ratio when the image is resized.
AutoTitle Boolean - Sets a value indicating whether to automatically copy a title attribute from the AltText, if not specified.
ClassName String - Sets the class name attribute of the image.
CommandOrder Enum - Sets the order in which the image commands are being applied.
Enum values:
  • CropRotateScaleMirrorFirst
    Crop, rotate, scale, mirror + rest in order as defined in configuration This is the default order
  • RotateCropScaleMirrorFirst
    Rotate, crop, scale, mirror + rest in order as defined in configuration
  • Appearance
    Order of appearance in request query string + rest in order as defined in configuration This order is the only option where image commands may appear more than once
  • Configuration
    Order as appears in configuration
CropBottom Integer - Sets the crop bottom.
CropHeight Integer - Sets the height of the crop.
CropLeft Integer - Sets the crop left.
CropRight Integer - Sets the crop right.
CropTop Integer - Sets the crop top.
CropWidth Integer - Sets the width of the crop.
DuoToneTint String - Sets the tint color of the duo tone effect.
FallbackImage Locator - Sets the location for the image to be used when the image specified in the Location parameter cannot be found.
FileType String - Sets the file type of the image. Possible values are define in the imageFileTypes collection in the Smartsite.ImageProcessor.config file.
Grayscale Boolean - Sets a value indicating whether this generated image is grayscale.
Height Integer - Sets the image height.
ImageId String - Sets the id attribute of the image.
InputData DataTable - Sets the input data. This must be a datatable containing the image.
JpgQuality Integer - Sets the JPG quality.
Location Locator - Sets the location of the image. This can be either a smartsite item or a site file.
MaxHeight Integer - Sets the maximum height.
MaxWidth Integer - Sets the maximum width.
MinHeight Integer - Sets the minimum height.
MinWidth Integer - Gets or set the minimum width.
Mirror Enum - Sets the mirror type.
Enum values:
  • None
    No mirroring
  • Horizontal
    Horizontal
  • Vertical
    Vertical
  • Both
    Both horizontal and vertical
OilPaint Boolean - Sets a value indicating whether to apply the oil paint effect.
OnClick String - Sets the onclick attribute of the image.
ResizeMode Enum - Sets the resize mode.
Enum values:
  • Default
    Default
  • NearestNeighbor
    Nearest neighbor
  • BiLinear
    BiLinear
  • BiCubic
    BiCubic
  • AreaAverage
    Area average
  • BoxFilter
    Box filter
  • TriangleFilter
    Triangle filter
  • HammingFilter
    Hamming filter
  • GaussianFilter
    Gaussian filter
  • BellFilter
    Bell filter
  • BsplineFilter
    Bspline filter
  • Cubic1Filter
    Cubic1 filter
  • Cubic2Filter
    Cubic2 filter
  • LanczosFilter
    Lanczos filter
  • MitchellFilter
    Mitchell filter
  • SincFilter
    Sinc filter
  • HermiteFilter
    Hermite filter
  • HanningFilter
    Hanning filter
  • CatromFilter
    Catrom filter
Rotate Float - Sets the rotation angle in degrees.
RotateBackColor String - Sets the background color after a rotation has occurred.
Style String - Sets the style attribute of the image.
Title String - Sets the title property for the image.
UseFallbackImage Boolean - Sets a value indicating whether to use a fallback image if the given location proves to be invalid.
Width Integer - Sets the image width.

Shared Parameters

Name Data Type Properties Description
Access String - Friendly name of the minimum access type level required by the site visitor to execute this macro.
AccessDenied String RawData
Sets the value that is returned when the site visitor has insufficient access.
AIM Enum - Sets the AIM scanning mode of the macro.
Enum values:
  • NotSet
    Not set.
  • Off
    No AIM scanning.
  • External
    Output XML scanning.
  • Internal
    Internal scanning, implemented by AIM-aware macros.
  • Autonomous
    Relations are to be linked to the current source item, instead of the rendered page.
  • SoftLink
    Should generate soft links (in combination with External flag).
  • InternalAutonomous
    Internal scanning, combined with the Autonomous setting.
  • ExternalAutonomous
    External scanning, combined with the Autonomous setting.
  • ExternalAutonomousSoftLink
    External scanning, combined with the Autonomous and softLink settings.
  • ExternalSoftLink
    External scanning, combined with the Softlink setting.
Condition String MustBeAttribute
ExpressionSyntax
XmlDecode
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.
Default String RawData
Sets the default value that will be returned when the execution would otherwise return an empty string.
Error String RawData
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.
Id String MustBeAttribute
Trim
Sets the Id of the macro. Macros with Ids set can be accessed using Viper by referring to page.[id].[methodname()].
LocalId String MustBeAttribute
Trim
Sets the local id of the macro in the current buffer scope.
Rem String RawData
NoCache
Trim
Sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
ResultFormat String RawData
Sets the resultformat.
ResultType Enum - Sets the type of the result.
Enum values:
  • Undefined
    Not set
  • None
    No result
  • String
    Default type
  • Object
    Generic object
  • Binary
    Binary data
  • Boolean
    Boolean
  • DataTable
    DataTable
  • DateTime
    Date/time
  • Float
    Floating point numeric data
  • Integer
    Integer
  • Locator
    Extended Uri
  • Xml
    Xml Data
Save Collection - Sets the buffer names.
Status Enum - Gets a value indicating the ModuleStatus of this module.
Enum values:
  • Unknown
    Unknown
  • BeginInitialize
    Initializing the module
  • EndInitialize
    Module has fully initialized
  • BeginSetProperties
    Properties are about to be set
  • EndSetProperties
    Properties have been set
  • BeginExecute
    Execution starts
  • BeginFormatData
    Starting data formatting.
  • EndFormatData
    Ended data formatting.
  • BeginFormatResult
    Before formating result.
  • EndFormatResult
    After formatting result
  • EndExecute
    Execution is ending
  • StartLoseScope
    Execution has completed
  • EndLoseScope
    Module is about to unload
  • Error
    Module is in an error state
Timeout Float - Sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
Trim Enum MustBeAttribute
Gets a value indicating how the whitespace is trimmed.
Whitespace Enum MustBeAttribute
Gets a value indicating whether to preserve whitespace.
Enum values:
  • Inherit
    Inherit from parent.
  • Preserve
    Keep all whitespace.
  • Remove
    Remove all whitespace.
  • Normalize
    Convert all whitespace to single spaces.
  • SimpleFormat
    Convert all whitespace to single spaces, but keep single line breaks.

Local Viper Methods

Viper Extension Description
This.AltText   Gets the HTML alt text attribute of the image.
This.AutoTitle   Gets a value indicating whether to automatically copy a title attribute from the AltText, if not specified.
This.ClassName   Gets the value for the HTML class attribute of the image.
This.ClearForcedResult   Sets the result of the macro.
used to override the normal handling of the result creation.
This.GetForcedResult   Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
This.ImageId   Gets the value for the HTML id attribute of the image.
This.OnClick   Gets the HTML onclick attribute of the image.
This.OutputColorDepth   Gets the color depth of the output image.
This.OutputCommandOrder   Gets the actual applied command order.
This.OutputFileSize   Gets the file size in bytes of the output image.
This.OutputFileType   Gets the file type of the output image.
This.OutputFrameCount   Gets the number of frames in the output image.
This.OutputHeight   Gets the calculated height of the output.
This.OutputLocation   Gets the output location.
This.OutputResolutionUnit   Gets the resolution unit of the output image.
This.OutputResolutionX   Gets the horizontal resolution of the output image.
This.OutputResolutionY   Gets the vertical resolution of the output image.
This.OutputStyle   Gets the calculated output style. Returns null if parameter AddStyle is false.
This.OutputWidth   Gets the calculated width of the output.
This.RenderTime Returns the render time of the macro in milliseconds.
This.SetForcedResult   Sets the result of the macro.
used to override the normal handling of the result creation.
This.Title   Gets the title attribute of the image.

Shared Local Viper Methods

Viper Extension Description
This.AIM.Relations Gets a list of all outgoing AIM relations created by the macro.
This.Buffer.Exists   Checks whether a local buffer exists.
This.Buffer.Get   Gets a local buffer.
This.Buffer.Set   Sets a local buffer.
This.Error.InnerException.Message   Returns the text message of the inner exception of the exception that has occurred.
This.Error.InnerException.SmartsiteCode   Returns Smartsite error code of the inner exception of the exception that has occurred.
This.Error.InnerException.Throw   Makes Smartsite throw the inner exception.
This.Error.InnerException.ToString   Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
This.Error.InnerException.Type   Returns the full Type name of the inner exception of the exception that has occurred.
This.Error.Message   Returns the text message of the exception that has occurred.
This.Error.SmartsiteCode   Returns the Smartsite Error code of the exception that has occurred.
This.Error.Throw   Makes Smartsite throw the current exception.
This.Error.ToString   Returns the full information of the exception that has occurred, including the stack trace.
This.Error.Type   Returns the full Type name of the exception that has occurred.
This.FindExtension   Finds an extension macro.
This.GetParameter Gets the value of the given parameter/property.
This.ParameterExists Checks whether the given parameter/property is set.
This.Result   Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
This.SXMLPath   Gets the path to the macro in the current execution stack.

Expand image Remarks

Expand image AIM

Expand image Examples

Expand image See Also

SXML