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 interface IModuleExec |
Visual Basic (Declaration) | Copy Code |
---|---|
Public Interface IModuleExec |
The type exposes the following members.
Public Methods
Name | Description | |
---|---|---|
AddAIMRelation |
Adds an item to the AIM relations collection.
|
|
Cancel |
Cancels the execution of the module
|
|
Capture |
Allows modules to process their inner SXML.
|
|
DoPreparse |
Check whether to preparse data in the given property.
|
|
DoRecurseTag |
Determines whether to recurse on a given tag
|
|
Find |
Finds the specified module by its Id
|
|
FinishExecute |
Finishes the execution of the module. Fired when the module result is tested for recursion.
|
|
GetParent | Overloaded. | |
Initialize |
Initializes the module
|
|
IsChildOf |
Determines whether the module is a descendant of the given parent
|
|
ScopeTerminated |
Executed when the module is about to get out of scope.
|
|
SetChildException |
Sets the exception raised by a module's child.
|
|
SetInitialized |
Triggers the Initialized status in the module.
|
|
SetProperty | Overloaded. | |
StartExecute |
Starts the module execution
|
|
TestCondition |
Tests whether to execute the module
|
Public Properties
Name | Description | |
---|---|---|
AcceptsInnerXml |
Returns true if the module currently accepts string data within the macro tags.
|
|
ChildModules |
Gets the child modules within the container.
|
|
ConditionMatched |
Must return true if TestCondition() matched.
|
|
Context |
Gets the context.
|
|
CurrentProperty |
Gets the property currently being set on the module.
|
|
HasParameterSection |
Returns true if the macro currently uses an SXML parameters section
|
|
Id |
Gets the Id of this module
|
|
InstructionSource |
Gets the instruction source.
|
|
IsCancelled |
Gets a value indicating whether the execution of the macro is cancelled.
|
|
IsSelfClosing |
Gets a value indicating whether this instance is self closing.
|
|
ModuleInfo |
Gets the module info.
|
|
ProcessingContext |
Gets the xml processing context.
|
|
Properties |
Gets the full list of properties as set when executing the module.
|
|
Result |
Returns a reference to the module result
|
|
ResultType |
Gets or sets the type of the result.
|
|
State |
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
|
|
Status |
Gets a value indicating the ModuleStatus of this module.
|
|
Trim |
Gets a value indicating how the whitespace is trimmed.
|
|
Whitespace |
Gets a value indicating whether to preserve whitespace.
|
Public Events
Name | Description | |
---|---|---|
StatusChange |
Event raised when the execution status changes.
|
See Also
Smartsite.Core Namespace