|
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 Code
|
|---|---|
public class ImageModule
|
|
| Visual Basic (Declaration) |
Copy Code
|
|---|---|
Public Class ImageModule
|
|
The type exposes the following members.
Public Constructors
| Name | Description | |
|---|---|---|
|
ImageModule |
Public Methods
| Name | Description | |
|---|---|---|
|
|
AddAIMRelation |
Adds an item to the AIM relations collection.
(Inherited from Module.) |
|
|
ApplyProperties |
Applies the properties from the SXML processing environment into the current module.
(Inherited from BaseModule.) |
|
|
BeginExecute |
Override this to execute code before Execute() is fired. (Inherited from Module.)Last point to add data to the Cache Signature. |
|
|
Capture |
Passes an SXML subtree to the current module.
(Inherited from BaseModule.) |
|
|
CheckTimeout |
Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()().
(Inherited from BaseModule.) |
|
|
ClearForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from BaseModule.) |
|
|
DoPreparse |
Check whether to preparse data in the given property.
(Inherited from BaseModule.) |
|
|
DoRecurseTag |
Determines whether to recurse on a given tag
|
|
|
EndExecute |
Override this to execute code after Execute() is fired.
(Inherited from Module.) |
|
|
Equals | (Inherited from Object.) |
|
|
EvaluatePropertyExpression |
Evaluates an expression in a property with Expression Syntax
(Inherited from Module.) |
|
|
Execute |
Execute the macro. Should be overridden by inherited class.
(Overrides Module..::Execute()()()().) |
|
|
ExecuteRawParameter |
Executes the data of a raw parameter.
(Inherited from Module.) |
|
|
ExistsBuffer |
Checks whether a local buffer exists.
(Inherited from BaseModule.) |
|
|
Find |
Finds the specified child module.
(Inherited from BaseModule.) |
|
|
FindExtension |
Finds an extension macro.
(Inherited from BaseModule.) |
|
|
GetAIMRelations |
Gets a list of all outgoing AIM relations created by the macro.
(Inherited from BaseModule.) |
|
|
GetAltText |
Gets the HTML alt text attribute of the image.
|
|
|
GetBuffer |
Gets a local buffer.
(Inherited from BaseModule.) |
|
|
GetClassName |
Gets the value for the HTML class attribute of the image.
|
|
|
GetException |
Returns the text message of the exception that has occurred.
(Inherited from BaseModule.) |
|
|
GetExceptionSmartsiteCode |
Returns the Smartsite Error code of the exception that has occurred.
(Inherited from BaseModule.) |
|
|
GetExceptionString |
Returns the full information of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.) |
|
|
GetExceptionType |
Returns the full Type name of the exception that has occurred.
(Inherited from BaseModule.) |
|
|
GetForcedResult |
Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
(Inherited from Module.) |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetImageId |
Gets the value for the HTML id attribute of the image.
|
|
|
GetInnerException |
Returns the text message of the inner exception of the exception that has occurred.
(Inherited from BaseModule.) |
|
|
GetInnerExceptionSmartsiteCode |
Returns Smartsite error code of the inner exception of the exception that has occurred.
(Inherited from BaseModule.) |
|
|
GetInnerExceptionString |
Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.) |
|
|
GetInnerExceptionType |
Returns the full Type name of the inner exception of the exception that has occurred.
(Inherited from BaseModule.) |
|
|
GetOnClick |
Gets the HTML onclick attribute of the image.
|
|
|
GetOutputColorDepth |
Gets the color depth of the output image.
|
|
|
GetOutputCommandOrder |
Gets the actual applied command order.
|
|
|
GetOutputFileSize |
Gets the file size in bytes of the output image.
|
|
|
GetOutputFileType |
Gets the file type of the output image.
|
|
|
GetOutputFrameCount |
Gets the number of frames in the output image.
|
|
|
GetOutputHeight |
Gets the calculated height of the output.
|
|
|
GetOutputLocation |
Gets the output location.
|
|
|
GetOutputResolutionUnit |
Gets the resolution unit of the output image.
|
|
|
GetOutputResolutionX |
Gets the horizontal resolution of the output image.
|
|
|
GetOutputResolutionY |
Gets the vertical resolution of the output image.
|
|
|
GetOutputStyle |
Gets the calculated output style. Returns null if parameter AddStyle is false.
|
|
|
GetOutputWidth |
Gets the calculated width of the output.
|
|
|
GetParameter |
Gets the value of the given parameter/property.
(Inherited from BaseModule.) |
|
|
GetParameter |
Gets the value of the given parameter/property.
(Inherited from BaseModule.) |
|
|
GetParent |
Gets the parent Module of this module.
(Inherited from BaseModule.) |
|
|
GetParent |
Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off).
(Inherited from BaseModule.) |
|
|
GetRenderTime |
Returns the render time of the macro in milliseconds.
(Inherited from Module.) |
|
|
GetResult |
Returns the result of the macro. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
|
GetResult |
Returns the result of the macro. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
|
GetTitle |
Gets the title attribute of the image.
|
|
|
GetType | (Inherited from Object.) |
|
|
Initialize | Overloaded. |
|
|
IsChildOf |
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.) |
|
|
ParameterExists |
Checks whether the given parameter/property is set.
(Inherited from BaseModule.) |
|
|
PreInitialize |
Called just before initialization of the module
(Overrides Module..::PreInitialize(IContext, IProcessingContext).) |
|
|
ReadyExecuting |
Method that is called after the module has executed.
(Inherited from Module.) |
|
|
ScopeTerminated |
Executed when the module is about to get out of scope.
(Inherited from BaseModule.) |
|
|
SetBuffer |
Sets a local buffer.
(Inherited from BaseModule.) |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
TestCondition |
Tests whether execution should take place based on the expression in the condition property
(Inherited from Module.) |
|
|
TestPropertyExpression |
Tests whether an expression in a property with Expression Syntax evaluates to true.
(Inherited from Module.) |
|
|
ThrowCurrentException |
Makes Smartsite throw the current exception.
(Inherited from BaseModule.) |
|
|
ThrowInnerException |
Makes Smartsite throw the inner exception.
(Inherited from BaseModule.) |
|
|
ToString |
Returns a string that represents the current macro.
(Inherited from Module.) |
|
|
ToString | (Inherited from Module.) |
|
TransformImage |
Transforms the specified image using the specified commands.
|
|
|
TransformImageBytes |
Transforms the specified image using the specified commands.
|
Protected Methods
| Name | Description | |
|---|---|---|
|
Finalize | (Inherited from Object.) |
|
|
IsBufferName |
Determines whether the data is a buffer name.
(Inherited from Module.) |
|
|
IsSingleSaveBuffername |
Determines whether a single save buffername is used.
(Inherited from Module.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
SetCurrentProperty |
Sets the current property.
(Inherited from BaseModule.) |
Protected Fields
| Name | Description | |
|---|---|---|
|
DoExecute |
Specifies whether to execute the module
(Inherited from BaseModule.) |
|
|
InternalAIMMode |
Cotnains the internal AIM mode.
(Inherited from Module.) |
|
|
InternalCopyFormatting |
The id of the macro to copy the formatting settings from.
(Inherited from Module.) |
|
|
InternalFormatting |
Formatting settings.
(Inherited from Module.) |
|
|
ResolvingSaveBuffers |
True when save buffers are evaluated.
(Inherited from BaseModule.) |
|
|
savingUnformattedResult |
True when save buffers are checked before formatting is applied, to facilitate unformated data to be saved.
(Inherited from BaseModule.) |
Public Properties
| Name | Description | |
|---|---|---|
|
AcceptsInnerXml |
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.) |
|
|
AccessDeniedReturnValue |
Gets or sets the value that is returned when the site visitor has insufficient access.
(Inherited from Module.) |
|
|
AddStyle |
Gets or sets a value indicating whether to add a style attribute to the output.
|
|
|
AIMMode |
Gets or sets the AIM scanning mode of the macro.
(Inherited from Module.) |
|
|
AIMOrigin |
Returns the current AIM source.
If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item.
(Inherited from Module.) |
|
|
AltText |
Gets or sets the alt text property for the image.
|
|
|
AspectRatio |
Gets or sets a value indicating whether to keep the aspect ratio when the image is resized.
|
|
|
AutoTitle |
Gets or sets a value indicating whether to automatically copy a title attribute from the AltText, if not specified.
|
|
|
BufferNames |
Gets or sets the buffer names.
(Inherited from Module.) |
|
|
ClassName |
Gets or sets the class name attribute of the image.
|
|
|
CommandOrder |
Gets or sets the order in which the image commands are being applied.
|
|
|
Condition |
Gets or sets the Viper expression to evaluate before actually executing the macro. (Inherited from Module.)If the expression returns false, the execution of the module and its child modules is skipped. |
|
|
ConditionMatched |
Must return true if TestCondition() matched.
(Inherited from Module.) |
|
|
CropBottom |
Gets or sets the crop bottom.
|
|
|
CropHeight |
Gets or sets the height of the crop.
|
|
|
CropLeft |
Gets or sets the crop left.
|
|
|
CropRight |
Gets or sets the crop right.
|
|
|
CropTop |
Gets or sets the crop top.
|
|
|
CropWidth |
Gets or sets the width of the crop.
|
|
|
CurrentCacheModule |
Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block.
(Inherited from Module.) |
|
|
CurrentProperty |
Gets the property currently being set on the module.
(Inherited from BaseModule.) |
|
|
DefaultValue |
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.) |
|
|
DuoToneTint |
Gets or sets the tint color of the duo tone effect.
|
|
|
FallbackImage |
Sets the location for the image to be used when the image specified in the Location parameter cannot be found.
|
|
|
FileType |
Gets or sets the file type of the image. Possible values are define in the imageFileTypes collection in the Smartsite.ImageProcessor.config file.
|
|
|
Formatting |
Gets the formatting options.
(Inherited from Module.) |
|
|
Grayscale |
Gets or sets a value indicating whether this generated image is grayscale.
|
|
|
HasParameterSection |
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.) |
|
|
Height |
Gets or sets the image height.
|
|
|
Id |
Gets or sets the unique id of the module instance during the current processing. (Inherited from BaseModule.)Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method. |
|
|
ImageId |
Gets or sets the id attribute of the image.
|
|
|
InputData |
Gets or sets the input data. This must be a datatable containing the image.
|
|
|
IsCancelled |
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.) |
|
|
IsSelfClosing |
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.) |
|
|
JpgQuality |
Sets the JPG quality.
|
|
|
LocalId |
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.) |
|
|
Location |
Sets the location of the image. This can be either a smartsite item or a site file.
|
|
|
MaxHeight |
Gets or sets the maximum height.
|
|
|
MaxWidth |
Gets or sets the maximum width.
|
|
|
MinHeight |
Gets or sets the minimum height.
|
|
|
MinimumAccessTypeLevel |
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.) |
|
|
MinWidth |
Gets or set the minimum width.
|
|
|
Mirror |
Gets or sets the mirror type.
|
|
|
ModuleInfo |
Gets the module info.
(Inherited from BaseModule.) |
|
|
OilPaint |
Gets or sets a value indicating whether to apply the oil paint effect.
|
|
|
OnClick |
Gets or sets the onclick attribute of the image.
|
|
|
OnErrorReturnValue |
Gets or sets the value to return in case on error occurs during execution. (Inherited from Module.)The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context. |
|
|
Properties |
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.) |
|
|
Remarks |
Gets or sets the remarks. Remarks have no effect on the actual execution of the module. (Inherited from BaseModule.)They only improve the readability of the code. |
|
|
ResizeMode |
Gets or sets the resize mode.
|
|
|
Result |
Returns a reference to the module result
(Inherited from BaseModule.) |
|
|
ResultFormat |
Gets or sets the resultformat.
(Inherited from Module.) |
|
|
ResultType |
Gets or sets the type of the result.
(Inherited from BaseModule.) |
|
|
Rotate |
Gets or sets the rotation angle in degrees.
|
|
|
RotateBackColor |
Gets or sets the background color after a rotation has occurred.
|
|
|
State |
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.) |
|
|
Status |
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.) |
|
|
Style |
Gets or sets the style attribute of the image.
|
|
|
SXMLPath |
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.) |
|
|
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.) |
|
|
Title |
Gets or sets the title property for the image.
|
|
|
Trim |
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.) |
|
|
TypeName |
Gets the name of the Module type.
(Inherited from BaseModule.) |
|
|
UseFallbackImage |
Gets or sets a value indicating whether to use a fallback image if the given location proves to be invalid.
|
|
|
UserSetPropertyList |
Gets the user-set property list.
(Inherited from BaseModule.) |
|
|
Whitespace |
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.) |
|
|
Width |
Gets or sets the image width.
|
Protected Properties
| Name | Description | |
|---|---|---|
|
IContext |
Gets a reference to the IContext interface.
(Inherited from BaseModule.) |
Public Events
| Name | Description | |
|---|---|---|
|
SetProperty |
Event fired just before setting a property on the Module instance from the SXML processor.
(Inherited from BaseModule.) |
|
|
StatusChange |
Event raised when the execution status changes. (Inherited from BaseModule.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
|
IAIMModule..::..AIMRelations | (Inherited from BaseModule.) |
|
IModuleExec..::..Cancel | (Inherited from BaseModule.) |
|
|
IModuleExec..::..Context | |
|
|
IModuleExec..::..FinishExecute | (Inherited from BaseModule.) |
|
|
IModuleExec..::..InstructionSource | (Inherited from BaseModule.) |
|
|
ISXMLInstruction..::..Name | (Inherited from BaseModule.) |
|
|
IModuleExec..::..ProcessingContext | |
|
|
IModuleExec..::..SetChildException | (Inherited from BaseModule.) |
|
|
IModuleExec..::..SetInitialized |
Triggers the Initialized status in the module.
(Inherited from BaseModule.) |
|
|
IModuleExec..::..SetProperty | (Inherited from BaseModule.) |
|
|
IModuleExec..::..SetProperty | (Inherited from BaseModule.) |
|
|
IModuleExec..::..StartExecute | (Inherited from BaseModule.) |
See Also
Smartsite.ImageProcessor.Modules Namespace