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 methods.
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. (Inherited from Module.)Last point to add data to the Cache Signature. |
|
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. (Inherited from Module.)used to override the normal handling of the result creation. |
|
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. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
GetResult |
Returns the result of the macro. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
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. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
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 | (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.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
IModuleExec..::..Cancel | (Inherited from BaseModule.) | |
IModuleExec..::..FinishExecute | (Inherited from BaseModule.) | |
IModuleExec..::..Initialize | (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.) |
See Also
Smartsite.Runtime.Modules Namespace