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

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.

Explicit Interface Implementations

See Also

Advanced