|
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 abstract class Module
|
|
| Visual Basic (Declaration) |
Copy Code
|
|---|---|
Public MustInherit Class Module
|
|
The type exposes the following methods.
Public Methods
| Name | Description | |
|---|---|---|
|
AddAIMRelation |
Adds an item to the AIM relations collection.
(Overrides BaseModule..::AddAIMRelation(AIMReference).) |
|
|
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. (Overrides BaseModule..::BeginExecute()()()().)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.
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.
(Overrides BaseModule..::EndExecute()()()().) |
|
|
Equals | (Inherited from Object.) |
|
|
EvaluatePropertyExpression |
Evaluates an expression in a property with Expression Syntax
|
|
|
Execute |
Execute the macro. Should be overridden by inherited class.
(Overrides BaseModule..::Execute()()()().) |
|
|
ExecuteRawParameter |
Executes the data of a raw parameter.
|
|
|
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.) |
|
|
GetBuffer |
Gets a local buffer.
(Inherited from BaseModule.) |
|
|
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().
|
|
|
GetHashCode | (Inherited from Object.) |
|
|
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.) |
|
|
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.
|
|
|
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. |
|
|
GetType | (Inherited from Object.) |
|
|
Initialize |
Called to initialize this Module
(Inherited from BaseModule.) |
|
|
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 BaseModule..::PreInitialize(IContext, IProcessingContext).) |
|
|
ReadyExecuting |
Method that is called after the module has executed.
(Overrides BaseModule..::ReadyExecuting()()()().) |
|
|
ScopeTerminated |
Executed when the module is about to get out of scope.
(Inherited from BaseModule.) |
|
|
SetBuffer |
Sets a local buffer.
(Inherited from BaseModule.) |
|
|
SetForcedResult | Overloaded. |
|
|
TestCondition |
Tests whether execution should take place based on the expression in the condition property
(Overrides BaseModule..::TestCondition()()()().) |
|
|
TestPropertyExpression |
Tests whether an expression in a property with Expression Syntax evaluates to true.
|
|
|
ThrowCurrentException |
Makes Smartsite throw the current exception.
(Inherited from BaseModule.) |
|
|
ThrowInnerException |
Makes Smartsite throw the inner exception.
(Inherited from BaseModule.) |
|
|
ToString | Overloaded. |
Protected Methods
| Name | Description | |
|---|---|---|
|
Finalize | (Inherited from Object.) |
|
|
IsBufferName |
Determines whether the data is a buffer name.
|
|
|
IsSingleSaveBuffername |
Determines whether a single save buffername is used.
|
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
SetCurrentProperty |
Sets the current property.
(Inherited from BaseModule.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
|
IModuleExec..::..Cancel | (Inherited from BaseModule.) |
|
|
IModuleExec..::..FinishExecute | (Inherited from BaseModule.) |
|
|
IModuleExec..::..Initialize | (Inherited from BaseModule.) |
|
|
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.Core Namespace