Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.Core Namespace > BaseModule Class > BaseModule Members
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 members.

Protected Constructors

  Name Description
Protected method BaseModule
Initializes a new instance of the BaseModule class.

Public Methods

  Name Description
Public method AddAIMRelation
Adds an item to the AIM relations collection.
Public method ApplyProperties
Applies the properties from the SXML processing environment into the current module.
Public method BeginExecute
Override this to execute code before Execute() is fired
Public method Capture
Passes an SXML subtree to the current module.
Public method CheckTimeout
Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()().
Public method Dispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public method DoPreparse
Check whether to preparse data in the given property.
Public method DoRecurseTag
Determines whether to recurse on a given tag
Public method EndExecute
Override this to execute code after Execute() is fired.
Public method Equals (Inherited from Object.)
Public method Execute
Executes the module. Should be overriden in deriving classes
Public method ExistsBuffer
Checks whether a local buffer exists.
Public method Find
Finds the specified child module.
Public method FindExtension
Finds an extension macro.
Public method GetAIMRelations
Gets a list of all outgoing AIM relations created by the macro.
Public method GetBuffer
Gets a local buffer.
Public method GetException
Returns the text message of the exception that has occurred.
Public method GetExceptionSmartsiteCode
Returns the Smartsite Error code of the exception that has occurred.
Public method GetExceptionString
Returns the full information of the exception that has occurred, including the stack trace.
Public method GetExceptionType
Returns the full Type name of the exception that has occurred.
Public method Static member GetExecutingMacro
Navigates up in the module hierarchy to find the executing macro module.
Public method GetHashCode (Inherited from Object.)
Public method GetInnerException
Returns the text message of the inner exception of the exception that has occurred.
Public method GetInnerExceptionSmartsiteCode
Returns Smartsite error code of the inner exception of the exception that has occurred.
Public method GetInnerExceptionString
Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
Public method GetInnerExceptionType
Returns the full Type name of the inner exception of the exception that has occurred.
Public method GetParameter Overloaded.
Public method GetParent Overloaded.
Public method Static member GetParentMacro<(Of <<'(T>)>>)
Gets the parent macro.
Public method GetResult Overloaded.
Public method GetType (Inherited from Object.)
Public method Initialize Overloaded.
Public method IsChildOf
Determines whether the module is a descendant of the given parent
Public method ParameterExists
Checks whether the given parameter/property is set.
Public method PreInitialize
Called just before initialization of the module
Public method ReadyExecuting
Executed after execution and result recursion is done.
Public method ScopeTerminated
Executed when the module is about to get out of scope.
Public method SetBuffer
Sets a local buffer.
Public method TestCondition
Tests whether to execute the module
Public method ThrowCurrentException
Makes Smartsite throw the current exception.
Public method ThrowInnerException
Makes Smartsite throw the inner exception.
Public method ToString (Inherited from Object.)

Protected Methods

  Name Description
Protected method Finalize (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method SetCurrentProperty
Sets the current property.

Public Fields

  Name Description
Public field Static member BaseContextType
Context type base

Protected Fields

  Name Description
Protected field DoExecute
Specifies whether to execute the module
Protected field ResolvingSaveBuffers
True when save buffers are evaluated.
Protected field savingUnformattedResult
True when save buffers are checked before formatting is applied, to facilitate unformated data to be saved.

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.

Public Events

  Name Description
Public event SetProperty
Event fired just before setting a property on the Module instance from the SXML processor.
Public event StatusChange
Event raised when the execution status changes.

Explicit Interface Implementations

See Also

Advanced