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 interface IModuleExec
Visual Basic (Declaration) Copy imageCopy Code
                                  Public Interface IModuleExec

The type exposes the following members.

Public Methods

  Name Description
Public method AddAIMRelation
Adds an item to the AIM relations collection.
Public method Cancel
Cancels the execution of the module
Public method Capture
Allows modules to process their inner SXML.
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 Find
Finds the specified module by its Id
Public method FinishExecute
Finishes the execution of the module. Fired when the module result is tested for recursion.
Public method GetParent Overloaded.
Public method Initialize
Initializes the module
Public method IsChildOf
Determines whether the module is a descendant of the given parent
Public method ScopeTerminated
Executed when the module is about to get out of scope.
Public method SetChildException
Sets the exception raised by a module's child.
Public method SetInitialized
Triggers the Initialized status in the module.
Public method SetProperty Overloaded.
Public method StartExecute
Starts the module execution
Public method TestCondition
Tests whether to execute the module

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
Public property ChildModules
Gets the child modules within the container.
Public property ConditionMatched
Must return true if TestCondition() matched.
Public property Context
Gets the context.
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 the Id of this module
Public property InstructionSource
Gets the instruction source.
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 ProcessingContext
Gets the xml processing context.
Public property Properties
Gets the full list of properties as set when executing the module.
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 Trim
Gets a value indicating how the whitespace is trimmed.
Public property Whitespace
Gets a value indicating whether to preserve whitespace.

Public Events

  Name Description
Public event StatusChange
Event raised when the execution status changes.

See Also

Advanced