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 ParametersHandler

Visual Basic (Declaration)	Copy Code
Public Class ParametersHandler

The type exposes the following members.

Public Constructors

	Name	Description
	ParametersHandler

Public Methods

	Name	Description
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from BaseModule.)
	ApplyProperties	Applies the properties from the SXML processing environment into the current module. (Inherited from BaseModule.)
	BeginExecute	Override this to execute code before Execute() is fired (Inherited from BaseModule.)
	Capture	Passes an SXML subtree to the current module. (Inherited from BaseModule.)
	CheckTimeout	Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()(). (Inherited from BaseModule.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from BaseModule.)
	DoPreparse	Check whether to preparse data in the given property. (Inherited from BaseModule.)
	DoRecurseTag	Determines whether to recurse on a given tag (Overrides BaseModule..::DoRecurseTag(XmlReader, IModuleExec).)
	EndExecute	Override this to execute code after Execute() is fired. (Inherited from BaseModule.)
	Equals	(Inherited from Object.)
	Execute	Execute the macro. Should be overridden by inherited class. (Overrides BaseModule..::Execute()()()().)
	ExistsBuffer	Checks whether a local buffer exists. (Inherited from BaseModule.)
	Find	Finds the specified child module. (Inherited from BaseModule.)
	FindExtension	Finds an extension macro. (Inherited from BaseModule.)
	GetAIMRelations	Gets a list of all outgoing AIM relations created by the macro. (Inherited from BaseModule.)
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetException	Returns the text message of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionSmartsiteCode	Returns the Smartsite Error code of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionString	Returns the full information of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetExceptionType	Returns the full Type name of the exception that has occurred. (Inherited from BaseModule.)
	GetHashCode	(Inherited from Object.)
	GetInnerException	Returns the text message of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionSmartsiteCode	Returns Smartsite error code of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionString	Returns the full information of the inner exception of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetInnerExceptionType	Returns the full Type name of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off). (Inherited from BaseModule.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetType	(Inherited from Object.)
	Initialize	Overloaded.
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	PreInitialize	Called just before initialization of the module (Inherited from BaseModule.)
	ReadyExecuting	Executed after execution and result recursion is done. (Inherited from BaseModule.)
	ScopeTerminated	Executed when the module is about to get out of scope. (Inherited from BaseModule.)
	SetBuffer	Sets a local buffer. (Inherited from BaseModule.)
	TestCondition	Tests whether to execute the module (Inherited from BaseModule.)
	ThrowCurrentException	Makes Smartsite throw the current exception. (Inherited from BaseModule.)
	ThrowInnerException	Makes Smartsite throw the inner exception. (Inherited from BaseModule.)
	ToString	Returns a String that represents the current Object. (Overrides Object..::ToString()()()().)

Protected Methods

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

Protected Fields

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

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. Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method. (Inherited from BaseModule.)
	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. They only improve the readability of the code. (Inherited from BaseModule.)
	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.)

Protected Properties

	Name	Description
	IContext	Gets a reference to the IContext interface. (Inherited from BaseModule.)
	ProcessingContext	Gets the xml processing context.

Public Events

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

Explicit Interface Implementations

	Name	Description
	IAIMModule..::..AIMRelations	(Inherited from BaseModule.)
	IModuleExec..::..Cancel	(Inherited from BaseModule.)
	IModuleExec..::..Context	(Inherited from BaseModule.)
	IModuleExec..::..FinishExecute	(Inherited from BaseModule.)
	IModuleExec..::..InstructionSource	(Inherited from BaseModule.)
	ISXMLInstruction..::..Name	(Inherited from BaseModule.)
	IModuleExec..::..SetChildException	(Inherited from BaseModule.)
	IModuleExec..::..SetInitialized	Triggers the Initialized status in the module. (Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..StartExecute	(Inherited from BaseModule.)

Syntax

Public Constructors

Public Methods

Protected Methods

Protected Fields

Public Properties

Protected Properties

Public Events

Explicit Interface Implementations

See Also