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 imageCopy Code
                                  public abstract class BaseModule
Visual Basic (Declaration) Copy imageCopy Code
                                  Public MustInherit Class BaseModule

The type exposes the following properties.

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
Public property AIMMode
Gets or sets the AIM scanning mode of the macro.
Public property ConditionMatched
Must return true if TestCondition() matched.
Public property CurrentProperty
Gets the property currently being set on the module.
Public property HasParameterSection
Returns true if the macro currently uses an SXML parameters section
Public property 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.
Public property IsCancelled
Gets a value indicating whether the execution of the macro is cancelled.
Public property IsSelfClosing
Gets a value indicating whether this instance is self closing.
Public property ModuleInfo
Gets the module info.
Public property Properties
Gets the full list of properties as set when executing the module.
Public property 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.
Public property Result
Returns a reference to the module result
Public property ResultType
Gets or sets the type of the result.
Public property State
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
Public property Status
Gets a value indicating the ModuleStatus of this module.
Public property SXMLPath
Gets the path to the macro in the current execution stack.
Public property TimeoutSeconds
Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
Public property Trim
Gets a value indicating how the whitespace is trimmed.
Public property TypeName
Gets the name of the Module type.
Public property UserSetPropertyList
Gets the user-set property list.
Public property Whitespace
Gets a value indicating whether to preserve whitespace.

Protected Properties

  Name Description
Protected property IContext
Gets a reference to the IContext interface.
Protected property ProcessingContext
Gets the xml processing context.

Explicit Interface Implementations

See Also

Advanced