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 BaseModule |
Visual Basic (Declaration) | Copy Code |
---|---|
Public MustInherit Class BaseModule |
The type exposes the following properties.
Public Properties
Name | Description | |
---|---|---|
AcceptsInnerXml |
Returns true if the module currently accepts string data within the macro tags.
|
|
AIMMode |
Gets or sets the AIM scanning mode of the macro.
|
|
ConditionMatched |
Must return true if TestCondition() matched.
|
|
CurrentProperty |
Gets the property currently being set on the module.
|
|
HasParameterSection |
Returns true if the macro currently uses an SXML parameters section
|
|
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. |
|
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.
|
|
Properties |
Gets the full list of properties as set when executing the module.
|
|
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. |
|
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.
|
|
SXMLPath |
Gets the path to the macro in the current execution stack.
|
|
TimeoutSeconds |
Gets or sets the timeout in seconds.
In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
|
|
Trim |
Gets a value indicating how the whitespace is trimmed.
|
|
TypeName |
Gets the name of the Module type.
|
|
UserSetPropertyList |
Gets the user-set property list.
|
|
Whitespace |
Gets a value indicating whether to preserve whitespace.
|
Protected Properties
Name | Description | |
---|---|---|
IContext |
Gets a reference to the IContext interface.
|
|
ProcessingContext |
Gets the xml processing context.
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
IAIMModule..::..AIMRelations | ||
IModuleExec..::..Context | ||
IModuleExec..::..InstructionSource | ||
ISXMLInstruction..::..Name |
See Also
Smartsite.Core Namespace