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

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 ApplyProperties
Applies the properties from the SXML processing environment into the current module.
(Inherited from BaseModule.)
Public method Static member ApplyUserPolicy
Applies the user policy.
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 Static member ChangePassword
Changes the password of the given user.
Public method CheckTimeout
Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()().
(Inherited from BaseModule.)
Public method ClearForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
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 Static member Email
Returns the email address of the user currently logged on.
Public method Static member EncryptPassword
Encodes the given password according to the membership provider configuration.
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 Static member FinishPasswordRecovery
Finish password recovery by updating the password for the given user.
Public method Static member FullName
Returns the full name of the user currently logged on.
Public method GetAIMRelations
Gets a list of all outgoing AIM relations created by the macro.
(Inherited from BaseModule.)
Public method GetBuffer
Gets a local buffer.
(Inherited from BaseModule.)
Public method Static member GetCookiePolicyGroups
Returns a datatable containing the privacy policy groups.
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 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
Gets the parent Module of this module.
(Inherited from BaseModule.)
Public method GetParent
Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off).
(Inherited from BaseModule.)
Public method GetRenderTime
Returns the render time of the macro in milliseconds.
(Inherited from Module.)
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 GetType (Inherited from Object.)
Public method Static member GetUserNameByEmail
Returns the username belonging to the user with the given email address. Returns null if there is not exactly one user with the given address.
Public method Static member HasCookiePolicy
Returns true if the visitor has accepted the privacy policy.
Public method Initialize
Called to initialize this Module
(Inherited from BaseModule.)
Public method Static member InitiatePasswordRecovery
Start the password recovery process for a given user.
Public method Static member IsAnonymous
Checks whether a user has currently logged on.
Public method IsChildOf
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.)
Public method Static member IsCookieAllowed
Checks whether a cookie can be read/write according to the visitor's cookie policy.
Public method Static member IsCookieGroupAllowed
Checks whether the given cookie group is allowed by the visitor.
Public method Static member IsMemberOfGroup
Returns true if the current user is in the given group.
Public method Static member IsUserPolicyApplied
Checks whether a user policy has been applied for the current visitor.
Public method Static member LoginName
Returns the login name of the user currently logged on.
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 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 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 UserId
Returns the user id of the user currently logged on.

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