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 sealed class CmsViperModule
Visual Basic (Declaration) Copy imageCopy Code
                                  Public NotInheritable Class CmsViperModule

The type exposes the following methods.

Public Methods

  Name Description
Public method AddAIMRelation
Adds an item to the AIM relations collection.
(Inherited from Module.)
Public method Static member AddAssetItem Overloaded.
Public method Static member AddAssetItemFromXml
Adds an Asset Item.
Public method Static member AddMultipleAssetItems
Creates multiple asset items from the urls specified within the xml data.
Public method ApplyProperties
Applies the properties from the SXML processing environment into the current module.
(Inherited from BaseModule.)
Public method BeginExecute
Override this to execute code before Execute() is fired.
Last point to add data to the Cache Signature.
(Inherited from Module.)
Public method Capture
Passes an SXML subtree to the current module.
(Inherited from BaseModule.)
Public method CheckTimeout
Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()().
(Inherited from BaseModule.)
Public method Static member ChildCount
Returns the number of direct children of the given item
Public method ClearForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method Static member ContentTypes
Gets the content types.
Public method Static member DeleteAssetFiles
Deletes the specified Asset Items and any referenced files.
Public method Dispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from BaseModule.)
Public method DoPreparse
Check whether to preparse data in the given property.
(Inherited from BaseModule.)
Public method DoRecurseTag
Determines whether to recurse on a given tag
Public method EndExecute
Override this to execute code after Execute() is fired.
(Inherited from Module.)
Public method Equals (Inherited from Object.)
Public method EvaluatePropertyExpression
Evaluates an expression in a property with Expression Syntax
(Inherited from Module.)
Public method Execute
Execute the macro. Should be overridden by inherited class.
(Inherited from Module.)
Public method ExecuteRawParameter
Executes the data of a raw parameter.
(Inherited from Module.)
Public method ExistsBuffer
Checks whether a local buffer exists.
(Inherited from BaseModule.)
Public method Find
Finds the specified child module.
(Inherited from BaseModule.)
Public method FindExtension
Finds an extension macro.
(Inherited from BaseModule.)
Public method GetAIMRelations
Gets a list of all outgoing AIM relations created by the macro.
(Inherited from BaseModule.)
Public method Static member GetAssetDerivedItem Overloaded.
Public method Static member GetAssetDerivedItems
Returns all derived images for a given asset.
Public method Static member GetAssetFolderConfigurationNode
Gets the Asset Folder configuration xml for the specified asset folder.
Public method Static member GetAssetFolderNameByRootItem
Gets the Asset Folder Name for the specified Asset Root Item.
Public method Static member GetAssetItemNumber
Returns the item number of the corresponding asset item when the specified location refers to an asset item.
Public method Static member GetAssetLocation
Gets the Asset location for the specified item.
Public method GetBuffer
Gets a local buffer.
(Inherited from BaseModule.)
Public method Static member GetChild Overloaded.
Public method Static member GetChildren
Gets the children of the specified item.
Public method GetException
Returns the text message of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetExceptionSmartsiteCode
Returns the Smartsite Error code of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetExceptionString
Returns the full information of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.)
Public method GetExceptionType
Returns the full Type name of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetForcedResult
Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
(Inherited from Module.)
Public method GetHashCode (Inherited from Object.)
Public method GetInnerException
Returns the text message of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetInnerExceptionSmartsiteCode
Returns Smartsite error code of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetInnerExceptionString
Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.)
Public method GetInnerExceptionType
Returns the full Type name of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method Static member GetIsInSubTreeWhereClause Overloaded.
Public method Static member GetItemByTitlePath Overloaded.
Public method Static member GetItemCode
Returns the item code of the item with the given number.
Public method Static member GetItemNumber Overloaded.
Public method Static member GetLevel
Returns the hierarchic depth of the given item.
Public method Static member GetLocalItemCode
Returns the publication-independant part of the item code.
Public method Static member GetNotInSubTreeWhereClause Overloaded.
Public method GetParameter
Gets the value of the given parameter/property.
(Inherited from BaseModule.)
Public method GetParameter
Gets the value of the given parameter/property.
(Inherited from BaseModule.)
Public method GetParent Overloaded.
Public method Static member GetParentItem
Returns the item number of the item's parent.
Public method Static member GetPublication Overloaded.
Public method Static member GetPublicationChannel Overloaded.
Public method GetRenderTime
Returns the render time of the macro in milliseconds.
(Inherited from Module.)
Public method Static member GetRepository Overloaded.
Public method GetResult
Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
(Inherited from BaseModule.)
Public method GetResult
Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
(Inherited from BaseModule.)
Public method Static member GetSourceLocation
Gets the Asset source location for the specified item. If not available or empty, the Asset location is returned.
Public method Static member GetSubTreeItemNumber
Gets the closest related sub tree for the given item.
Public method Static member GetSubTreesList
Gets a list of all sub trees the given item belongs to.
Public method Static member GetTranslationArg Overloaded.
Public method Static member GetTranslationArgCount
Returns the number of unnamed arguments to the translation.
Valid only within the 'replacement' field in translation items.
Public method Static member GetTranslationBase
Returns the contents of the translation the current translation overrides.
Valid only within the 'replacement' field in translation items.
Public method Static member GetTranslationCaller Overloaded.
Public method Static member GetTranslationName
Returns the name of the current translation.
Valid only within the 'replacement' field in translation items.
Public method Static member GetTranslationNumber
Returns the item number of the current translation.
Valid only within the 'replacement' field in translation items.
Public method Static member GetTranslationOutParameter
Gets the given out parameter value.
Valid only within the 'replacement' field in translation items.
Public method Static member GetTranslationScopeNew
Returns the scope of the current translation.
Valid only within the 'replacement' field in translation items.
Public method GetType (Inherited from Object.)
Public method Initialize
Called to initialize this Module
(Inherited from BaseModule.)
Public method Static member IsAssetItemReference
Determines if the specified location refers to an Asset Item.
Public method IsChildOf Overloaded.
Public method Static member IsDeleteAllowed
Determines if the specified Asset Item's AssetFolder configuration allows deletion of items.
Public method Static member IsDescendantOf
Returns true if the given item is a child of the given parent.
Public method Static member IsFolderItem
Returns true if the given item is a folder.
Public method Static member IsMemberOfAnySubTrees
Determines whether the specified item is a member of any of the given sub trees.
Public method Static member IsMemberOfSpecifiedSubTree
Determines whether the specified item is a member of the given sub tree.
Public method Static member IsTranslationPreview
Determines whether the current translation is being previewed using its own logic.
Public method ParameterExists
Checks whether the given parameter/property is set.
(Inherited from BaseModule.)
Public method PreInitialize
Called just before initialization of the module
(Inherited from Module.)
Public method ReadyExecuting
Method that is called after the module has executed.
(Inherited from Module.)
Public method Static member 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().
Public method ScopeTerminated
Executed when the module is about to get out of scope.
(Inherited from BaseModule.)
Public method SetBuffer
Sets a local buffer.
(Inherited from BaseModule.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method Static member 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.
Public method Static member SetTranslationOutParameter
Sets the given out parameter value.
Valid only within the 'replacement' field in translation items.
Public method Static member 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.
Public method Static member StartSynchronize
Starts the AssetFolder synchronization (through the configured scheduled job).
Public method TestCondition
Tests whether execution should take place based on the expression in the condition property
(Inherited from Module.)
Public method TestPropertyExpression
Tests whether an expression in a property with Expression Syntax evaluates to true.
(Inherited from Module.)
Public method ThrowCurrentException
Makes Smartsite throw the current exception.
(Inherited from BaseModule.)
Public method ThrowInnerException
Makes Smartsite throw the inner exception.
(Inherited from BaseModule.)
Public method ToString
Returns a string that represents the current macro.
(Inherited from Module.)
Public method ToString
Returns a String that represents the current Object.
(Inherited from Module.)
Public method Static member UpdateAssetItem
Updates an Asset Item.
Public method Static member ValidateFile
Validates the specified file.

Protected Methods

  Name Description
Protected method Finalize (Inherited from Object.)
Protected method IsBufferName
Determines whether the data is a buffer name.
(Inherited from Module.)
Protected method IsSingleSaveBuffername
Determines whether a single save buffername is used.
(Inherited from Module.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method SetCurrentProperty
Sets the current property.
(Inherited from BaseModule.)

Explicit Interface Implementations

  Name Description
Explicit interface implemetation Private method IModuleExec..::..Cancel (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..FinishExecute (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..Initialize (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetChildException (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetInitialized
Triggers the Initialized status in the module.
(Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetProperty (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetProperty (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..StartExecute (Inherited from BaseModule.)

See Also

Advanced