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 class CollectionHandler |
Visual Basic (Declaration) | Copy Code |
---|---|
Public Class CollectionHandler |
The type exposes the following properties.
Public Properties
Name | Description | |
---|---|---|
AcceptsInnerXml |
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.) |
|
AIMMode |
Gets or sets the AIM scanning mode of the macro.
(Inherited from BaseModule.) |
|
ConditionMatched |
Must return true if TestCondition() matched.
(Inherited from BaseModule.) |
|
CurrentProperty |
Gets the property currently being set on the module.
(Inherited from BaseModule.) |
|
HasParameterSection |
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.) |
|
Id |
Gets or sets the unique id of the module instance during the current processing. (Inherited from BaseModule.)Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method. |
|
InputData |
Gets or sets the input data.
|
|
IsCancelled |
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.) |
|
IsSelfClosing |
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.) |
|
ModuleInfo |
Gets the module info.
(Inherited from BaseModule.) |
|
Properties |
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.) |
|
Remarks |
Gets or sets the remarks. Remarks have no effect on the actual execution of the module. (Inherited from BaseModule.)They only improve the readability of the code. |
|
Result |
Returns a reference to the module result
(Inherited from BaseModule.) |
|
ResultType |
Gets or sets the type of the result.
(Inherited from BaseModule.) |
|
State |
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.) |
|
Status |
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.) |
|
SXMLPath |
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.) |
|
TimeoutSeconds |
Gets or sets the timeout in seconds.
In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
(Inherited from BaseModule.) |
|
Trim |
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.) |
|
TypeName |
Gets the name of the Module type.
(Inherited from BaseModule.) |
|
UserSetPropertyList |
Gets the user-set property list.
(Inherited from BaseModule.) |
|
Whitespace |
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.) |
|
Xml |
Gets or sets the XML.
|
Protected Properties
Name | Description | |
---|---|---|
IContext |
Gets a reference to the IContext interface.
(Inherited from BaseModule.) |
|
ProcessingContext |
Gets the xml processing context.
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
IAIMModule..::..AIMRelations | (Inherited from BaseModule.) | |
IModuleExec..::..Context | (Inherited from BaseModule.) | |
IModuleExec..::..InstructionSource | (Inherited from BaseModule.) | |
ISXMLInstruction..::..Name | (Inherited from BaseModule.) |
See Also
Smartsite.Core Namespace