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 sealed class CmsViperModule

Visual Basic (Declaration)	Copy Code
Public NotInheritable Class CmsViperModule

The type exposes the following members.

Public Methods

	Name	Description
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	AddAssetItem	Overloaded.
	AddAssetItemFromXml	Adds an Asset Item.
	AddMultipleAssetItems	Creates multiple asset items from the urls specified within the xml data.
	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. Last point to add data to the Cache Signature. (Inherited from Module.)
	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.)
	ChildCount	Returns the number of direct children of the given item
	ClearForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	ContentTypes	Gets the content types.
	DeleteAssetFiles	Deletes the specified Asset Items and any referenced files.
	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
	EndExecute	Override this to execute code after Execute() is fired. (Inherited from Module.)
	Equals	(Inherited from Object.)
	EvaluatePropertyExpression	Evaluates an expression in a property with Expression Syntax (Inherited from Module.)
	Execute	Execute the macro. Should be overridden by inherited class. (Inherited from Module.)
	ExecuteRawParameter	Executes the data of a raw parameter. (Inherited from Module.)
	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.)
	GetAssetDerivedItem	Overloaded.
	GetAssetDerivedItems	Returns all derived images for a given asset.
	GetAssetFolderConfigurationNode	Gets the Asset Folder configuration xml for the specified asset folder.
	GetAssetFolderNameByRootItem	Gets the Asset Folder Name for the specified Asset Root Item.
	GetAssetItemNumber	Returns the item number of the corresponding asset item when the specified location refers to an asset item.
	GetAssetLocation	Gets the Asset location for the specified item.
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetChild	Overloaded.
	GetChildren	Gets the children of the specified item.
	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.)
	GetForcedResult	Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult(). (Inherited from Module.)
	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.)
	GetIsInSubTreeWhereClause	Overloaded.
	GetItemByTitlePath	Overloaded.
	GetItemCode	Returns the item code of the item with the given number.
	GetItemNumber	Overloaded.
	GetLevel	Returns the hierarchic depth of the given item.
	GetLocalItemCode	Returns the publication-independant part of the item code.
	GetNotInSubTreeWhereClause	Overloaded.
	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	Overloaded.
	GetParentItem	Returns the item number of the item's parent.
	GetPublication	Overloaded.
	GetPublicationChannel	Overloaded.
	GetRenderTime	Returns the render time of the macro in milliseconds. (Inherited from Module.)
	GetRepository	Overloaded.
	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.)
	GetSourceLocation	Gets the Asset source location for the specified item. If not available or empty, the Asset location is returned.
	GetSubTreeItemNumber	Gets the closest related sub tree for the given item.
	GetSubTreesList	Gets a list of all sub trees the given item belongs to.
	GetTranslationArg	Overloaded.
	GetTranslationArgCount	Returns the number of unnamed arguments to the translation. Valid only within the 'replacement' field in translation items.
	GetTranslationBase	Returns the contents of the translation the current translation overrides. Valid only within the 'replacement' field in translation items.
	GetTranslationCaller	Overloaded.
	GetTranslationName	Returns the name of the current translation. Valid only within the 'replacement' field in translation items.
	GetTranslationNumber	Returns the item number of the current translation. Valid only within the 'replacement' field in translation items.
	GetTranslationOutParameter	Gets the given out parameter value. Valid only within the 'replacement' field in translation items.
	GetTranslationScopeNew	Returns the scope of the current translation. Valid only within the 'replacement' field in translation items.
	GetType	(Inherited from Object.)
	Initialize	Called to initialize this Module (Inherited from BaseModule.)
	IsAssetItemReference	Determines if the specified location refers to an Asset Item.
	IsChildOf	Overloaded.
	IsDeleteAllowed	Determines if the specified Asset Item's AssetFolder configuration allows deletion of items.
	IsDescendantOf	Returns true if the given item is a child of the given parent.
	IsFolderItem	Returns true if the given item is a folder.
	IsMemberOfAnySubTrees	Determines whether the specified item is a member of any of the given sub trees.
	IsMemberOfSpecifiedSubTree	Determines whether the specified item is a member of the given sub tree.
	IsTranslationPreview	Determines whether the current translation is being previewed using its own logic.
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	ReturnFromTranslation	Returns immediately from a translation, with the given result. Note that standard replacement output of the translation will not be used when using translation.return(). You must use translation.setresult(), translation.setnullresult(), or the returnValue argument of translation.return().
	ScopeTerminated	Executed when the module is about to get out of scope. (Inherited from BaseModule.)
	SetBuffer	Sets a local buffer. (Inherited from BaseModule.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetTranslationNullResult	Sets the current translation result to null, allowing the default parameter of the translation call to work. Valid only within the 'replacement' field in translation items.
	SetTranslationOutParameter	Sets the given out parameter value. Valid only within the 'replacement' field in translation items.
	SetTranslationResult	Sets the current translation result to the given value. Overrules the standard output a translation generates. Valid only within the 'replacement' field in translation items.
	StartSynchronize	Starts the AssetFolder synchronization (through the configured scheduled job).
	TestCondition	Tests whether execution should take place based on the expression in the condition property (Inherited from Module.)
	TestPropertyExpression	Tests whether an expression in a property with Expression Syntax evaluates to true. (Inherited from Module.)
	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 macro. (Inherited from Module.)
	ToString	Returns a String that represents the current Object. (Inherited from Module.)
	UpdateAssetItem	Updates an Asset Item.
	ValidateFile	Validates the specified file.

Protected Methods

	Name	Description
	Finalize	(Inherited from Object.)
	IsBufferName	Determines whether the data is a buffer name. (Inherited from Module.)
	IsSingleSaveBuffername	Determines whether a single save buffername is used. (Inherited from Module.)
	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.)
	InternalAIMMode	Cotnains the internal AIM mode. (Inherited from Module.)
	InternalCopyFormatting	The id of the macro to copy the formatting settings from. (Inherited from Module.)
	InternalFormatting	Formatting settings. (Inherited from Module.)
	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.)
	AccessDeniedReturnValue	Gets or sets the value that is returned when the site visitor has insufficient access. (Inherited from Module.)
	AIMMode	Gets or sets the AIM scanning mode of the macro. (Inherited from Module.)
	AIMOrigin	Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item. (Inherited from Module.)
	BufferNames	Gets or sets the buffer names. (Inherited from Module.)
	Condition	Gets or sets the Viper expression to evaluate before actually executing the macro. If the expression returns false, the execution of the module and its child modules is skipped. (Inherited from Module.)
	ConditionMatched	Must return true if TestCondition() matched. (Inherited from Module.)
	CurrentCacheModule	Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block. (Inherited from Module.)
	CurrentProperty	Gets the property currently being set on the module. (Inherited from BaseModule.)
	DefaultValue	Gets or sets the default value that will be returned when the execution would otherwise return an empty string. (Inherited from Module.)
	Formatting	Gets the formatting options. (Inherited from Module.)
	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.)
	LocalId	Gets or sets the local id of the macro in the current buffer scope. (Inherited from Module.)
	MinimumAccessTypeLevel	Friendly name of the minimum access type level required by the site visitor to execute this macro. (Inherited from Module.)
	ModuleInfo	Gets the module info. (Inherited from BaseModule.)
	OnErrorReturnValue	Gets or sets the value to return in case on error occurs during execution. The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context. (Inherited from Module.)
	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.)
	ResultFormat	Gets or sets the resultformat. (Inherited from Module.)
	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.)

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
	IModuleExec..::..FinishExecute	(Inherited from BaseModule.)
	IModuleExec..::..Initialize	(Inherited from BaseModule.)
	IModuleExec..::..InstructionSource	(Inherited from BaseModule.)
	ISXMLInstruction..::..Name	(Inherited from BaseModule.)
	IModuleExec..::..ProcessingContext
	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 Methods

Protected Methods

Protected Fields

Public Properties

Protected Properties

Public Events

Explicit Interface Implementations

See Also